%pkg.isc.rest.openAPI.model.operation

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

SQL Table Name: %pkg_isc_rest_openAPI_model.operation

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

Method Inventory

RemoveAllFromSource()
Validate()

Properties

property ActionName as %String (%JSONINCLUDE = "none");

The action name for this endpoint (if any)

Property methods: ActionNameDisplayToLogical(), ActionNameGet(), ActionNameGetStored(), ActionNameIsValid(), ActionNameLogicalToDisplay(), ActionNameLogicalToOdbc(), ActionNameNormalize(), ActionNameSet()

property Callbacks as array of %pkg.isc.rest.openAPI.model.callbackOrReference (%JSONFIELDNAME = "callbacks");

@OpenAPI: A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.

Property methods: CallbacksBuildValueArray(), CallbacksCollectionToDisplay(), CallbacksCollectionToOdbc(), CallbacksDisplayToCollection(), CallbacksGet(), CallbacksGetObject(), CallbacksGetObjectId(), CallbacksGetStored(), CallbacksGetSwizzled(), CallbacksIsValid(), CallbacksOdbcToCollection(), CallbacksSet(), CallbacksSetObject(), CallbacksSetObjectId()

property Deprecated as %pkg.isc.rest.openAPI.model.boolean (%JSONFIELDNAME = "deprecated");

@OpenAPI: Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.

Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedGetStored(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()

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

@OpenAPI: A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.

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

property ExternalDocumentation as %pkg.isc.rest.openAPI.model.externalDocumentation (%JSONFIELDNAME = "externalDocs");

@OpenAPI: Additional external documentation for this operation.

Property methods: ExternalDocumentationGet(), ExternalDocumentationGetObject(), ExternalDocumentationGetObjectId(), ExternalDocumentationGetStored(), ExternalDocumentationGetSwizzled(), ExternalDocumentationIsValid(), ExternalDocumentationNewObject(), ExternalDocumentationSet(), ExternalDocumentationSetObject(), ExternalDocumentationSetObjectId(), ExternalDocumentationUnSwizzle()

property OperationID as %String (%JSONFIELDNAME = "operationId", MAXLEN = 2000);

@OpenAPI: Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

Property methods: OperationIDDisplayToLogical(), OperationIDGet(), OperationIDGetStored(), OperationIDIsValid(), OperationIDLogicalToDisplay(), OperationIDLogicalToOdbc(), OperationIDNormalize(), OperationIDSet()

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

@OpenAPI: A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. 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 RequestBody as %pkg.isc.rest.openAPI.model.requestBodyOrReference (%JSONFIELDNAME = "requestBody");

@OpenAPI: The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.

Property methods: RequestBodyGet(), RequestBodyGetObject(), RequestBodyGetObjectId(), RequestBodyGetStored(), RequestBodyGetSwizzled(), RequestBodyIsValid(), RequestBodyNewObject(), RequestBodySet(), RequestBodySetObject(), RequestBodySetObjectId(), RequestBodyUnSwizzle()

property Responses as %pkg.isc.rest.openAPI.model.responses (%JSONFIELDNAME = "responses") [ Required ];

@OpenAPI: The list of possible responses as they are returned from executing this operation.

Property methods: ResponsesGet(), ResponsesGetObject(), ResponsesGetObjectId(), ResponsesGetStored(), ResponsesGetSwizzled(), ResponsesIsValid(), ResponsesNewObject(), ResponsesSet(), ResponsesSetObject(), ResponsesSetObjectId(), ResponsesUnSwizzle()

property Security as list of %pkg.isc.rest.openAPI.model.securityRequirement (%JSONFIELDNAME = "security");

@OpenAPI: A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

Property methods: SecurityBuildValueArray(), SecurityCollectionToDisplay(), SecurityCollectionToOdbc(), SecurityDisplayToCollection(), SecurityGet(), SecurityGetObject(), SecurityGetObjectId(), SecurityGetStored(), SecurityGetSwizzled(), SecurityIsValid(), SecurityOdbcToCollection(), SecuritySet(), SecuritySetObject(), SecuritySetObjectId()

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

@OpenAPI: An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.

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

property SourceActionInfo as %pkg.isc.rest.openAPI.actionInfo (%JSONINCLUDE = "none");

Used to track the ActionInfo used in this operation's creation

Property methods: SourceActionInfoGet(), SourceActionInfoGetStored(), SourceActionInfoGetSwizzled(), SourceActionInfoIsValid(), SourceActionInfoNewObject(), SourceActionInfoSet()

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

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: A short summary of what the operation does.

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

property Tags as list of %String (%JSONFIELDNAME = "tags", MAXLEN = 2000);

@OpenAPI: A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Property methods: TagsBuildValueArray(), TagsCollectionToDisplay(), TagsCollectionToOdbc(), TagsDisplayToCollection(), TagsDisplayToLogical(), TagsGet(), TagsGetObject(), TagsGetObjectId(), TagsGetStored(), TagsGetSwizzled(), TagsIsValid(), TagsLogicalToDisplay(), TagsLogicalToOdbc(), TagsNormalize(), TagsOdbcToCollection(), TagsSet(), TagsSetObject(), TagsSetObjectId()

Methods

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

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

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

Callbacks(n)

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

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