%pkg.isc.rest.openAPI.model.serverVariable
persistent class %pkg.isc.rest.openAPI.model.serverVariable extends %pkg.isc.rest.openAPI.model.extensibleSuper
SQL Table Name: %pkg_isc_rest_openAPI_model.serverVariable
A representation of the OpenAPI Specification Server Variable Object (see http://spec.openapis.org/oas/v3.0.3#serverVariableObject)Property Inventory
Method Inventory
Properties
property Default as %String (%JSONFIELDNAME = "default", MAXLEN = 2000) [ Required ];
@OpenAPI: The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object’s treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum’s values.
Property methods: DefaultDisplayToLogical(), DefaultGet(), DefaultGetStored(), DefaultIsValid(), DefaultLogicalToDisplay(), DefaultLogicalToOdbc(), DefaultNormalize(), DefaultSet()
property Description as %String (%JSONFIELDNAME = "description", MAXLEN = 2000);
@OpenAPI: An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Enum as list of %String (%JSONFIELDNAME = "enum", MAXLEN = 2000);
@OpenAPI: An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.
Property methods: EnumBuildValueArray(), EnumCollectionToDisplay(), EnumCollectionToOdbc(), EnumDisplayToCollection(), EnumDisplayToLogical(), EnumGet(), EnumGetObject(), EnumGetObjectId(), EnumGetStored(), EnumGetSwizzled(), EnumIsValid(), EnumLogicalToDisplay(), EnumLogicalToOdbc(), EnumNormalize(), EnumOdbcToCollection(), EnumSet(), EnumSetObject(), EnumSetObjectId()
Methods
method Validate(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI = "", debug=0) as %Boolean
Inherited description: Object-specific validation logic within a given OpenAPI Specification (use ..ValidateComponent() for full validation)
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %JSONExport()
- %JSONExportToString()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- AllowsExtendedProperties()
- Delete()
- DeleteExtent()
- GetAllFromSpec()
- GetContainingObject()
- GetDefinedType()
- GetExtendedProperty()
- GetReference()
- GetSaveableInstance()
- GetUnsaveableInstance()
- IsExtendedPropertySet()
- IsReference()
- JSONExportAdditional()
- JSONExportOverride()
- KillExtent()
- OnFail()
- RemoveExtendedProperty()
- ResolveReference()
- SetExtendedProperty()
- ValidateComponent()
- ValidateComponents()
Storage
Gray indicates storage defined by superclasses.
Storage Model: Storage (%pkg.isc.rest.openAPI.model.super)
^pkg.isc.rest.oas.model.superD(ID) |
= | %%CLASSNAME
|
Storage Model: Storage (%pkg.isc.rest.openAPI.model.extensibleSuper)
^pkg.isc.rest.oas.model.superD(ID,"%pkg.isc.rest.openAPI.model.extensibleSuper.Extras",n) |
= | Extras(n) |
Storage Model: Storage (%pkg.isc.rest.openAPI.model.serverVariable)
^pkg.isc.rest.oas.model.superD(ID,"ServerVariable") |
= | Enum
Default
Description
|