Skip to main content

%pkg.isc.rest.openAPI.model.paths

persistent class %pkg.isc.rest.openAPI.model.paths extends %pkg.isc.rest.openAPI.model.passthroughObject

SQL Table Name: %pkg_isc_rest_openAPI_model.paths

A representation of the OpenAPI Specification Paths Object (see http://spec.openapis.org/oas/v3.0.3#pathsObject) JSON Representation is the inline (not as a separate object) contents of ..Data, through use of %pkg.isc.rest.openAPI.model.passthroughObject

Property Inventory

Method Inventory

Parameters

parameter EXTENSIBLE = 1;
@Override: Per the OpenAPI Specification, this object may be extended with "x-*" properties.

Properties

property Data as array of %pkg.isc.rest.openAPI.model.pathItem;
@Special: This Object's content @OpenAPI: A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it’s up to the tooling to decide which one to use.
Property methods: Data(), DataBuildValueArray(), DataCollectionToDisplay(), DataCollectionToOdbc(), DataDisplayToCollection(), DataGet(), DataGetObject(), DataGetObjectId(), DataGetStored(), DataGetSwizzled(), DataIsValid(), DataOdbcToCollection(), DataSet(), DataSetObject(), DataSetObjectId()
property UserMethodClass as %String (%JSONINCLUDE = "none");
Used to track which (external) class is making use of this object
Property methods: UserMethodClassDisplayToLogical(), UserMethodClassGet(), UserMethodClassGetStored(), UserMethodClassIsValid(), UserMethodClassLogicalToDisplay(), UserMethodClassLogicalToOdbc(), UserMethodClassNormalize(), UserMethodClassSet()

Methods

method RemoveUnreachableOperations(permissionsRegex)
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.paths)

^pkg.isc.rest.oas.model.superD(ID,"%pkg.isc.rest.openAPI.model.paths.Data",n)
=
Data(n)

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

^pkg.isc.rest.oas.model.superD(ID,"Paths")
=
UserMethodClass
FeedbackOpens in a new tab