Skip to main content

%pkg.isc.rest.openAPI.model.components

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

SQL Table Name: %pkg_isc_rest_openAPI_model.components

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

Property Inventory

Method Inventory

Parameters

parameter KEYREGEX = ^[a-zA-Z0-9\.\-_]+$;
Acceptible key regex (see http://spec.openapis.org/oas/v3.0.3#componentsObject)

Properties

property Callbacks as array of %pkg.isc.rest.openAPI.model.callbackOrReference (%JSONFIELDNAME = "callbacks");
@OpenAPI: An object to hold reusable Callback Objects.
Property methods: CallbacksBuildValueArray(), CallbacksCollectionToDisplay(), CallbacksCollectionToOdbc(), CallbacksDisplayToCollection(), CallbacksGet(), CallbacksGetObject(), CallbacksGetObjectId(), CallbacksGetStored(), CallbacksGetSwizzled(), CallbacksIsValid(), CallbacksOdbcToCollection(), CallbacksSet(), CallbacksSetObject(), CallbacksSetObjectId()
property Examples as array of %pkg.isc.rest.openAPI.model.exampleOrReference (%JSONFIELDNAME = "examples");
@OpenAPI: An object to hold reusable Example Objects.
Property methods: ExamplesBuildValueArray(), ExamplesCollectionToDisplay(), ExamplesCollectionToOdbc(), ExamplesDisplayToCollection(), ExamplesGet(), ExamplesGetObject(), ExamplesGetObjectId(), ExamplesGetStored(), ExamplesGetSwizzled(), ExamplesIsValid(), ExamplesOdbcToCollection(), ExamplesSet(), ExamplesSetObject(), ExamplesSetObjectId()
property Headers as array of %pkg.isc.rest.openAPI.model.headerOrReference (%JSONFIELDNAME = "headers");
@OpenAPI: An object to hold reusable Header Objects.
Property methods: HeadersBuildValueArray(), HeadersCollectionToDisplay(), HeadersCollectionToOdbc(), HeadersDisplayToCollection(), HeadersGet(), HeadersGetObject(), HeadersGetObjectId(), HeadersGetStored(), HeadersGetSwizzled(), HeadersIsValid(), HeadersOdbcToCollection(), HeadersSet(), HeadersSetObject(), HeadersSetObjectId()
@OpenAPI: An object to hold reusable Link Objects.
Property methods: LinksBuildValueArray(), LinksCollectionToDisplay(), LinksCollectionToOdbc(), LinksDisplayToCollection(), LinksGet(), LinksGetObject(), LinksGetObjectId(), LinksGetStored(), LinksGetSwizzled(), LinksIsValid(), LinksOdbcToCollection(), LinksSet(), LinksSetObject(), LinksSetObjectId()
property Parameters as array of %pkg.isc.rest.openAPI.model.parameterOrReference (%JSONFIELDNAME = "parameters");
@OpenAPI: An object to hold reusable Parameter Objects.
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetStored(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property RequestBodies as array of %pkg.isc.rest.openAPI.model.requestBodyOrReference (%JSONFIELDNAME = "requestBodies");
@OpenAPI: An object to hold reusable Request Body Objects.
Property methods: RequestBodiesBuildValueArray(), RequestBodiesCollectionToDisplay(), RequestBodiesCollectionToOdbc(), RequestBodiesDisplayToCollection(), RequestBodiesGet(), RequestBodiesGetObject(), RequestBodiesGetObjectId(), RequestBodiesGetStored(), RequestBodiesGetSwizzled(), RequestBodiesIsValid(), RequestBodiesOdbcToCollection(), RequestBodiesSet(), RequestBodiesSetObject(), RequestBodiesSetObjectId()
property Responses as %pkg.isc.rest.openAPI.model.responses (%JSONFIELDNAME = "responses");
@OpenAPI: An object to hold reusable Response Objects.
Property methods: ResponsesGet(), ResponsesGetObject(), ResponsesGetObjectId(), ResponsesGetStored(), ResponsesGetSwizzled(), ResponsesIsValid(), ResponsesNewObject(), ResponsesSet(), ResponsesSetObject(), ResponsesSetObjectId(), ResponsesUnSwizzle()
property Schemas as array of %pkg.isc.rest.openAPI.model.schemaOrReference (%JSONFIELDNAME = "schemas");
@OpenAPI: An object to hold reusable Schema Objects.
Property methods: SchemasBuildValueArray(), SchemasCollectionToDisplay(), SchemasCollectionToOdbc(), SchemasDisplayToCollection(), SchemasGet(), SchemasGetObject(), SchemasGetObjectId(), SchemasGetStored(), SchemasGetSwizzled(), SchemasIsValid(), SchemasOdbcToCollection(), SchemasSet(), SchemasSetObject(), SchemasSetObjectId()
property SecuritySchemes as array of %pkg.isc.rest.openAPI.model.securitySchemeOrReference (%JSONFIELDNAME = "securitySchemes");
@OpenAPI: An object to hold reusable Security Scheme Objects.
Property methods: SecuritySchemesBuildValueArray(), SecuritySchemesCollectionToDisplay(), SecuritySchemesCollectionToOdbc(), SecuritySchemesDisplayToCollection(), SecuritySchemesGet(), SecuritySchemesGetObject(), SecuritySchemesGetObjectId(), SecuritySchemesGetStored(), SecuritySchemesGetSwizzled(), SecuritySchemesIsValid(), SecuritySchemesOdbcToCollection(), SecuritySchemesSet(), SecuritySchemesSetObject(), SecuritySchemesSetObjectId()

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

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

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

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

^pkg.isc.rest.oas.model.superD(ID,"Components")
=
Responses

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

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

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

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

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

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

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

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

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

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

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

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

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

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