Skip to main content

%pkg.isc.rest.openAPI.model.server

persistent class %pkg.isc.rest.openAPI.model.server extends %pkg.isc.rest.openAPI.model.extensibleSuper

SQL Table Name: %pkg_isc_rest_openAPI_model.server

A representation of the OpenAPI Specification Server Object (see http://spec.openapis.org/oas/v3.0.3#serverObject)

Property Inventory

Properties

property Description as %String (%JSONFIELDNAME = "description", MAXLEN = 2000);
@OpenAPI: An optional string describing the host designated by the URL. 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: A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.
Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()
property Variables as array of %pkg.isc.rest.openAPI.model.serverVariable (%JSONFIELDNAME = "variables");
@OpenAPI: A map between a variable name and its value. The value is used for substitution in the server’s URL template.
Property methods: VariablesBuildValueArray(), VariablesCollectionToDisplay(), VariablesCollectionToOdbc(), VariablesDisplayToCollection(), VariablesGet(), VariablesGetObject(), VariablesGetObjectId(), VariablesGetStored(), VariablesGetSwizzled(), VariablesIsValid(), VariablesOdbcToCollection(), VariablesSet(), VariablesSetObject(), VariablesSetObjectId()

Inherited Members

Inherited Methods

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.server)

^pkg.isc.rest.oas.model.superD(ID,"Server")
=
URL
Description

Storage Model: Storage (%pkg.isc.rest.openAPI.model.server)

^pkg.isc.rest.oas.model.superD(ID,"%pkg.isc.rest.openAPI.model.server.Variables",n)
=
Variables(n)
FeedbackOpens in a new tab