%pkg.isc.rest.openAPI.model.info
persistent class %pkg.isc.rest.openAPI.model.info extends %pkg.isc.rest.openAPI.model.extensibleSuper
SQL Table Name: %pkg_isc_rest_openAPI_model.info
A representation of the OpenAPI Specification Info Object (see http://spec.openapis.org/oas/v3.0.3#infoObject)Property Inventory
Method Inventory
Properties
property Contact as %pkg.isc.rest.openAPI.model.contact (%JSONFIELDNAME = "contact");
@OpenAPI: The contact information for the exposed API.
Property methods: ContactGet(), ContactGetObject(), ContactGetObjectId(), ContactGetStored(), ContactGetSwizzled(), ContactIsValid(), ContactNewObject(), ContactSet(), ContactSetObject(), ContactSetObjectId(), ContactUnSwizzle()
property Description as %String (%JSONFIELDNAME = "description", MAXLEN = 20000);
@OpenAPI: A short description of the API. CommonMark syntax MAY be used for rich text representation.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property License as %pkg.isc.rest.openAPI.model.license (%JSONFIELDNAME = "license");
@OpenAPI: The license information for the exposed API.
Property methods: LicenseGet(), LicenseGetObject(), LicenseGetObjectId(), LicenseGetStored(), LicenseGetSwizzled(), LicenseIsValid(), LicenseNewObject(), LicenseSet(), LicenseSetObject(), LicenseSetObjectId(), LicenseUnSwizzle()
property TermsOfService as %String (%JSONFIELDNAME = "termsOfService", MAXLEN = 2000);
@OpenAPI: A URL to the Terms of Service for the API. MUST be in the format of a URL.
Property methods: TermsOfServiceDisplayToLogical(), TermsOfServiceGet(), TermsOfServiceGetStored(), TermsOfServiceIsValid(), TermsOfServiceLogicalToDisplay(), TermsOfServiceLogicalToOdbc(), TermsOfServiceNormalize(), TermsOfServiceSet()
property Title as %String (%JSONFIELDNAME = "title", MAXLEN = 2000) [ Required ];
@OpenAPI: The title of the API.
Property methods: TitleDisplayToLogical(), TitleGet(), TitleGetStored(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()
property Version as %String (%JSONFIELDNAME = "version", MAXLEN = 2000) [ Required ];
@OpenAPI: The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
Property methods: VersionDisplayToLogical(), VersionGet(), VersionGetStored(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
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.info)
^pkg.isc.rest.oas.model.superD(ID,"Info") |
= | Title
Description
TermsOfService
Contact
License
Version
|