%pkg.isc.rest.openAPI.model.externalDocumentation
persistent class %pkg.isc.rest.openAPI.model.externalDocumentation extends %pkg.isc.rest.openAPI.model.extensibleSuper
SQL Table Name: %pkg_isc_rest_openAPI_model.externalDocumentation
A representation of the OpenAPI Specification External Documentation Object (see http://spec.openapis.org/oas/v3.0.3#externalDocumentationObject)Property Inventory
Method Inventory
Properties
property Description as %String (%JSONFIELDNAME = "description", MAXLEN = 2000);
@OpenAPI: A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property URL as %String (%JSONFIELDNAME = "url", MAXLEN = 2000) [ Required ];
@OpenAPI: The URL for the target documentation. Value MUST be in the format of a URL.
Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()
Methods
method Validate(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI = "", debug=0) as %Boolean
@Override: 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.externalDocumentation)
^pkg.isc.rest.oas.model.superD(ID,"ExternalDocumentation") |
= | Description
URL
|