%pkg.isc.rest.openAPI.model.pathItem

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

SQL Table Name: %pkg_isc_rest_openAPI_model.pathItem

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

Property Inventory

Delete
Description
EndpointType
Get
Head
IsInstance
Options
Parameters
Patch
Post
Put
Ref
Servers
SourceClasses
Summary
Trace

Properties

property Delete as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "delete");

@OpenAPI: A definition of a DELETE operation on this path.

Property methods: Delete(), DeleteGet(), DeleteGetObject(), DeleteGetObjectId(), DeleteGetStored(), DeleteGetSwizzled(), DeleteIsValid(), DeleteNewObject(), DeleteSet(), DeleteSetObject(), DeleteSetObjectId(), DeleteUnSwizzle()

property Description as %String (%JSONFIELDNAME = "description", MAXLEN = 2000);

@OpenAPI: An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()

property EndpointType as %String (%JSONINCLUDE = "none", VALUELIST = "|action|resource|other");

Used to track the endpoint "type"

Property methods: EndpointTypeDisplayToLogical(), EndpointTypeGet(), EndpointTypeGetStored(), EndpointTypeIsValid(), EndpointTypeLogicalToDisplay(), EndpointTypeLogicalToOdbc(), EndpointTypeNormalize(), EndpointTypeSet()

property Get as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "get");

@OpenAPI: A definition of a GET operation on this path.

Property methods: GetGet(), GetGetObject(), GetGetObjectId(), GetGetStored(), GetGetSwizzled(), GetIsValid(), GetNewObject(), GetSet(), GetSetObject(), GetSetObjectId(), GetUnSwizzle()

property Head as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "head");

@OpenAPI: A definition of a HEAD operation on this path.

Property methods: HeadGet(), HeadGetObject(), HeadGetObjectId(), HeadGetStored(), HeadGetSwizzled(), HeadIsValid(), HeadNewObject(), HeadSet(), HeadSetObject(), HeadSetObjectId(), HeadUnSwizzle()

property IsInstance as %Boolean (%JSONINCLUDE = "none");

Used to track whether or not this is an instance endpoint

Property methods: IsInstanceDisplayToLogical(), IsInstanceGet(), IsInstanceGetStored(), IsInstanceIsValid(), IsInstanceLogicalToDisplay(), IsInstanceNormalize(), IsInstanceSet()

property Options as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "options");

@OpenAPI: A definition of a OPTIONS operation on this path.

Property methods: OptionsGet(), OptionsGetObject(), OptionsGetObjectId(), OptionsGetStored(), OptionsGetSwizzled(), OptionsIsValid(), OptionsNewObject(), OptionsSet(), OptionsSetObject(), OptionsSetObjectId(), OptionsUnSwizzle()

property Parameters as list of %pkg.isc.rest.openAPI.model.parameterOrReference (%JSONFIELDNAME = "parameters");

@OpenAPI: A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.

Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetStored(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()

property Patch as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "patch");

@OpenAPI: A definition of a PATCH operation on this path.

Property methods: PatchGet(), PatchGetObject(), PatchGetObjectId(), PatchGetStored(), PatchGetSwizzled(), PatchIsValid(), PatchNewObject(), PatchSet(), PatchSetObject(), PatchSetObjectId(), PatchUnSwizzle()

property Post as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "post");

@OpenAPI: A definition of a POST operation on this path.

Property methods: PostGet(), PostGetObject(), PostGetObjectId(), PostGetStored(), PostGetSwizzled(), PostIsValid(), PostNewObject(), PostSet(), PostSetObject(), PostSetObjectId(), PostUnSwizzle()

property Put as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "put");

@OpenAPI: A definition of a PUT operation on this path.

Property methods: PutGet(), PutGetObject(), PutGetObjectId(), PutGetStored(), PutGetSwizzled(), PutIsValid(), PutNewObject(), PutSet(), PutSetObject(), PutSetObjectId(), PutUnSwizzle()

property Ref as %String (%JSONFIELDNAME = "$ref", MAXLEN = 2000);

@OpenAPI: Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined.

Property methods: RefDisplayToLogical(), RefGet(), RefGetStored(), RefIsValid(), RefLogicalToDisplay(), RefLogicalToOdbc(), RefNormalize(), RefSet()

property Servers as list of %pkg.isc.rest.openAPI.model.server (%JSONFIELDNAME = "servers");

@OpenAPI: An alternative server array to service all operations in this path.

Property methods: ServersBuildValueArray(), ServersCollectionToDisplay(), ServersCollectionToOdbc(), ServersDisplayToCollection(), ServersGet(), ServersGetObject(), ServersGetObjectId(), ServersGetStored(), ServersGetSwizzled(), ServersIsValid(), ServersOdbcToCollection(), ServersSet(), ServersSetObject(), ServersSetObjectId()

property SourceClasses as list of %String (%JSONINCLUDE = "none", MAXLEN = 220);

Used to track the class(es) that caused this object to be generated. MAXLEN to match %Dictionary.Classname. MUST use %String or else cannot save due to lack of Normalize() method in %Dictionary.Classname.

Property methods: SourceClassesBuildValueArray(), SourceClassesCollectionToDisplay(), SourceClassesCollectionToOdbc(), SourceClassesDisplayToCollection(), SourceClassesDisplayToLogical(), SourceClassesGet(), SourceClassesGetObject(), SourceClassesGetObjectId(), SourceClassesGetStored(), SourceClassesGetSwizzled(), SourceClassesIsValid(), SourceClassesLogicalToDisplay(), SourceClassesLogicalToOdbc(), SourceClassesNormalize(), SourceClassesOdbcToCollection(), SourceClassesSet(), SourceClassesSetObject(), SourceClassesSetObjectId()

property Summary as %String (%JSONFIELDNAME = "summary", MAXLEN = 2000);

@OpenAPI: An optional, string summary, intended to apply to all operations in this path.

Property methods: SummaryDisplayToLogical(), SummaryGet(), SummaryGetStored(), SummaryIsValid(), SummaryLogicalToDisplay(), SummaryLogicalToOdbc(), SummaryNormalize(), SummarySet()

property Trace as %pkg.isc.rest.openAPI.model.operation (%JSONFIELDNAME = "trace");

@OpenAPI: A definition of a TRACE operation on this path.

Property methods: TraceGet(), TraceGetObject(), TraceGetObjectId(), TraceGetStored(), TraceGetSwizzled(), TraceIsValid(), TraceNewObject(), TraceSet(), TraceSetObject(), TraceSetObjectId(), TraceUnSwizzle()

Methods

method RemoveAllFromSource(className As %String, Output keepSelf As %Boolean)

method RemoveUnreachableOperations(permissionsRegex, sourceClass)

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

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

^pkg.isc.rest.oas.model.superD(ID,"PathItem")

Ref

Summary

Description

Get

Put

Post

Delete

Options

Head

Patch

Trace

Servers

Parameters

EndpointType

IsInstance

SourceClasses