From f04a6de0f8367b055fda81f9a7fb615767f26e41 Mon Sep 17 00:00:00 2001 From: piscione Date: Fri, 19 Nov 2021 12:29:47 +0100 Subject: [PATCH 1/4] First draft of OAS3.1.0 specification added. --- .../MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml | 657 ++++++ .../MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml | 1832 +++++++++++++++ ...EC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml | 2046 +++++++++++++++++ 3 files changed, 4535 insertions(+) create mode 100644 OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml create mode 100644 OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml create mode 100644 OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml diff --git a/OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml new file mode 100644 index 0000000..3e2a75f --- /dev/null +++ b/OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml @@ -0,0 +1,657 @@ +openapi: 3.1.0 +info: + title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' + contact: + name: ETSI Forge + url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api + email: cti_support@etsi.org + version: '2.1.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema +servers: +- url: https://localhost/granting/v1 + variables: {} +paths: + /grants: + post: + tags: + - granting + summary: grantPOST + description: requests a grant for a particular application lifecycle operation + operationId: grantPOST + parameters: [] + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/GrantRequest' + required: true + responses: + '201': + description: grant was created successfully (synchronous mode) + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + '202': + description: the request was accepted for processing + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /grants/{grantId}: + get: + tags: + - granting + summary: GrantGET + description: read the grant + operationId: GrantGET + parameters: + - name: grantId + in: path + description: Identifier of the individual grant. + required: true + style: simple + schema: + type: string + responses: + '200': + description: IA representation of the "individual grant" resource + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + '202': + description: returned when the process of creating the grant is ongoing, no grant is available yet + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] +components: + schemas: + AppExtCpConfig: + title: AppExtCpConfig + type: object + properties: + cpInstanceId: + type: string + description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created." + cpProtocolData: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/CpProtocolData' + description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. + linkPortId: + type: string + description: Identifier of a pre-configured link port to which the external CP will be associated. See note. + AppExtCpData: + title: AppExtCpData + required: + - cpConfig + - cpdId + type: object + properties: + cpConfig: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/AppExtCpConfig' + description: List of instance data that need to be configured on the CP instances created from the respective CPD. + cpdId: + type: string + description: The identifier of the CPD in the AppD. + ResourceDefinition.Type: + title: ResourceDefinition.Type + enum: + - COMPUTE + - VL + - STORAGE + - LINKPORT + type: string + description: Type of the resource definition referenced. + examples: + - COMPUTE + CpProtocolData: + title: CpProtocolData + required: + - layerProtocol + type: object + properties: + ipOverEthernet: + $ref: '#/components/schemas/IpOverEthernetAddressData' + layerProtocol: + $ref: '#/components/schemas/IpOverEthernetAddressData' + ExtLinkPortData: + title: ExtLinkPortData + required: + - id + - resourceHandle + type: object + properties: + id: + type: string + description: Identifier of this link port as provided by the entity that has created the link port. + resourceHandle: + $ref: '#/components/schemas/ResourceHandle' + ExtVirtualLinkData: + title: ExtVirtualLinkData + required: + - extCps + - id + - resourceId + type: object + properties: + extCps: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/AppExtCpData' + description: External CPs of the application instance to be connected to this external VL. + extLinkPorts: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ExtLinkPortData' + description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL. + id: + type: string + description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance. + resourceId: + type: string + description: The identifier of the resource in the scope of the VIM. + vimConnectionId: + type: string + description: Identifier of the VIM connection to manage this resource. + Grant: + title: Grant + required: + - id + - appInstanceId + - appLcmOpOccId + - _links + type: object + properties: + id: + type: string + appInstanceId: + type: string + description: Identifier of application instance. + appLcmOpOccId: + type: string + description: Identifier of application lifecycle management operation occurrence. + vimConnections: + type: array + items: + $ref: '#/components/schemas/VimConnectionInfo' + description: '' + zones: + type: array + items: + $ref: '#/components/schemas/ZoneInfo' + description: '' + zoneGroups: + type: array + items: + $ref: '#/components/schemas/ZoneGroupInfo' + description: '' + addResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + description: '' + tempResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + description: '' + removeResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + description: '' + updateResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + description: '' + vimAssets: + $ref: '#/components/schemas/VimAssets' + extVirtualLinks: + type: array + items: + $ref: '#/components/schemas/ExtVirtualLinkData' + description: '' + additionalParams: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + _links: + $ref: '#/components/schemas/Grant.links' + description: "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '" + VimAssets: + title: VimAssets + type: object + properties: + softwareImages: + type: array + items: + $ref: '#/components/schemas/SoftwareImages' + description: '' + description: Information about assets for the application that are managed by the MEO in the VIM, such as software images. + SoftwareImages: + title: SoftwareImages + required: + - appDSoftwareImageId + - vimSoftwareImageId + type: object + properties: + appDSoftwareImageId: + type: string + description: Identifier which references the software image descriptor in the AppD. + vimConnectionId: + type: string + description: Identifier of the VIM connection to access the software image referenced in this structure. + vimSoftwareImageId: + type: string + description: Identifier of the software image in the resource management layer (i.e. VIM). + Grant.links: + title: Grant.links + required: + - appLcmOpOcc + - appInstance + type: object + properties: + appLcmOpOcc: + $ref: '#/components/schemas/LinkType' + appInstance: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + GrantInfo: + title: GrantInfo + required: + - resourceDefinitionId + type: object + properties: + resourceDefinitionId: + type: string + description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure. + resourceGroupId: + type: string + description: Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated. + vimConnectionId: + type: string + description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. + zoneId: + type: string + description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated. + GrantRequest: + title: GrantRequest + required: + - appInstanceId + - appLcmOpOccId + - appDId + - operation + - _links + type: object + properties: + appInstanceId: + type: string + description: Identifier of application instance. + appLcmOpOccId: + type: string + description: Identifier of application lifecycle management operation occurrence. + appDId: + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. + operation: + $ref: '#/components/schemas/GrantRequest.Operation' + addResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' + tempResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' + removeResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' + updateResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' + additionalParams: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + _links: + $ref: '#/components/schemas/GrantRequest.links' + description: "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'" + GrantRequest.Operation: + title: GrantRequest.Operation + enum: + - INSTANTIATE + - OPERATE + - TERMINATE + type: string + description: "'The lifecycle management operation for which granting is requested'" + examples: + - INSTANTIATE + GrantRequest.links: + title: GrantRequest.links + required: + - appLcmOpOcc + - appInstance + type: object + properties: + appLcmOpOcc: + $ref: '#/components/schemas/LinkType' + appInstance: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + IpOverEthernetAddressData: + title: IpOverEthernetAddressData + type: object + properties: + macAddress: + type: string + description: "'MAC address. If this attribute is not present, it shall be chosen by the VIM'" + ipAddresses: + type: array + items: + $ref: '#/components/schemas/IpAddress' + description: List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. + description: "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'" + IpAddress: + title: IpAddress + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/IpAddress.Type' + fixedAddresses: + type: array + items: + type: string + description: Fixed addresses to assign (from the subnet defined by subnetId if provided). + numDynamicAddresses: + type: integer + description: Number of dynamic addresses to assign (from the subnet defined by subnetId if provided) + contentEncoding: int32 + addressRange: + $ref: '#/components/schemas/AddressRange' + subnetId: + type: string + description: Subnet defined by the identifier of the subnet resource in the VIM. + description: "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'" + IpAddress.Type: + title: IpAddress.Type + enum: + - IPV4 + - IPV6 + type: string + description: The type of the IP addresses. + examples: + - IPV4 + AddressRange: + title: AddressRange + required: + - minAddress + - maxAddress + type: object + properties: + minAddress: + type: string + description: Lowest IP address belonging to the range. + maxAddress: + type: string + description: Highest IP address belonging to the range. + description: An IP address range to be used, e.g. in case of egress connections. + LinkType: + title: LinkType + required: + - href + type: object + properties: + href: + type: string + description: URI referring to a resource + ProblemDetails: + title: ProblemDetails + type: object + properties: + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + instance: + type: string + description: A URI reference that identifies the specific occurrence of the problem + status: + type: integer + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 + title: + type: string + description: A short, human-readable summary of the problem type + type: + type: string + description: A URI reference according to IETF RFC 3986 that identifies the problem type + ResourceDefinition: + title: ResourceDefinition + required: + - id + - type + - resourceTemplateId + - resource + type: object + properties: + id: + type: string + description: Identifier of the related ResourceDefinition structure from the related GrantRequest structure. + type: + $ref: '#/components/schemas/ResourceDefinition.Type' + vduId: + type: string + description: Reference to the related VDU in the AppD applicable to this resource. + resourceTemplateId: + type: string + description: Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD. + resource: + $ref: '#/components/schemas/Resource' + description: "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '" + Resource: + title: Resource + required: + - vimConnectionInfo + - resourceId + type: object + properties: + vimConnectionInfo: + $ref: '#/components/schemas/VimConnectionInfo' + resourceId: + type: string + description: Identifier of the resource in the scope of the VIM. + description: Resource information for an existing resource + ResourceHandle: + title: ResourceHandle + required: + - resourceId + type: object + properties: + resourceId: + type: string + description: Identifier of the resource in the scope of the VIM. + vimConnectionId: + type: string + description: Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure. + vimLevelResourceType: + type: string + description: Type of the resource in the scope of the VIM. See note. + VimConnectionInfo: + title: VimConnectionInfo + required: + - id + - vimType + type: object + properties: + accessInfo: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + extra: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + id: + type: string + description: The identifier of the VIM Connection. This identifier is managed by the MEO. + interfaceInfo: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + vimId: + type: string + description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise. + vimType: + type: string + description: Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. + VimSoftwareImage: + title: VimSoftwareImage + required: + - appDSoftwareImageId + - vimSoftwareImageId + type: object + properties: + appDSoftwareImageId: + type: string + description: Identifier which references the software image descriptor in the AppD. + vimConnectionId: + type: string + description: Identifier of the VIM connection to access the software image referenced in this structure. + vimSoftwareImageId: + type: string + description: Identifier of the software image in the resource management layer (i.e. VIM). + ZoneGroupInfo: + title: ZoneGroupInfo + required: + - zoneId + type: object + properties: + zoneId: + minItems: 1 + type: array + items: + type: string + description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group. + ZoneInfo: + title: ZoneInfo + required: + - id + - zoneId + type: object + properties: + id: + type: string + description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure. + vimConnectionId: + type: string + zoneId: + type: string + description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM). +security: +- {} +tags: +- name: granting + description: Grant operations +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml new file mode 100644 index 0000000..a792a8d --- /dev/null +++ b/OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml @@ -0,0 +1,1832 @@ +openapi: 3.1.0 +info: + title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' + contact: + name: ETSI Forge + url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api + email: cti_support@etsi.org + version: '2.1.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema +servers: +- url: https://localhost/app_lcm/v1 + variables: {} +paths: + /app_instances: + post: + tags: + - '' + summary: appInstancePOST + description: Create an application instance resource + operationId: appInstancePOST + parameters: [] + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAppInstanceRequest' + required: true + responses: + '201': + description: An application instance identifier and the related resource has been created successfully. + headers: {} + content: + application/zip: + schema: + type: object + description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" + contentMediaType: application/zip + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + get: + tags: + - '' + summary: appInstanceGET + description: queries information relating to on-boarded application packages in the MEO + operationId: appInstanceGET + parameters: + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string + responses: + '200': + description: Array the representations of zero or more application instances + headers: {} + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AppInstanceInfo' + description: '' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_instances/{appInstanceId}: + get: + tags: + - '' + summary: appInstanceIdGET + description: Retrieves the information of an individual application instance via reading an individual application instance. + operationId: appInstanceIdGET + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string + responses: + '200': + description: Contains a representation of the read resource. + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppInstanceInfo' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + delete: + tags: + - '' + summary: appInstanceIdDELETE + description: Deletes an individual application instance resource. + operationId: appInstanceIdDELETE + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string + responses: + '204': + description: No Content + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions: + post: + tags: + - '' + summary: appLcmSubscriptionsPOST + description: subscribe to the notification of application instance operational state change + operationId: appLcmSubscriptionsPOST + parameters: + - name: subscriptionType + in: query + description: >- + "Query parameter to filter on a specific subscription type. Permitted values: + • "AppInstanceStateChange" + • "AppLcmOpOccStateChange" + " + required: true + style: form + explode: true + schema: + oneOf: + - $ref: '#/components/schemas/AppInst.SubscriptionType' + - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' + requestBody: + description: '' + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionRequest' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest' + contentMediaType: application/json + required: true + responses: + '201': + description: a representation of the created SubscriptionInfo. + headers: {} + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionInfo' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + get: + tags: + - '' + summary: appLcmSubscriptionsGET + description: Retrieves the information of multiple subscriptions to notifications related to an application instance. + operationId: appLcmSubscriptionsGET + parameters: + - name: subscriptionType + in: query + description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' + style: form + explode: true + schema: + type: string + responses: + '200': + description: List of all subscriptions is returned. + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionLinkList' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions/{subscriptionId}: + get: + tags: + - '' + summary: individualSubscriptionGET + description: Used to represent an individual subscription to notifications about application package changes. + operationId: individualSubscriptionGET + parameters: + - name: subscriptionId + in: path + description: Represents an individual subscription to notification related to an application instance + required: true + style: simple + schema: + type: string + - name: subscriptionType + in: query + description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' + required: true + style: form + explode: true + schema: + type: string + responses: + '200': + description: Representation of the resource. + headers: {} + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionInfo' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + delete: + tags: + - '' + summary: individualSubscriptionDELETE + description: Deletes the individual subscription to notifications about application package changes in MEO. + operationId: individualSubscriptionDELETE + parameters: + - name: subscriptionId + in: path + description: Represents an individual subscription to notification related to an application instance + required: true + style: simple + schema: + type: string + responses: + '204': + description: No Content + headers: {} + content: {} + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /user_defined_notification: + post: + tags: + - '' + summary: appInstNotificationPOST + description: Delivers a notification from the application lifecycle management resource to the subscriber. + operationId: appInstNotificationPOST + parameters: [] + requestBody: + description: '' + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstNotification' + - $ref: '#/components/schemas/AppLcmOpOccNotification' + contentMediaType: application/json + required: true + responses: + '204': + description: No Content + headers: {} + content: {} + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_instances/{appInstanceId}/instantiate: + post: + tags: + - '' + summary: appLcmInstanciatePOST + description: task of instantiating an application instance. + operationId: appLcmInstanciatePOST + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/InstantiateAppRequest' + required: true + responses: + '202': + description: accepted for processing, but the processing has not yet been completed. + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_instances/{appInstanceId}/terminate: + post: + tags: + - '' + summary: appLcmTerminatePOST + description: terminate an application instance. + operationId: appLcmTerminatePOST + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/TerminateAppRequest' + required: true + responses: + '202': + description: accepted for processing, but the processing has not yet been completed. + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_instances/{appInstanceId}/operate: + post: + tags: + - '' + summary: appLcmOperatePOST + description: change the operational state, i.e. start or stop, of the application instance + operationId: appLcmOperatePOST + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OperateAppRequest' + required: true + responses: + '202': + description: accepted for processing, but the processing has not yet been completed. + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_lcm_op_occs: + get: + tags: + - '' + summary: appLcmOpOccsGET + description: retrieves information of operation status about multiple application instance lifecycle management operation occurrences + operationId: appLcmOpOccsGET + parameters: + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string + responses: + '200': + description: Status information for zero or more application instance lifecycle management operation occurrences was queried successfully + headers: {} + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AppInstanceLcmOpOcc' + description: '' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_lcm_op_occs/{appLcmOpOccId}: + get: + tags: + - '' + summary: appLcmOpOccsbyIdGET + description: reads the status information of an individual application LCM operation occurrence + operationId: appLcmOpOccsbyIdGET + parameters: + - name: appLcmOpOccId + in: path + description: Identifies an individual application LCM operation occurrence + required: true + style: simple + schema: + type: string + responses: + '200': + description: Information about an application LCM operation occurrence was read successfully + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppInstanceLcmOpOcc' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] +components: + schemas: + AppInstanceLcmOpOcc: + title: AppInstanceLcmOpOcc + required: + - id + - operationState + - stateEnteredTime + - startTime + - lcmOperation + - _links + type: object + properties: + id: + type: string + description: "'Identifier of the subscription to application LCM operation occurrence notification'" + operationState: + $ref: '#/components/schemas/OperationState' + stateEnteredTime: + $ref: '#/components/schemas/TimeStamp' + startTime: + $ref: '#/components/schemas/TimeStamp' + lcmOperation: + $ref: '#/components/schemas/LcmOperation' + operationParams: + $ref: '#/components/schemas/OperationParams' + _links: + $ref: '#/components/schemas/AppInstanceLcmOpOcc.links' + description: "'This data type represents an application lifecycle management operation occurrence'" + OperationParams: + title: OperationParams + enum: + - INSTANTIATE + - OPERATE + - TERMINATE + type: string + description: "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'" + examples: + - INSTANTIATE + AppInstanceLcmOpOcc.links: + title: AppInstanceLcmOpOcc.links + required: + - self + - appInstance + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + appInstance: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + SubscriptionLinkList: + title: SubscriptionLinkList + required: + - _links + type: object + properties: + _links: + $ref: '#/components/schemas/SubscriptionLinkList.links' + description: "'The data type represents a subscription link list of notification on application lifecycle management. '" + SubscriptionLinkList.links: + title: SubscriptionLinkList.links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + subscriptions: + type: array + items: + $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' + description: '' + description: Links to resources related to this resource. + SubscriptionLinkList.links.subscriptions: + title: SubscriptionLinkList.links.subscriptions + required: + - href + - subscriptionType + type: object + properties: + href: + type: string + subscriptionType: + $ref: '#/components/schemas/SubscriptionType' + description: A link list to the subscriptions + AppLcmOpOccSubscriptionInfo: + title: AppLcmOpOccSubscriptionInfo + required: + - id + - subscriptionType + - callbackUri + - _links + type: object + properties: + id: + type: string + description: "''" + subscriptionType: + const: AppLcmOpOccStateChange + type: string + description: Shall be set to AppLcmOpOccStateChange. + examples: + - AppLcmOpOccStateChange + callbackUri: + type: string + description: The URI of the endpoint for the notification to be sent to. + _links: + $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links' + description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'" + AppLcmOpOcc.SubscriptionType: + title: AppLcmOpOcc.SubscriptionType + const: AppLcmOpOccStateChange + type: string + description: Shall be set to AppLcmOpOccStateChange. + examples: + - AppLcmOpOccStateChange + AppLcmOpOccSubscriptionInfo.links: + title: AppLcmOpOccSubscriptionInfo.links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + AppInstSubscriptionInfo: + title: AppInstSubscriptionInfo + required: + - id + - subscriptionType + - notificationType + - callbackUri + - _links + type: object + properties: + id: + type: string + description: "'Identifier of the subscription to application instance operational state change notification.'" + subscriptionType: + const: AppInstanceStateChange + type: string + description: Shall be set to AppInstanceStateChange. + examples: + - AppInstanceStateChange + notificationType: + $ref: '#/components/schemas/AppInst.NotificationType' + callbackUri: + type: string + description: The URI of the endpoint for the notification to be sent to. + _links: + $ref: '#/components/schemas/AppInstSubscriptionInfo.links' + description: "'The data type represents a subscription to notification of application instance operational state change.'" + AppInst.SubscriptionType: + title: AppInst.SubscriptionType + const: AppInstanceStateChange + type: string + description: Shall be set to AppInstanceStateChange. + examples: + - AppInstanceStateChange + AppInst.NotificationType: + title: AppInst.NotificationType + enum: + - NOT_INSTANTIATED + - STARTED + - STOPPED + type: string + description: Subscribed notification + examples: + - NOT_INSTANTIATED + AppInstSubscriptionInfo.links: + title: AppInstSubscriptionInfo.links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + AppLcmOpOccSubscriptionRequest: + title: AppLcmOpOccSubscriptionRequest + required: + - callbackUri + - subscriptionType + type: object + properties: + appLcmOpOccSubscriptionFilter: + $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter' + callbackUri: + type: string + subscriptionType: + type: string + description: Shall be set to "AppLcmOpOccStateChange". + AppLcmOpOccSubscriptionFilter: + title: AppLcmOpOccSubscriptionFilter + type: object + properties: + appInstanceSubscriptionFilter: + $ref: '#/components/schemas/AppInstanceSubscriptionFilter' + notificationTypes: + $ref: '#/components/schemas/NotificationTypes' + operationStates: + $ref: '#/components/schemas/OperationStates' + operationTypes: + $ref: '#/components/schemas/OperationTypes' + NotificationTypes: + title: NotificationTypes + const: AppLcmOperationOccurrenceNotification + type: string + description: Match particular notification types. + examples: + - AppLcmOperationOccurrenceNotification + OperationStates: + title: OperationStates + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED + type: string + description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'" + examples: + - STARTING + OperationTypes: + title: OperationTypes + enum: + - INSTANTIATE + - OPERATE + - TERMINATE + type: string + description: "'Type of the LCM operation represented by this application instance LCM operation occurrence.'" + examples: + - INSTANTIATE + CreateAppInstanceRequest: + title: CreateAppInstanceRequest + required: + - appDId + type: object + properties: + appDId: + type: string + description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. + appInstanceDescription: + type: string + description: Human-readable description of the application instance to be created. + appInstanceName: + type: string + description: Human-readable name of the application instance to be created. + AppInstSubscriptionRequest: + title: AppInstSubscriptionRequest + required: + - subscriptionType + - callbackUri + type: object + properties: + subscriptionType: + const: AppInstanceStateChange + type: string + description: Shall be set to AppInstanceStateChange. + examples: + - AppInstanceStateChange + callbackUri: + type: string + description: The URI of the endpoint for the notification to be sent to. + appInstanceState: + $ref: '#/components/schemas/AppInstanceState' + appInstanceSubscriptionFilter: + $ref: '#/components/schemas/AppInstanceSubscriptionFilter' + AppInstanceSubscriptionFilter: + title: AppInstanceSubscriptionFilter + required: + - appInstSelectorType + type: object + properties: + appInstSelectorType: + $ref: '#/components/schemas/AppInstSelectorType' + appInstances: + type: array + items: + type: string + description: '' + appsFromProviders: + type: array + items: + $ref: '#/components/schemas/AppsFromProviders' + description: '' + description: "'This data type represents subscription filter criteria to match application instances. '" + AppsFromProviders: + title: AppsFromProviders + required: + - appProvider + type: object + properties: + appProvider: + type: string + description: Provider of the application and of the AppD. + appProducts: + $ref: '#/components/schemas/AppProducts' + description: "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'" + AppProducts: + title: AppProducts + required: + - appName + type: object + properties: + appName: + type: string + description: Name to identify the MEC application. + versions: + $ref: '#/components/schemas/AppProducts.Versions' + description: "'If present, match application instances that belong to application products with certain product names, from one particular provider.'" + AppProducts.Versions: + title: AppProducts.Versions + required: + - appSoftVersion + type: object + properties: + appSoftVersion: + type: string + description: Identifies the version of software of the MEC application. + appDVersion: + type: array + items: + type: string + description: '' + description: "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'" + AppInstSelectorType: + title: AppInstSelectorType + enum: + - VOID + - APP_IDENTITY + - APP_NAME + - APP_D_ID + - APP_FROM_PROVIDER + type: string + description: 0 = void + examples: + - VOID + AppInstanceState: + title: AppInstanceState + enum: + - NOT_INSTANTIATED + - STARTED + - STOPPED + type: string + description: Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states. + examples: + - NOT_INSTANTIATED + AppInstNotification: + title: AppInstNotification + required: + - _links + - appDId + - appInstanceId + - appPkgId + - id + - notificationType + - subscriptionId + - timeStamp + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + appDId: + type: string + description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way. + appInstanceId: + type: string + description: Identifier of application instance. + appPkgId: + type: string + description: Identifier of the onboarded application package. + id: + type: string + description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all these notifications shall have the same value. + notificationType: + $ref: '#/components/schemas/AppInst.NotificationType' + subscriptionId: + type: string + description: Identifier of the subscription related to this notification. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + AppInstanceInfo: + title: AppInstanceInfo + required: + - id + - appDId + - appProvider + - appName + - appSoftVersion + - appDVersion + - appPkgId + - instantiationState + - _links + type: object + properties: + id: + type: string + description: Identifier of application instance. + appInstanceName: + type: string + description: Name of the application instance. + appInstanceDescription: + type: string + description: Human-readable description of the application instance to be created. + appDId: + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. + appProvider: + type: string + description: Provider of the application and of the AppD. + appName: + type: string + description: Name to identify the MEC application. + appSoftVersion: + type: string + description: Identifies the version of software of the MEC application. + appDVersion: + type: string + description: Identifies the version of the application descriptor. + appPkgId: + type: string + description: Identifier of the onboarded application package. + vimConnectionInfo: + type: array + items: + $ref: '#/components/schemas/VimConnectionInfo' + description: '' + instantiationState: + $ref: '#/components/schemas/InstantiationState' + instantiatedAppState: + $ref: '#/components/schemas/InstantiatedAppState' + _links: + $ref: '#/components/schemas/AppInstanceInfo.links' + description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" + OperationState: + title: OperationState + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED + type: string + description: Operation state + examples: + - STARTING + InstantiationState: + title: InstantiationState + enum: + - NOT_INSTANTIATED + - INSTANTIATED + type: string + description: Instantiation state of the application instance + examples: + - NOT_INSTANTIATED + InstantiatedAppState: + title: InstantiatedAppState + required: + - operationalState + type: object + properties: + operationalState: + $ref: '#/components/schemas/OperationalState' + description: "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'" + OperationalState: + title: OperationalState + enum: + - STARTED + - STOPPED + type: string + description: Operational state is applicable in the instantiation state INSTANTIATED + examples: + - STARTED + AppInstanceInfo.links: + title: AppInstanceInfo.links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + instantiate: + $ref: '#/components/schemas/LinkType' + terminate: + $ref: '#/components/schemas/LinkType' + operate: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + LcmOperation: + title: LcmOperation + enum: + - INSTATIATE + - OPERATE + - TERMINATE + type: string + description: Type of the actual LCM operation represented by this application instance LCM operation occurrence + examples: + - INSTATIATE + AppLcmOpOccNotification: + title: AppLcmOpOccNotification + required: + - id + - notificationType + - subscriptionId + - timeStamp + - appLcmOpOccId + - appInstanceId + - _links + type: object + properties: + id: + type: string + description: "''" + notificationType: + $ref: '#/components/schemas/AppLcmOpOcc.NotificationType' + subscriptionId: + type: string + description: Identifier of the subscription related to this notification. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + appLcmOpOccId: + type: string + description: Identifier of application lifecycle management operation occurrence. + appInstanceId: + type: string + description: Identifier of application instance. + _links: + $ref: '#/components/schemas/AppLcmOpOccNotification.links' + description: "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'" + AppLcmOpOcc.NotificationType: + title: AppLcmOpOcc.NotificationType + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED + type: string + description: Discriminator for the different notification types + examples: + - STARTING + AppLcmOpOccNotification.links: + title: AppLcmOpOccNotification.links + required: + - appInstance + - subscription + - appLcmOpOcc + type: object + properties: + appInstance: + $ref: '#/components/schemas/LinkType' + subscription: + $ref: '#/components/schemas/LinkType' + appLcmOpOcc: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + InstantiateAppRequest: + title: InstantiateAppRequest + required: + - selectedMECHostInfo + type: object + properties: + locationConstraints: + $ref: '#/components/schemas/LocationConstraints' + selectedMECHostInfo: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/MECHostInformation' + description: Describes the information of selected host for the application instance. See note 2. + vimConnectionInfo: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/VimConnectionInfo' + description: >- + Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links. + + This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2. + virtualComputeDescriptor: + type: string + description: Ref NFV + virtualStorageDescriptor: + minItems: 0 + type: array + items: + type: string + description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1. + LinkType: + title: LinkType + required: + - href + type: object + properties: + href: + type: string + description: URI referring to a resource + LocationConstraints: + title: LocationConstraints + required: + - countryCode + type: object + properties: + countryCode: + type: string + description: The two-letter ISO 3166 country code in capital letters. + civicAddressElement: + type: array + items: + $ref: '#/components/schemas/CivicAddressElement' + description: '' + description: "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'" + CivicAddressElement: + title: CivicAddressElement + required: + - caType + - caValue + type: object + properties: + caType: + type: integer + description: "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'" + contentEncoding: int32 + caValue: + type: string + description: "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'" + description: "'The civic address.'" + MECHostInformation: + title: MECHostInformation + required: + - hostId + type: object + properties: + hostId: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + hostName: + type: string + description: Human-readable name of MEC host. + OperateAppRequest: + title: OperateAppRequest + required: + - changeStateTo + type: object + properties: + changeStateTo: + $ref: '#/components/schemas/ChangeStateTo' + gracefulStopTimeout: + type: integer + description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2. + contentEncoding: int32 + stopType: + $ref: '#/components/schemas/StopType' + StopType: + title: StopType + enum: + - FORCEFUL + - GRACEFUL + type: string + description: Signals forceful or graceful stop + examples: + - FORCEFUL + ChangeStateTo: + title: ChangeStateTo + enum: + - STARTED + - STOPPED + type: string + description: The desired operational state + examples: + - STARTED + ProblemDetails: + title: ProblemDetails + type: object + properties: + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + instance: + type: string + description: A URI reference that identifies the specific occurrence of the problem + status: + type: integer + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 + title: + type: string + description: A short, human-readable summary of the problem type + type: + type: string + description: A URI reference according to IETF RFC 3986 that identifies the problem type + TerminateAppRequest: + title: TerminateAppRequest + required: + - terminationType + type: object + properties: + gracefulTerminationTimeout: + type: integer + description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources." + contentEncoding: int32 + terminationType: + $ref: '#/components/schemas/TerminationType' + TimeStamp: + title: TimeStamp + required: + - nanoSeconds + - seconds + type: object + properties: + nanoSeconds: + type: integer + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + seconds: + type: integer + description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + TerminationType: + title: TerminationType + enum: + - FORCEFUL + - GRACEFUL + type: string + description: "'Indicates whether forceful or graceful termination is requested.'" + examples: + - FORCEFUL + VimConnectionInfo: + title: VimConnectionInfo + required: + - id + - vimType + type: object + properties: + accessInfo: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + extra: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + id: + type: string + description: The identifier of the VIM Connection. This identifier is managed by the MEO. + interfaceInfo: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + vimId: + type: string + description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise. + vimType: + type: string + description: Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. + Links: + title: Links + required: + - subscription + type: object + properties: + subscription: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this notification. + SubscriptionType: + title: SubscriptionType + enum: + - AppInstanceStateChange + - AppLcmOpOccStateChange + type: string + examples: + - AppInstanceStateChange +security: +- {} +tags: +- name: app-lcm + description: App lifecycle management +- name: app-lcm-notifications + description: App lifecycle management notifications +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml new file mode 100644 index 0000000..b5a46fc --- /dev/null +++ b/OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml @@ -0,0 +1,2046 @@ +openapi: 3.1.0 +info: + title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' + contact: + name: ETSI Forge + url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api + email: cti_support@etsi.org + version: '2.1.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema +servers: +- url: https://localhost/app_pkgm/v1 + variables: {} +paths: + /app_packages: + post: + tags: + - app-pkgm + summary: app_packagesPOST + description: Create a resource for on-boarding an application package to a MEO + operationId: app_packagesPOST + parameters: [] + requestBody: + description: Resource to be created + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAppPkg' + required: true + responses: + '201': + description: Successful response for resource creation + headers: {} + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AppPkgInfo' + description: '' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + get: + tags: + - app-pkgm + summary: app_packagesGET + description: queries information relating to on-boarded application packages in the MEO + operationId: app_packagesGET + parameters: + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string + responses: + '200': + description: Contains a representation of the application package resource + headers: {} + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AppPkgInfo' + description: '' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_packages/{appPkgId}: + get: + tags: + - app-pkgm + summary: app_packageGET + description: Queries the information related to individual application package resources + operationId: app_packageGET + parameters: + - name: appPkgId + in: path + description: Identifier of an individual application package resource + required: true + style: simple + schema: + type: string + responses: + '200': + description: Contains a representation of the application package resource + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgInfo' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + delete: + tags: + - app-pkgm + summary: app_packageDELETE + description: Deletes an individual application package resources + operationId: app_packageDELETE + parameters: + - name: appPkgId + in: path + description: Identifier of an individual application package resource + required: true + style: simple + schema: + type: string + responses: + '204': + description: No Content + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + patch: + tags: + - app-pkgm + summary: app_packagePATCH + description: Updates the operational state of an individual application package resources + operationId: app_packagePATCH + parameters: + - name: appPkgId + in: path + description: Identifier of an individual application package resource + required: true + style: simple + schema: + type: string + requestBody: + description: Operational state to be set + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgInfoModifications' + required: true + responses: + '200': + description: Shows that the operation has been completed successfully + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgInfoModifications' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions: + post: + tags: + - app-pkgm + summary: subscriptionsPOST + description: Subscribe to notifications about on-boarding an application package + operationId: subscriptionsPOST + parameters: [] + requestBody: + description: The input parameters of subscribe operation to notifications + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgSubscription' + required: true + responses: + '201': + description: Successful response for created subscription + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgSubscriptionInfo' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + get: + tags: + - app-pkgm + summary: subscriptionsGET + description: used to retrieve the information of subscriptions to individual application package resource in MEO package + operationId: subscriptionsGET + parameters: [] + responses: + '200': + description: List of zero or more subscriptions + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgSubscriptionLinkList' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions/{subscriptionId}: + get: + tags: + - app-pkgm + summary: individualSubscriptionGET + description: Used to represent an individual subscription to notifications about application package changes. + operationId: individualSubscriptionGET + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual subscription to notifications about application package changes + required: true + style: simple + schema: + type: string + responses: + '200': + description: Representation of the resource. + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgSubscriptionInfo' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + delete: + tags: + - app-pkgm + summary: individualSubscriptionDELETE + description: Deletes the individual subscription to notifications about application package changes in MEO. + operationId: individualSubscriptionDELETE + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual subscription to notifications about application package changes + required: true + style: simple + schema: + type: string + responses: + '204': + description: No Content + headers: {} + content: {} + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_packages/{appPkgId}/appd: + get: + tags: + - app-pkgm + summary: appPkgIdGET + description: Reads the content of the AppD of on-boarded individual application package resources. + operationId: appPkgIdGET + parameters: + - name: appPkgId + in: path + description: Identifier of an on-boarded individual application package + required: true + style: simple + schema: + type: string + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string + responses: + '200': + description: Content of the AppD is returned. + headers: {} + content: + text/plain: + schema: + $ref: '#/components/schemas/AppD' + application/zip: + schema: + type: object + contentMediaType: application/zip + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /onboarded_app_packages/{appDId}/appd: + get: + tags: + - app-pkgm + summary: appDGET + description: Reads the content of the AppD of on-boarded individual application package resources. + operationId: appDGET + parameters: + - name: appDId + in: path + description: Identifier of an application descriptor + required: true + style: simple + schema: + type: string + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string + responses: + '200': + description: Content of the AppD is returned. + headers: {} + content: + text/plain: + schema: + $ref: '#/components/schemas/AppD' + application/zip: + schema: + type: object + contentMediaType: application/zip + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_packages/{appPkgId}/package_content: + get: + tags: + - app-pkgm + summary: appPkgGET + description: Fetch the onboarded application package content identified by appPkgId or appDId. + operationId: appPkgGET + parameters: + - name: appPkgId + in: path + description: Identifier of an on-boarded individual application package + required: true + style: simple + schema: + type: string + responses: + '200': + description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. + headers: {} + content: {} + '206': + description: Partial content + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '416': + description: Range Not Satisfiable . + headers: {} + content: {} + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + put: + tags: + - app-pkgm + summary: appPkgPUT + description: Uploads the content of application package. + operationId: appPkgPUT + parameters: + - name: appPkgId + in: path + description: Identifier of an on-boarded individual application package + required: true + style: simple + schema: + type: string + requestBody: + description: '' + content: + text/plain: + schema: + type: object + contentMediaType: text/plain + required: false + responses: + '202': + description: The application package has been accepted for uploading, but the processing has not been completed. + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /onboarded_app_packages/{appDId}/package_content: + get: + tags: + - app-pkgm + summary: appDIdGET + description: Fetch the onboarded application package content identified by appPkgId or appDId. + operationId: appDIdGET + parameters: + - name: appDId + in: path + description: Identifier of an application descriptor + required: true + style: simple + schema: + type: string + responses: + '200': + description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. + headers: {} + content: {} + '206': + description: Partial content + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '416': + description: Range Not Satisfiable . + headers: {} + content: {} + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + put: + tags: + - app-pkgm + summary: appDIdPUT + description: Uploads the content of application package. + operationId: appDIdPUT + parameters: + - name: appDId + in: path + description: Identifier of an application descriptor + required: true + style: simple + schema: + type: string + requestBody: + description: '' + content: + text/plain: + schema: + type: object + contentMediaType: text/plain + required: false + responses: + '202': + description: The application package has been accepted for uploading, but the processing has not been completed. + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /user_defined_notification: + post: + tags: + - app-pkgm-notifications + summary: app_pkg_notificationPOST + description: Registers a notification endpoint to notify application package operations + operationId: app_pkg_notificationPOST + parameters: [] + requestBody: + description: Notification endpoint to be created + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgNotification' + required: true + responses: + '204': + description: No Content + headers: {} + content: {} + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] +components: + schemas: + AppD: + title: AppD + required: + - appDId + - appDVersion + - appDescription + - appName + - appProvider + - appSoftVersion + - mecVersion + - swImageDescriptor + - virtualComputeDescriptor + type: object + properties: + appDId: + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1. + appDNSRule: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/DNSRuleDescriptor' + description: Describes DNS rules the MEC application requires. + appDVersion: + type: string + description: Identifies the version of the application descriptor. + appDescription: + type: string + description: Human readable description of the MEC application. + appExtCpd: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/AppExternalCpd' + description: Describes external interface(s) exposed by this MEC application. + appFeatureOptional: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/FeatureDependency' + description: Describes features a MEC application may use if available. + appFeatureRequired: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/FeatureDependency' + description: Describes features a MEC application requires to run. + appInfoName: + type: string + description: Human readable name for the MEC application. + appLatency: + $ref: '#/components/schemas/LatencyDescriptor' + appName: + type: string + description: Name to identify the MEC application. + appProvider: + type: string + description: Provider of the application and of the AppD. + appServiceOptional: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ServiceDependency' + description: Describes services a MEC application may use if available. + appServiceProduced: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ServiceDescriptor' + description: Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps. + appServiceRequired: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ServiceDependency' + description: Describes services a MEC application requires to run. + appSoftVersion: + type: string + description: Identifies the version of software of the MEC application. + appTrafficRule: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/TrafficRuleDescriptor' + description: Describes traffic rules the MEC application requires. + changeAppInstanceStateOpConfig: + type: string + description: NFV + mecVersion: + minItems: 1 + type: array + items: + type: string + description: Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. + swImageDescriptor: + type: string + description: Ref NFV + terminateAppInstanceOpConfig: + type: string + description: NFV + transportDependencies: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/TransportDependency' + description: Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2. + virtualComputeDescriptor: + type: string + description: Ref NFV + virtualStorageDescriptor: + minItems: 0 + type: array + items: + type: string + description: Defines descriptors of virtual storage resources to be used by the MEC application. + AppExternalCpd: + title: AppExternalCpd + required: + - inherited_attributes + type: object + properties: + inherited_attributes: + type: object + description: All attributes inherited from Cpd. + virtualNetworkInterfaceRequirements: + minItems: 0 + type: array + items: + type: string + description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. + AppPkgInfo: + title: AppPkgInfo + required: + - id + - appDId + - appName + - appSoftwareVersion + - appDVersion + - checksum + - softwareImages + - onboardingState + - operationalState + - usageState + - _links + type: object + properties: + id: + type: string + description: Identifier of the onboarded application package. + appDId: + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. + appProvider: + type: string + description: Provider of the application and of the AppD. + appName: + type: string + description: Name to identify the MEC application. + appSoftwareVersion: + type: string + description: Software version of the application. This is updated when there is any change to the software in the onboarded application package. + appDVersion: + type: string + description: Identifies the version of the application descriptor. + checksum: + $ref: '#/components/schemas/Checksum' + softwareImages: + type: object + description: Information of application software image in application package. Type is TBD + additionalArtifacts: + type: object + description: Additional information of application package artifacts that are not application software images. Type is TBD + onboardingState: + $ref: '#/components/schemas/OnboardingState' + operationalState: + $ref: '#/components/schemas/AppPkg.OperationalState' + usageState: + $ref: '#/components/schemas/UsageState' + userDefinedData: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + _links: + $ref: '#/components/schemas/AppPkgInfo.links' + description: "'The data type AppPkgInfo represents the parameters for an application package resource'" + AppPkgInfoModifications: + title: AppPkgInfoModifications + required: + - operationState + type: object + properties: + operationState: + $ref: '#/components/schemas/OperationState' + description: "'The data type represents the operational state for an application package resource'" + AppPkg.OperationalState: + title: AppPkg.OperationalState + enum: + - ENABLED + - DISABLED + type: string + description: 'Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.' + examples: + - ENABLED + OnboardingState: + title: OnboardingState + enum: + - CREATED + - UPLOADING + - PROCESSING + - ONBOARDED + type: string + description: Onboarding state of application package + examples: + - CREATED + UsageState: + title: UsageState + enum: + - IN_USE + - NOT_IN_USE + type: string + description: Usage state of the onboarded instance of the application package + examples: + - IN_USE + AppPkgInfo.links: + title: AppPkgInfo.links + required: + - self + - appD + - appPkgContent + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + appD: + $ref: '#/components/schemas/LinkType' + appPkgContent: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + AppPkgNotification: + title: AppPkgNotification + required: + - id + - notificationType + - subscriptionId + - timeStamp + - appPkgId + - appDId + - operationalState + - _links + type: object + properties: + id: + type: string + description: "''" + notificationType: + $ref: '#/components/schemas/AppPkg.NotificationType' + subscriptionId: + type: string + description: Identifier of the subscription related to this notification. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + appPkgId: + type: string + description: Identifier of the onboarded application package. + appDId: + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. + operationalState: + $ref: '#/components/schemas/OperationalState' + _links: + $ref: '#/components/schemas/AppPkgNotification.links' + description: "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'" + AppPkg.NotificationType: + title: AppPkg.NotificationType + enum: + - AppPackageOnBoarded + - AppPacakgeEnabled + - AppPacakgeDisabled + - AppPackageDeleted + type: string + description: Discriminator for the different notification types + examples: + - AppPackageOnBoarded + AppPkgNotification.links: + title: AppPkgNotification.links + required: + - subscription + type: object + properties: + subscription: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + AppPkgSubscriptionInfo: + title: AppPkgSubscriptionInfo + required: + - id + - subscriptionType + - callbackUri + - _links + type: object + properties: + id: + type: string + description: "''" + subscriptionType: + $ref: '#/components/schemas/AppPkg.SubscriptionType' + callbackUri: + type: string + description: The URI of the endpoint for the notification to be sent to. + _links: + $ref: '#/components/schemas/AppPkgSubscriptionInfo.links' + description: "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'" + AppPkg.SubscriptionType: + title: AppPkg.SubscriptionType + enum: + - AppPackageOnBoarding + - AppPacakgeOperationChange + - AppPackageDeletion + type: string + description: Subscribed notification type. + examples: + - AppPackageOnBoarding + AppPkgSubscriptionInfo.links: + title: AppPkgSubscriptionInfo.links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + AppPkgSubscriptionLinkList: + title: AppPkgSubscriptionLinkList + required: + - _links + type: object + properties: + _links: + $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links' + description: "'The data type represents a subscription link list of notification on application package management'" + AppPkgSubscriptionLinkList.links: + title: AppPkgSubscriptionLinkList.links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + subscriptions: + type: array + items: + $ref: '#/components/schemas/Subscriptions.AppPkgSubscription' + description: '' + description: Links to resources related to this resource. + Subscriptions.AppPkgSubscription: + title: Subscriptions.AppPkgSubscription + required: + - href + - subsctiptionType + type: object + properties: + href: + type: string + description: The URI referring to the subscription. + subsctiptionType: + $ref: '#/components/schemas/SubsctiptionType.AppPkg' + description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" + AppPkgSubscription: + title: AppPkgSubscription + required: + - callbackUri + - subsctiptionType + type: object + properties: + callbackUri: + type: string + description: The URI of the endpoint for the notification to be sent to. + subsctiptionType: + $ref: '#/components/schemas/SubsctiptionType.AppPkg' + appPkgFilter: + type: array + items: + type: string + description: '' + description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" + SubsctiptionType.AppPkg: + title: SubsctiptionType.AppPkg + enum: + - AppPackageOnBoarding + - AppPacakgeOperationChange + - AppPackageDeletion + type: string + description: "'Subscribed notification type'" + examples: + - AppPackageOnBoarding + Checksum: + title: Checksum + required: + - algorithm + - hash + type: object + properties: + algorithm: + type: string + description: Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. + hash: + type: string + description: "'String 1 The hexadecimal value of the checksum'" + CreateAppPkg: + title: CreateAppPkg + required: + - appPkgName + - appPkgPath + - appPkgVersion + - checksum + type: object + properties: + appPkgName: + type: string + description: Name of the application package to be onboarded. + appPkgPath: + type: string + appPkgVersion: + type: string + description: >- + Version of the application package to be onboarded. + + The appPkgName with appPkgVersion can be used to uniquely identify the application package. + appProvider: + type: string + description: The provider's name of the application package to be onboarded. + checksum: + $ref: '#/components/schemas/Checksum' + userDefinedData: + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + DNSRuleDescriptor: + title: DNSRuleDescriptor + required: + - dnsRuleId + - domainName + - ipAddress + - ipAddressType + type: object + properties: + dnsRuleId: + type: string + description: Identifies the DNS Rule + domainName: + type: string + description: FQDN of the DNS rule + ipAddress: + type: string + description: IP address given by the DNS rule + ipAddressType: + $ref: '#/components/schemas/IpAddressType' + ttl: + type: integer + description: Time-to-live value + contentEncoding: int32 + IpAddressType: + title: IpAddressType + enum: + - IP_V6 + - IP_V4 + type: string + description: Specifies the IP address type + examples: + - IP_V6 + FeatureDependency: + title: FeatureDependency + required: + - featureName + - version + type: object + properties: + featureName: + type: string + description: The name of the feature, for example, UserApps, UEIdentity, etc. + version: + type: string + description: The version of the feature. + InterfaceDescriptor: + title: InterfaceDescriptor + required: + - interfaceType + type: object + properties: + dstIPAddress: + type: string + description: If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface. + dstMACAddress: + type: string + description: If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface. + interfaceType: + $ref: '#/components/schemas/InterfaceType' + srcMACAddress: + type: string + description: If the interface type is MAC, the source address identifies the MAC address of the interface. + tunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + InterfaceType: + title: InterfaceType + enum: + - TUNNEL + - MAC + - IP + type: string + description: Type of interface. + examples: + - TUNNEL + LatencyDescriptor: + title: LatencyDescriptor + required: + - maxLatency + type: object + properties: + maxLatency: + type: integer + description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note. + contentEncoding: int32 + LinkType: + title: LinkType + required: + - href + type: object + properties: + href: + type: string + description: URI referring to a resource + ProblemDetails: + title: ProblemDetails + type: object + properties: + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + instance: + type: string + description: A URI reference that identifies the specific occurrence of the problem + status: + type: integer + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 + title: + type: string + description: A short, human-readable summary of the problem type + type: + type: string + description: A URI reference according to IETF RFC 3986 that identifies the problem type + ServiceDependency: + title: ServiceDependency + required: + - serName + - version + type: object + properties: + requestedPermissions: + minItems: 0 + type: array + items: + type: string + description: >- + Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4]. + + The format of this attribute is left for the data model design stage. + serCategory: + type: object + description: See MEC011 + serName: + type: string + description: The name of the service, for example, RNIS, LocationService, etc. + serTransportDependencies: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/TransportDependency' + description: Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note. + version: + type: string + description: The version of the service. + ServiceDescriptor: + title: ServiceDescriptor + required: + - serName + - version + type: object + properties: + serName: + type: string + description: The name of the service, for example, RNIS, LocationService, etc. + serCategory: + type: object + description: See MEC011 + version: + type: string + description: The version of the service. + transportsSupported: + $ref: '#/components/schemas/TransportsSupported' + description: "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'" + TransportsSupported: + title: TransportsSupported + type: object + properties: + transport: + $ref: '#/components/schemas/TransportDescriptor' + serializers: + minItems: 1 + type: array + items: + type: string + description: "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '" + description: "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'" + TimeStamp: + title: TimeStamp + required: + - nanoSeconds + - seconds + type: object + properties: + nanoSeconds: + type: integer + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + seconds: + type: integer + description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + TrafficFilter: + title: TrafficFilter + type: object + properties: + dSCP: + type: integer + description: Used to match all IPv4 packets that have the same DSCP. + contentEncoding: int32 + dstAddress: + minItems: 0 + type: array + items: + type: string + description: A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes. + dstPort: + minItems: 0 + type: array + items: + type: string + description: A port or a range of ports. + dstTunnelPort: + minItems: 0 + type: array + items: + type: string + description: Used for GTP tunnel based traffic rule. + protocol: + minItems: 0 + type: array + items: + type: string + description: Specify the protocol of the traffic filter. + qCI: + type: integer + description: Used to match all packets that have the same QCI. + contentEncoding: int32 + srcAddress: + minItems: 0 + type: array + items: + type: string + description: An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes. + srcPort: + minItems: 0 + type: array + items: + type: string + description: A port or a range of ports. + srcTunnelAddress: + minItems: 0 + type: array + items: + type: string + description: Used for GTP tunnel based traffic rule. + srcTunnelPort: + minItems: 0 + type: array + items: + type: string + description: Used for GTP tunnel based traffic rule. + tC: + type: integer + description: Used to match all IPv6 packets that have the same TC. + contentEncoding: int32 + tag: + minItems: 0 + type: array + items: + type: string + description: Used for tag based traffic rule. + tgtTunnelAddress: + minItems: 0 + type: array + items: + type: string + description: Used for GTP tunnel based traffic rule. + TrafficRuleDescriptor: + title: TrafficRuleDescriptor + required: + - action + - filterType + - priority + - trafficFilter + - trafficRuleId + type: object + properties: + action: + $ref: '#/components/schemas/Action' + dstInterface: + maxItems: 2 + minItems: 0 + type: array + items: + $ref: '#/components/schemas/InterfaceDescriptor' + description: '' + filterType: + $ref: '#/components/schemas/FilterType' + priority: + type: integer + description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence. + contentEncoding: int32 + trafficFilter: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/TrafficFilter' + description: The filter used to identify specific flow/packets that need to be handled by the MEC host. + trafficRuleId: + type: string + description: Identifies the traffic rule. + Action: + title: Action + enum: + - DROP + - FORWARD_DECAPSULATED + - FORWARD_AS_IS + - PASSTHROUGH + - DUPLICATED_DECAPSULATED + - DUPLICATE_AS_IS + type: string + description: "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'" + examples: + - DROP + FilterType: + title: FilterType + enum: + - FLOW + - PACKET + type: string + description: 'Definition of filter type: per FLOW or PACKET' + examples: + - FLOW + TransportDependency: + title: TransportDependency + required: + - labels + - serializers + - transport + type: object + properties: + labels: + minItems: 1 + type: array + items: + type: string + description: Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table. + serializers: + minItems: 1 + type: array + items: + type: string + description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport. + transport: + $ref: '#/components/schemas/TransportDescriptor' + TransportDescriptor: + title: TransportDescriptor + required: + - protocol + - security + - type + - version + type: object + properties: + protocol: + type: string + description: The name of the protocol used. Shall be set to HTTP for a REST API. + security: + type: object + description: See MEC011 + type: + type: string + version: + type: string + description: The version of the protocol used. + TunnelInfo: + title: TunnelInfo + required: + - tunnelDstAddress + - tunnelSrcAddress + - tunnelType + type: object + properties: + tunnelDstAddress: + type: string + description: Destination address of the tunnel. + tunnelSpecificData: + type: string + tunnelSrcAddress: + type: string + description: Source address of the tunnel. + tunnelType: + $ref: '#/components/schemas/TunnelType' + TunnelType: + title: TunnelType + enum: + - GTP-U + - GRE + type: string + description: Type of tunnel. + examples: + - GTP-U + OperationalState: + title: OperationalState + enum: + - DISABLED + - ENABLED + type: string + examples: + - DISABLED + OperationState: + title: OperationState + enum: + - DISABLED + - ENABLED + type: string + examples: + - DISABLED +security: +- {} +tags: +- name: app-pkgm + description: App Package management +- name: app-pkgm-notifications + description: App Package management notifications +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf -- GitLab From 748727db5f87836bc1506cc04356f9cd2140fb03 Mon Sep 17 00:00:00 2001 From: piscione Date: Mon, 22 Nov 2021 08:54:47 +0100 Subject: [PATCH 2/4] Replaced OAS3.0 files with OAS3.1 files. --- MEC010-2_AppGrant.yaml | 855 +++--- MEC010-2_AppLcm.yaml | 2180 ++++++++------ MEC010-2_AppPkgMgmt.yaml | 2562 +++++++++-------- .../MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml | 657 ----- .../MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml | 1832 ------------ ...EC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml | 2046 ------------- 6 files changed, 3040 insertions(+), 7092 deletions(-) delete mode 100644 OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml delete mode 100644 OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml delete mode 100644 OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml diff --git a/MEC010-2_AppGrant.yaml b/MEC010-2_AppGrant.yaml index 11021b4..3e2a75f 100644 --- a/MEC010-2_AppGrant.yaml +++ b/MEC010-2_AppGrant.yaml @@ -1,764 +1,657 @@ +openapi: 3.1.0 info: - title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management" - version: 2.1.1 - description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI." - license: - name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' + title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' contact: name: ETSI Forge - email: cti_support@etsi.org url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api -externalDocs: - description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" - url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' + email: cti_support@etsi.org + version: '2.1.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - - url: 'https://localhost/granting/v1' -openapi: 3.0.0 -tags: - - name: granting - description: Grant operations +- url: https://localhost/granting/v1 + variables: {} paths: - /grants: + /grants: post: tags: - - 'granting' - summary: 'requests a grant for a particular application lifecycle operation' - description: 'requests a grant for a particular application lifecycle operation' + - granting + summary: grantPOST + description: requests a grant for a particular application lifecycle operation operationId: grantPOST + parameters: [] requestBody: - required: true + description: '' content: application/json: schema: $ref: '#/components/schemas/GrantRequest' + required: true responses: '201': description: grant was created successfully (synchronous mode) + headers: {} content: application/json: schema: $ref: '#/components/schemas/Grant' '202': - description: the request was accepted for processing + description: the request was accepted for processing + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - /grants/{grantId}: - parameters: - - in: path - name: grantId - description: 'Identifier of the individual grant.' - schema: - type: string - required: true + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /grants/{grantId}: get: tags: - - 'granting' - summary: 'read the grant' - description: 'read the grant' + - granting + summary: GrantGET + description: read the grant operationId: GrantGET + parameters: + - name: grantId + in: path + description: Identifier of the individual grant. + required: true + style: simple + schema: + type: string responses: '200': - description: 'IA representation of the "individual grant" resource ' + description: IA representation of the "individual grant" resource + headers: {} content: application/json: schema: - $ref: '#/components/schemas/Grant' + $ref: '#/components/schemas/Grant' '202': - description: 'returned when the process of creating the grant is ongoing, no grant is available yet' + description: returned when the process of creating the grant is ongoing, no grant is available yet + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] components: schemas: AppExtCpConfig: + title: AppExtCpConfig + type: object properties: cpInstanceId: - description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created. " type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created." cpProtocolData: - description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. - items: - $ref: '#/components/schemas/CpProtocolData' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: CpProtocolData + items: + $ref: '#/components/schemas/CpProtocolData' + description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. linkPortId: - description: Identifier of a pre-configured link port to which the external CP will be associated. See note. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - type: object - x-etsi-notes: "NOTE:\tThe following conditions apply to the attributes \"linkPortId\" and \" cpProtocolData\": \nThe \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. \nAt least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance.\nIf the \"linkPortId\" attribute is absent, the MEPM shall create a link port.\nIf the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port, and the MEPM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port.\nIf both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by \"linkPortId\"." - x-etsi-ref: 6.2.4.13 + description: Identifier of a pre-configured link port to which the external CP will be associated. See note. AppExtCpData: + title: AppExtCpData + required: + - cpConfig + - cpdId + type: object properties: cpConfig: - description: List of instance data that need to be configured on the CP instances created from the respective CPD. - items: - $ref: '#/components/schemas/AppExtCpConfig' minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: AppExtCpConfig + items: + $ref: '#/components/schemas/AppExtCpConfig' + description: List of instance data that need to be configured on the CP instances created from the respective CPD. cpdId: - description: The identifier of the CPD in the AppD. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - cpdId - - cpConfig - type: object - x-etsi-ref: 6.2.4.12 - AppInstanceId: - description: >- - Identifier of application instance. - type: string - AppDId: - description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.' - type: string - AppLcmOpOccId: - description: >- - Identifier of application lifecycle management operation occurrence. - type: string - KeyValuePairs: - description: >- - 'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259' - type: object - additionalProperties: true + description: The identifier of the CPD in the AppD. ResourceDefinition.Type: - description: >- - Type of the resource definition referenced. - type: string - format: enum + title: ResourceDefinition.Type enum: - - COMPUTE - - VL - - STORAGE - - LINKPORT + - COMPUTE + - VL + - STORAGE + - LINKPORT + type: string + description: Type of the resource definition referenced. + examples: + - COMPUTE CpProtocolData: + title: CpProtocolData + required: + - layerProtocol + type: object properties: ipOverEthernet: - # description': Network address data for IP over Ethernet to assign to the extCP instance. Shall be present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': IpOverEthernetAddressData $ref: '#/components/schemas/IpOverEthernetAddressData' layerProtocol: - #description: "Identifier of layer(s) and protocol(s). \n\nPermitted values: IP_OVER_ETHERNET.\n\nSee note." - #type: string - #x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/IpOverEthernetAddressData' + ExtLinkPortData: + title: ExtLinkPortData required: - - layerProtocol + - id + - resourceHandle type: object - x-etsi-notes: "NOTE:\tThis attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported." - x-etsi-ref: 6.2.4.14 - ExtLinkPortData: properties: id: - description: Identifier of this link port as provided by the entity that has created the link port. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of this link port as provided by the entity that has created the link port. resourceHandle: - # description': Reference to the virtualised resource realizing this link port. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': ResourceHandle $ref: '#/components/schemas/ResourceHandle' + ExtVirtualLinkData: + title: ExtVirtualLinkData required: + - extCps - id - - resourceHandle + - resourceId type: object - x-etsi-ref: 6.2.4.9 - ExtVirtualLinkData: properties: extCps: - description: External CPs of the application instance to be connected to this external VL. - items: - $ref: '#/components/schemas/AppExtCpData' minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: AppExtCpData - extLinkPorts: - description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL. items: - $ref: '#/components/schemas/ExtLinkPortData' + $ref: '#/components/schemas/AppExtCpData' + description: External CPs of the application instance to be connected to this external VL. + extLinkPorts: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: ExtLinkPortData + items: + $ref: '#/components/schemas/ExtLinkPortData' + description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL. id: - description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance. resourceId: - description: The identifier of the resource in the scope of the VIM. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The identifier of the resource in the scope of the VIM. vimConnectionId: - description: 'Identifier of the VIM connection to manage this resource. ' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Identifier of the VIM connection to manage this resource. + Grant: + title: Grant required: - id - - resourceId - - extCps - type: object - x-etsi-ref: 6.2.4.8 - Grant: - description: >- - 'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 ' + - appInstanceId + - appLcmOpOccId + - _links type: object - required: - - id - - appInstanceId - - appLcmOpOccId - - _links properties: id: - $ref: '#/components/schemas/Grant.Id' + type: string appInstanceId: - $ref: '#/components/schemas/AppInstanceId' + type: string + description: Identifier of application instance. appLcmOpOccId: - $ref: '#/components/schemas/AppLcmOpOccId' + type: string + description: Identifier of application lifecycle management operation occurrence. vimConnections: type: array items: $ref: '#/components/schemas/VimConnectionInfo' + description: '' zones: type: array items: $ref: '#/components/schemas/ZoneInfo' + description: '' zoneGroups: type: array items: $ref: '#/components/schemas/ZoneGroupInfo' + description: '' addResources: type: array items: $ref: '#/components/schemas/GrantInfo' + description: '' tempResources: type: array items: $ref: '#/components/schemas/GrantInfo' + description: '' removeResources: type: array items: $ref: '#/components/schemas/GrantInfo' + description: '' updateResources: type: array items: $ref: '#/components/schemas/GrantInfo' + description: '' vimAssets: $ref: '#/components/schemas/VimAssets' extVirtualLinks: type: array items: $ref: '#/components/schemas/ExtVirtualLinkData' + description: '' additionalParams: - $ref: '#/components/schemas/KeyValuePairs' + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" _links: $ref: '#/components/schemas/Grant.links' - Grant.Id: - type: string + description: "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '" VimAssets: - description: >- - Information about assets for the application that are managed by the MEO in the VIM, such as software images. + title: VimAssets type: object properties: softwareImages: type: array items: $ref: '#/components/schemas/SoftwareImages' + description: '' + description: Information about assets for the application that are managed by the MEO in the VIM, such as software images. SoftwareImages: - $ref: '#/components/schemas/VimSoftwareImage' - Grant.links: - description: >- - Links to resources related to this resource. + title: SoftwareImages + required: + - appDSoftwareImageId + - vimSoftwareImageId type: object + properties: + appDSoftwareImageId: + type: string + description: Identifier which references the software image descriptor in the AppD. + vimConnectionId: + type: string + description: Identifier of the VIM connection to access the software image referenced in this structure. + vimSoftwareImageId: + type: string + description: Identifier of the software image in the resource management layer (i.e. VIM). + Grant.links: + title: Grant.links required: - - appLcmOpOcc - - appInstance + - appLcmOpOcc + - appInstance + type: object properties: appLcmOpOcc: $ref: '#/components/schemas/LinkType' appInstance: - $ref: '#/components/schemas/LinkType' + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. GrantInfo: + title: GrantInfo + required: + - resourceDefinitionId + type: object properties: resourceDefinitionId: - description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure. resourceGroupId: - description: 'Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated.' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated. vimConnectionId: - description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. zoneId: - description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - required: - - resourceDefinitionId - type: object - x-etsi-ref: 6.2.4.5 + description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated. GrantRequest: - description: >- - 'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003' - type: object + title: GrantRequest required: - - appInstanceId - - appLcmOpOccId - - appDId - - operation - - _links + - appInstanceId + - appLcmOpOccId + - appDId + - operation + - _links + type: object properties: appInstanceId: - $ref: '#/components/schemas/AppInstanceId' + type: string + description: Identifier of application instance. appLcmOpOccId: - $ref: '#/components/schemas/AppLcmOpOccId' + type: string + description: Identifier of application lifecycle management operation occurrence. appDId: - $ref: '#/components/schemas/AppDId' + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. operation: $ref: '#/components/schemas/GrantRequest.Operation' addResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' tempResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' removeResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' updateResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + description: '' additionalParams: - $ref: '#/components/schemas/KeyValuePairs' + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" _links: $ref: '#/components/schemas/GrantRequest.links' + description: "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'" GrantRequest.Operation: - description: >- - 'The lifecycle management operation for which granting is requested' - type: string + title: GrantRequest.Operation enum: - - INSTANTIATE - - OPERATE - - TERMINATE + - INSTANTIATE + - OPERATE + - TERMINATE + type: string + description: "'The lifecycle management operation for which granting is requested'" + examples: + - INSTANTIATE GrantRequest.links: - description: >- - Links to resources related to this resource. - type: object + title: GrantRequest.links required: - - appLcmOpOcc - - appInstance + - appLcmOpOcc + - appInstance + type: object properties: appLcmOpOcc: $ref: '#/components/schemas/LinkType' appInstance: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. IpOverEthernetAddressData: - description: >- - 'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003' + title: IpOverEthernetAddressData type: object properties: macAddress: - $ref: '#/components/schemas/MacAddress' + type: string + description: "'MAC address. If this attribute is not present, it shall be chosen by the VIM'" ipAddresses: - $ref: '#/components/schemas/IpAddresses' - MacAddress: - description: >- - 'MAC address. If this attribute is not present, it shall be chosen by the VIM' - type: string - IpAddresses: - description: >- - List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. - type: array - items: - $ref: '#/components/schemas/IpAddress' + type: array + items: + $ref: '#/components/schemas/IpAddress' + description: List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. + description: "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'" IpAddress: - description: >- - 'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.' - type: object + title: IpAddress required: - - type + - type + type: object properties: type: $ref: '#/components/schemas/IpAddress.Type' fixedAddresses: - $ref: '#/components/schemas/FixedAddresses' + type: array + items: + type: string + description: Fixed addresses to assign (from the subnet defined by subnetId if provided). numDynamicAddresses: - $ref: '#/components/schemas/NumDynamicAddresses' + type: integer + description: Number of dynamic addresses to assign (from the subnet defined by subnetId if provided) + contentEncoding: int32 addressRange: $ref: '#/components/schemas/AddressRange' subnetId: - $ref: '#/components/schemas/SubnetId' + type: string + description: Subnet defined by the identifier of the subnet resource in the VIM. + description: "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'" IpAddress.Type: - description: The type of the IP addresses. - type: string + title: IpAddress.Type enum: - - IPV4 - - IPV6 - FixedAddresses: - description: 'Fixed addresses to assign (from the subnet defined by subnetId if provided).' - type: array - items: - $ref: '#/components/schemas/FixedAddress' - NumDynamicAddresses: - description: 'Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)' - type: integer + - IPV4 + - IPV6 + type: string + description: The type of the IP addresses. + examples: + - IPV4 AddressRange: - description: >- - An IP address range to be used, e.g. in case of egress connections. - type: object + title: AddressRange required: - - minAddress - - maxAddress + - minAddress + - maxAddress + type: object properties: minAddress: - $ref: '#/components/schemas/MinAddress' + type: string + description: Lowest IP address belonging to the range. maxAddress: - $ref: '#/components/schemas/MaxAddress' - MinAddress: - description: Lowest IP address belonging to the range. - type: string - MaxAddress: - description: Highest IP address belonging to the range. - type: string - FixedAddress: - description: >- - Fixed addresses to assign (from the subnet defined by subnetId if provided) - type: string - SubnetId: - description: Subnet defined by the identifier of the subnet resource in the VIM. - type: string - LinkType: - properties: - href: - description: URI referring to a resource - format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI + description: Highest IP address belonging to the range. + description: An IP address range to be used, e.g. in case of egress connections. + LinkType: + title: LinkType required: - href type: object - x-etsi-ref: 6.5.2 + properties: + href: + type: string + description: URI referring to a resource ProblemDetails: + title: ProblemDetails + type: object properties: detail: - description: A human-readable explanation specific to this occurrence of the problem type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: A human-readable explanation specific to this occurrence of the problem instance: - description: A URI reference that identifies the specific occurrence of the problem - format: uri type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI + description: A URI reference that identifies the specific occurrence of the problem status: - description: The HTTP status code for this occurrence of the problem - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 title: - description: A short, human-readable summary of the problem type type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: A short, human-readable summary of the problem type type: - description: A URI reference according to IETF RFC 3986 that identifies the problem type - format: uri type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - type: object + description: A URI reference according to IETF RFC 3986 that identifies the problem type ResourceDefinition: - description: >- - 'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 ' - type: object + title: ResourceDefinition required: - - id - - type - - resourceTemplateId - - resource + - id + - type + - resourceTemplateId + - resource + type: object properties: id: - $ref: '#/components/schemas/ResourceDefinitionId' + type: string + description: Identifier of the related ResourceDefinition structure from the related GrantRequest structure. type: $ref: '#/components/schemas/ResourceDefinition.Type' vduId: - $ref: '#/components/schemas/VduId' + type: string + description: Reference to the related VDU in the AppD applicable to this resource. resourceTemplateId: - $ref: '#/components/schemas/ResourceTemplateId' + type: string + description: Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD. resource: $ref: '#/components/schemas/Resource' - ResourceDefinitionId: - description: >- - Identifier of the related ResourceDefinition structure from the related GrantRequest structure. - type: string - VduId: - description: >- - Reference to the related VDU in the AppD applicable to this resource. - type: string - ResourceTemplateId: - description: >- - Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD. - type: string + description: "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '" Resource: - description: >- - Resource information for an existing resource - type: object + title: Resource required: - - vimConnectionInfo - - resourceId + - vimConnectionInfo + - resourceId + type: object properties: vimConnectionInfo: $ref: '#/components/schemas/VimConnectionInfo' resourceId: - $ref: '#/components/schemas/ResourceId' - ResourceId: - description: >- - Identifier of the resource in the scope of the VIM. - type: string + type: string + description: Identifier of the resource in the scope of the VIM. + description: Resource information for an existing resource ResourceHandle: + title: ResourceHandle + required: + - resourceId + type: object properties: resourceId: - description: Identifier of the resource in the scope of the VIM. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of the resource in the scope of the VIM. vimConnectionId: - description: 'Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure.' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure. vimLevelResourceType: - description: Type of the resource in the scope of the VIM. See note. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Type of the resource in the scope of the VIM. See note. + VimConnectionInfo: + title: VimConnectionInfo required: - - resourceId + - id + - vimType type: object - x-etsi-notes: "NOTE:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition." - x-etsi-ref: 6.2.4.10 - VimConnectionInfo: properties: accessInfo: - #description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.' - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" extra: - #description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" id: - description: The identifier of the VIM Connection. This identifier is managed by the MEO. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The identifier of the VIM Connection. This identifier is managed by the MEO. interfaceInfo: - #description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.' - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" vimId: - description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise. vimType: - description: 'Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ' type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. + VimSoftwareImage: + title: VimSoftwareImage required: - - id - - vimType + - appDSoftwareImageId + - vimSoftwareImageId type: object - x-etsi-ref: 6.2.2.18 - VimSoftwareImage: properties: appDSoftwareImageId: - description: Identifier which references the software image descriptor in the AppD. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier which references the software image descriptor in the AppD. vimConnectionId: - description: 'Identifier of the VIM connection to access the software image referenced in this structure. ' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Identifier of the VIM connection to access the software image referenced in this structure. vimSoftwareImageId: - description: Identifier of the software image in the resource management layer (i.e. VIM). type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of the software image in the resource management layer (i.e. VIM). + ZoneGroupInfo: + title: ZoneGroupInfo required: - - appDSoftwareImageId - - vimSoftwareImageId + - zoneId type: object - x-etsi-ref: 6.2.4.11 - ZoneGroupInfo: properties: zoneId: - description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group. - items: - type: string minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String + items: + type: string + description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group. + ZoneInfo: + title: ZoneInfo required: + - id - zoneId type: object - x-etsi-ref: 6.2.4.7 - ZoneInfo: properties: id: - description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure. vimConnectionId: type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String zoneId: - description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM). type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - id - - zoneId - type: object - x-etsi-ref: 6.2.4.6f - - responses: - 204: - description: No Content - 206: - description: Partial content - 400: - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 401: - description: 'Unauthorized : used when the client did not submit credentials.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 403: - description: 'Forbidden : operation is not allowed given the current status of the resource.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 404: - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 406: - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 409: - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 412: - description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 414: - description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 415: - description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - - 416: - description: 'Range Not Satisfiable .' - 422: - description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - example: - application/problem+json: - problemDetails: - type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' - title: Too many targets - status: '422' - detail: The target area for the request is considered too large - instance: /meAppClient.example.com/77777/msgs/abc - 429: - description: 'Too Many Requests : used when a rate limiter has triggered.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' + description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM). +security: +- {} +tags: +- name: granting + description: Grant operations +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/MEC010-2_AppLcm.yaml b/MEC010-2_AppLcm.yaml index eeea7ab..a792a8d 100644 --- a/MEC010-2_AppLcm.yaml +++ b/MEC010-2_AppLcm.yaml @@ -1,586 +1,1073 @@ +openapi: 3.1.0 info: - title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management" - version: 2.1.1 - description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI." - license: - name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' + title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' contact: name: ETSI Forge - email: cti_support@etsi.org url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api -externalDocs: - description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" - url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' + email: cti_support@etsi.org + version: '2.1.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - - url: 'https://localhost/app_lcm/v1' -openapi: 3.0.0 -tags: - - name: app-lcm - description: App lifecycle management - - name: app-lcm-notifications - description: App lifecycle management notifications +- url: https://localhost/app_lcm/v1 + variables: {} paths: - /app_instances: + /app_instances: post: tags: - '' - summary: 'Create an application instance resource' - description: 'Create an application instance resource' + summary: appInstancePOST + description: Create an application instance resource operationId: appInstancePOST + parameters: [] requestBody: - required: true + description: '' content: application/json: schema: - $ref: '#/components/schemas/CreateAppInstanceRequest' + $ref: '#/components/schemas/CreateAppInstanceRequest' + required: true responses: '201': - description: 'An application instance identifier and the related resource has been created successfully.' + description: An application instance identifier and the related resource has been created successfully. + headers: {} content: application/zip: schema: - $ref: '#/components/schemas/AppInstanceInfo' + type: object + description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" + contentMediaType: application/zip '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false get: tags: - '' - summary: 'Queries information relating to on-boarded application packages in the MEO' - description: 'queries information relating to on-boarded application packages in the MEO' + summary: appInstanceGET + description: queries information relating to on-boarded application packages in the MEO operationId: appInstanceGET parameters: - - in: query - name: filter - schema: - type: string - required: false - description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' - - in: query - name: all_fields - schema: - type: string - required: false - description: 'Include all complex attributes in the response.' - - in: query - name: fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be included into the response' - - in: query - name: exclude_fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be excluded from the response.' - - in: query - name: exclude_default - schema: - type: string - required: false - description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string responses: '200': - description: 'Array the representations of zero or more application instances' + description: Array the representations of zero or more application instances + headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AppInstanceInfo' + description: '' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - /app_instances/{appInstanceId}: - parameters: - - in: path - name: appInstanceId - description: 'Identifier of an individual application instance' - schema: - type: string - required: true + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /app_instances/{appInstanceId}: get: tags: - '' - summary: 'Retrieves the information of an individual application instance via reading an individual application instance.' - description: 'Retrieves the information of an individual application instance via reading an individual application instance.' + summary: appInstanceIdGET + description: Retrieves the information of an individual application instance via reading an individual application instance. operationId: appInstanceIdGET - + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string responses: '200': - description: 'Contains a representation of the read resource.' + description: Contains a representation of the read resource. + headers: {} content: application/json: schema: $ref: '#/components/schemas/AppInstanceInfo' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false delete: tags: - '' - summary: 'Deletes an individual application instance resource.' - description: 'Deletes an individual application instance resource.' + summary: appInstanceIdDELETE + description: Deletes an individual application instance resource. operationId: appInstanceIdDELETE + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance + required: true + style: simple + schema: + type: string responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '409': - $ref: '#/components/responses/409' + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - /subscriptions: + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions: post: tags: - '' - summary: 'subscribe to the notification of application instance operational state change' - description: 'subscribe to the notification of application instance operational state change' + summary: appLcmSubscriptionsPOST + description: subscribe to the notification of application instance operational state change operationId: appLcmSubscriptionsPOST parameters: - - in: query - name: subscriptionType - description: >- - "Query parameter to filter on a specific subscription type. - Permitted values: - • "AppInstanceStateChange" - • "AppLcmOpOccStateChange" - " - schema: - oneOf: - - $ref: '#/components/schemas/AppInst.SubscriptionType' - - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' - required: true - requestBody: + - name: subscriptionType + in: query + description: >- + "Query parameter to filter on a specific subscription type. Permitted values: + • "AppInstanceStateChange" + • "AppLcmOpOccStateChange" + " required: true + style: form + explode: true + schema: + oneOf: + - $ref: '#/components/schemas/AppInst.SubscriptionType' + - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' + requestBody: + description: '' content: application/json: schema: oneOf: - - $ref: '#/components/schemas/AppInstSubscriptionRequest' - - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest' + - $ref: '#/components/schemas/AppInstSubscriptionRequest' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest' + contentMediaType: application/json + required: true responses: '201': - description: 'a representation of the created SubscriptionInfo.' + description: a representation of the created SubscriptionInfo. + headers: {} content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/AppInstSubscriptionInfo' - - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionInfo' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - callbacks: - notification: - '{$request.body#/callbackUri}': - post: - summary: 'Callback POST used to send a notification' - description: 'Notification for informing the subscribers about operational state of application instance resources or state changes of an application LCM operation occurrence. It depends on subscription type.' - operationId: notificationPOST - requestBody: - description: Subscription notification - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppInstNotification' - - $ref: '#/components/schemas/AppLcmOpOccNotification' - responses: - '204': - $ref: '#/components/responses/204' - + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false get: tags: - '' - summary: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.' - description: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.' + summary: appLcmSubscriptionsGET + description: Retrieves the information of multiple subscriptions to notifications related to an application instance. operationId: appLcmSubscriptionsGET parameters: - - in: query - name: subscriptionType - description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' - schema: - type: string - required: false + - name: subscriptionType + in: query + description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' + style: form + explode: true + schema: + type: string responses: '200': - description: ' List of all subscriptions is returned.' + description: List of all subscriptions is returned. + headers: {} content: application/json: schema: - $ref: '#/components/schemas/SubscriptionLinkList' + $ref: '#/components/schemas/SubscriptionLinkList' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - /subscriptions/{subscriptionId}: - parameters: - - in: path - name: subscriptionId - description: 'Represents an individual subscription to notification related to an application instance' - schema: - type: string - required: true + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions/{subscriptionId}: get: tags: - '' - summary: 'Used to represent an individual subscription to notifications about application package changes.' - description: 'Used to represent an individual subscription to notifications about application package changes.' + summary: individualSubscriptionGET + description: Used to represent an individual subscription to notifications about application package changes. operationId: individualSubscriptionGET parameters: - - in: query - name: subscriptionType - description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' - schema: - type: string - required: true + - name: subscriptionId + in: path + description: Represents an individual subscription to notification related to an application instance + required: true + style: simple + schema: + type: string + - name: subscriptionType + in: query + description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' + required: true + style: form + explode: true + schema: + type: string responses: '200': - description: Representation of the resource. + description: Representation of the resource. + headers: {} content: application/json: schema: oneOf: - - $ref: '#/components/schemas/AppInstSubscriptionInfo' - - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + - $ref: '#/components/schemas/AppInstSubscriptionInfo' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false delete: tags: - '' - summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' - description: 'Deletes the individual subscription to notifications about application package changes in MEO.' + summary: individualSubscriptionDELETE + description: Deletes the individual subscription to notifications about application package changes in MEO. operationId: individualSubscriptionDELETE + parameters: + - name: subscriptionId + in: path + description: Represents an individual subscription to notification related to an application instance + required: true + style: simple + schema: + type: string responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' -############################################################################### -# Notification endpoint oneOf: AppInstNotification, AppLcmOpOccNotification # -############################################################################### + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /user_defined_notification: - post: + post: tags: - '' - summary: 'Delivers a notification from the application lifecycle management resource to the subscriber.' - description: 'Delivers a notification from the application lifecycle management resource to the subscriber.' + summary: appInstNotificationPOST + description: Delivers a notification from the application lifecycle management resource to the subscriber. operationId: appInstNotificationPOST + parameters: [] requestBody: - required: true + description: '' content: application/json: schema: oneOf: - - $ref: '#/components/schemas/AppInstNotification' - - $ref: '#/components/schemas/AppLcmOpOccNotification' + - $ref: '#/components/schemas/AppInstNotification' + - $ref: '#/components/schemas/AppLcmOpOccNotification' + contentMediaType: application/json + required: true responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_instances/{appInstanceId}/instantiate: - parameters: - - in: path - name: appInstanceId - description: 'Identifier of an individual application instance' - schema: - type: string - required: true post: tags: - '' - summary: 'task of instantiating an application instance.' - description: 'task of instantiating an application instance.' + summary: appLcmInstanciatePOST + description: task of instantiating an application instance. operationId: appLcmInstanciatePOST - requestBody: + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance required: true + style: simple + schema: + type: string + requestBody: + description: '' content: application/json: schema: $ref: '#/components/schemas/InstantiateAppRequest' + required: true responses: '202': - description: 'accepted for processing, but the processing has not yet been completed.' + description: accepted for processing, but the processing has not yet been completed. + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '409': - $ref: '#/components/responses/409' + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_instances/{appInstanceId}/terminate: - parameters: - - in: path - name: appInstanceId - description: 'Identifier of an individual application instance' - schema: - type: string - required: true post: tags: - '' - summary: 'terminate an application instance.' - description: 'terminate an application instance.' + summary: appLcmTerminatePOST + description: terminate an application instance. operationId: appLcmTerminatePOST - requestBody: + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance required: true + style: simple + schema: + type: string + requestBody: + description: '' content: application/json: schema: $ref: '#/components/schemas/TerminateAppRequest' + required: true responses: '202': - description: 'accepted for processing, but the processing has not yet been completed.' + description: accepted for processing, but the processing has not yet been completed. + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '409': - $ref: '#/components/responses/409' + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_instances/{appInstanceId}/operate: - parameters: - - in: path - name: appInstanceId - description: 'Identifier of an individual application instance' - schema: - type: string - required: true post: tags: - '' - summary: 'change the operational state, i.e. start or stop, of the application instance' - description: 'change the operational state, i.e. start or stop, of the application instance' + summary: appLcmOperatePOST + description: change the operational state, i.e. start or stop, of the application instance operationId: appLcmOperatePOST - requestBody: + parameters: + - name: appInstanceId + in: path + description: Identifier of an individual application instance required: true + style: simple + schema: + type: string + requestBody: + description: '' content: application/json: schema: $ref: '#/components/schemas/OperateAppRequest' + required: true responses: '202': - description: 'accepted for processing, but the processing has not yet been completed.' + description: accepted for processing, but the processing has not yet been completed. + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '409': - $ref: '#/components/responses/409' + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_lcm_op_occs: get: tags: - '' - summary: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences' - description: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences' + summary: appLcmOpOccsGET + description: retrieves information of operation status about multiple application instance lifecycle management operation occurrences operationId: appLcmOpOccsGET parameters: - - in: query - name: filter - schema: - type: string - required: false - description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' - - in: query - name: all_fields - schema: - type: string - required: false - description: 'Include all complex attributes in the response.' - - in: query - name: fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be included into the response' - - in: query - name: exclude_fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be excluded from the response.' - - in: query - name: exclude_default - schema: - type: string - required: false - description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string responses: '200': - description: 'Status information for zero or more application instance lifecycle management operation occurrences was queried successfully' + description: Status information for zero or more application instance lifecycle management operation occurrences was queried successfully + headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AppInstanceLcmOpOcc' + description: '' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_lcm_op_occs/{appLcmOpOccId}: - parameters: - - in: path - name: appLcmOpOccId - description: 'Identifies an individual application LCM operation occurrence' - schema: - type: string - required: true get: tags: - '' - summary: 'reads the status information of an individual application LCM operation occurrence' - description: 'reads the status information of an individual application LCM operation occurrence' + summary: appLcmOpOccsbyIdGET + description: reads the status information of an individual application LCM operation occurrence operationId: appLcmOpOccsbyIdGET - + parameters: + - name: appLcmOpOccId + in: path + description: Identifies an individual application LCM operation occurrence + required: true + style: simple + schema: + type: string responses: '200': - description: 'Information about an application LCM operation occurrence was read successfully' + description: Information about an application LCM operation occurrence was read successfully + headers: {} content: application/json: schema: $ref: '#/components/schemas/AppInstanceLcmOpOcc' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] components: schemas: AppInstanceLcmOpOcc: - description: >- - 'This data type represents an application lifecycle management operation occurrence' - type: object + title: AppInstanceLcmOpOcc required: - - id - - operationState - - stateEnteredTime - - startTime - - lcmOperation - - _links + - id + - operationState + - stateEnteredTime + - startTime + - lcmOperation + - _links + type: object properties: id: - $ref: '#/components/schemas/AppInstanceLcmOpOcc.Id' + type: string + description: "'Identifier of the subscription to application LCM operation occurrence notification'" operationState: $ref: '#/components/schemas/OperationState' stateEnteredTime: @@ -593,45 +1080,43 @@ components: $ref: '#/components/schemas/OperationParams' _links: $ref: '#/components/schemas/AppInstanceLcmOpOcc.links' - AppInstanceLcmOpOcc.Id: - description: >- - 'Identifier of the subscription to application LCM operation occurrence notification' - type: string + description: "'This data type represents an application lifecycle management operation occurrence'" OperationParams: - description: >- - 'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.' - type: string + title: OperationParams enum: - - INSTANTIATE - - OPERATE - - TERMINATE + - INSTANTIATE + - OPERATE + - TERMINATE + type: string + description: "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'" + examples: + - INSTANTIATE AppInstanceLcmOpOcc.links: - description: >- - Links to resources related to this resource. - type: object + title: AppInstanceLcmOpOcc.links required: - - self - - appInstance + - self + - appInstance + type: object properties: self: $ref: '#/components/schemas/LinkType' appInstance: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. SubscriptionLinkList: - description: >- - 'The data type represents a subscription link list of notification on application lifecycle management. ' - type: object + title: SubscriptionLinkList required: - - _links + - _links + type: object properties: _links: $ref: '#/components/schemas/SubscriptionLinkList.links' + description: "'The data type represents a subscription link list of notification on application lifecycle management. '" SubscriptionLinkList.links: - description: >- - Links to resources related to this resource. - type: object + title: SubscriptionLinkList.links required: - - self + - self + type: object properties: self: $ref: '#/components/schemas/LinkType' @@ -639,143 +1124,132 @@ components: type: array items: $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' + description: '' + description: Links to resources related to this resource. SubscriptionLinkList.links.subscriptions: - description: >- - A link list to the subscriptions - type: object + title: SubscriptionLinkList.links.subscriptions required: - - href - - subscriptionType + - href + - subscriptionType + type: object properties: - href: + href: type: string - format: uri subscriptionType: - type: string - format: enum - enum: - - AppInstanceStateChange - - AppLcmOpOccStateChange + $ref: '#/components/schemas/SubscriptionType' + description: A link list to the subscriptions AppLcmOpOccSubscriptionInfo: - description: >- - 'This data type represents a subscription to notifications of application life cycle management operation occurrence' - type: object + title: AppLcmOpOccSubscriptionInfo required: - - id - - subscriptionType - - callbackUri - - _links + - id + - subscriptionType + - callbackUri + - _links + type: object properties: id: - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.Id' + type: string + description: "''" subscriptionType: - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' + const: AppLcmOpOccStateChange + type: string + description: Shall be set to AppLcmOpOccStateChange. + examples: + - AppLcmOpOccStateChange callbackUri: - $ref: '#/components/schemas/CallbackUri' + type: string + description: The URI of the endpoint for the notification to be sent to. _links: $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links' - AppLcmOpOccSubscriptionInfo.Id: - description: >- - '' - type: string + description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'" AppLcmOpOcc.SubscriptionType: - description: >- - Shall be set to AppLcmOpOccStateChange. + title: AppLcmOpOcc.SubscriptionType + const: AppLcmOpOccStateChange type: string - enum: - - AppLcmOpOccStateChange + description: Shall be set to AppLcmOpOccStateChange. + examples: + - AppLcmOpOccStateChange AppLcmOpOccSubscriptionInfo.links: - description: >- - Links to resources related to this resource. - type: object + title: AppLcmOpOccSubscriptionInfo.links required: - - self + - self + type: object properties: self: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. AppInstSubscriptionInfo: - description: >- - 'The data type represents a subscription to notification of application instance operational state change.' - type: object + title: AppInstSubscriptionInfo required: - - id - - subscriptionType - - notificationType - - callbackUri - - _links + - id + - subscriptionType + - notificationType + - callbackUri + - _links + type: object properties: id: - $ref: '#/components/schemas/AppInstSubscriptionInfo.Id' + type: string + description: "'Identifier of the subscription to application instance operational state change notification.'" subscriptionType: - $ref: '#/components/schemas/AppInst.SubscriptionType' + const: AppInstanceStateChange + type: string + description: Shall be set to AppInstanceStateChange. + examples: + - AppInstanceStateChange notificationType: $ref: '#/components/schemas/AppInst.NotificationType' callbackUri: - $ref: '#/components/schemas/CallbackUri' + type: string + description: The URI of the endpoint for the notification to be sent to. _links: $ref: '#/components/schemas/AppInstSubscriptionInfo.links' - AppInstSubscriptionInfo.Id: - description: >- - 'Identifier of the subscription to application instance operational state change notification.' - type: string + description: "'The data type represents a subscription to notification of application instance operational state change.'" AppInst.SubscriptionType: - description: >- - Shall be set to AppInstanceStateChange. + title: AppInst.SubscriptionType + const: AppInstanceStateChange type: string - enum: - - AppInstanceStateChange + description: Shall be set to AppInstanceStateChange. + examples: + - AppInstanceStateChange AppInst.NotificationType: - description: >- - Subscribed notification - type: string + title: AppInst.NotificationType enum: - - NOT_INSTANTIATED - - STARTED - - STOPPED - CallbackUri: - description: >- - The URI of the endpoint for the notification to be sent to. + - NOT_INSTANTIATED + - STARTED + - STOPPED type: string - format: uri + description: Subscribed notification + examples: + - NOT_INSTANTIATED AppInstSubscriptionInfo.links: - description: Links to resources related to this resource. + title: AppInstSubscriptionInfo.links + required: + - self + type: object properties: self: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. + AppLcmOpOccSubscriptionRequest: + title: AppLcmOpOccSubscriptionRequest required: - - self + - callbackUri + - subscriptionType type: object - - AppLcmOpOccSubscriptionRequest: properties: appLcmOpOccSubscriptionFilter: - # description': Subscription filter criteria to match specific application LCM operation occurrences. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': AppLcmOpOccSubscriptionFilter $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter' callbackUri: - # description': The URI of the endpoint for the notification to be sent to. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': Uri - $ref: '#/components/schemas/URI' + type: string subscriptionType: - description: Shall be set to "AppLcmOpOccStateChange". type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackUri - type: object - x-etsi-ref: 6.2.2.14 - URI: - type: string + description: Shall be set to "AppLcmOpOccStateChange". AppLcmOpOccSubscriptionFilter: + title: AppLcmOpOccSubscriptionFilter + type: object properties: appInstanceSubscriptionFilter: - # description': If present, this attribute contains filter criteria that selects one or more application instances on which to receive "LCM operation occurrence" notifications. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': AppInstanceSubscriptionFilter $ref: '#/components/schemas/AppInstanceSubscriptionFilter' notificationTypes: $ref: '#/components/schemas/NotificationTypes' @@ -784,304 +1258,278 @@ components: operationTypes: $ref: '#/components/schemas/OperationTypes' NotificationTypes: - description: Match particular notification types. + title: NotificationTypes + const: AppLcmOperationOccurrenceNotification type: string - enum: - - AppLcmOperationOccurrenceNotification + description: Match particular notification types. + examples: + - AppLcmOperationOccurrenceNotification OperationStates: - description: >- - 'Type of the LCM operation state represented by this application instance LCM operation occurrence.' - type: string + title: OperationStates enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED - OperationTypes: - description: >- - 'Type of the LCM operation represented by this application instance LCM operation occurrence.' + - STARTING + - PROCESSING + - COMPLETED + - FAILED type: string + description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'" + examples: + - STARTING + OperationTypes: + title: OperationTypes enum: - - INSTANTIATE - - OPERATE - - TERMINATE + - INSTANTIATE + - OPERATE + - TERMINATE + type: string + description: "'Type of the LCM operation represented by this application instance LCM operation occurrence.'" + examples: + - INSTANTIATE CreateAppInstanceRequest: + title: CreateAppInstanceRequest + required: + - appDId + type: object properties: appDId: - description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. appInstanceDescription: - description: Human-readable description of the application instance to be created. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Human-readable description of the application instance to be created. appInstanceName: - description: Human-readable name of the application instance to be created. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - required: - - appDId - type: object - x-etsi-ref: 6.2.2.3 + description: Human-readable name of the application instance to be created. AppInstSubscriptionRequest: - type: object + title: AppInstSubscriptionRequest required: - - subscriptionType - - callbackUri + - subscriptionType + - callbackUri + type: object properties: subscriptionType: - $ref: '#/components/schemas/AppInst.SubscriptionType' + const: AppInstanceStateChange + type: string + description: Shall be set to AppInstanceStateChange. + examples: + - AppInstanceStateChange callbackUri: - $ref: '#/components/schemas/CallbackUri' + type: string + description: The URI of the endpoint for the notification to be sent to. appInstanceState: $ref: '#/components/schemas/AppInstanceState' appInstanceSubscriptionFilter: $ref: '#/components/schemas/AppInstanceSubscriptionFilter' AppInstanceSubscriptionFilter: - description: >- - 'This data type represents subscription filter criteria to match application instances. ' - type: object + title: AppInstanceSubscriptionFilter required: - - appInstSelectorType + - appInstSelectorType + type: object properties: appInstSelectorType: $ref: '#/components/schemas/AppInstSelectorType' appInstances: type: array items: - $ref: '#/components/schemas/AppInstances' + type: string + description: '' appsFromProviders: - type: array - items: - $ref: '#/components/schemas/AppsFromProviders' + type: array + items: + $ref: '#/components/schemas/AppsFromProviders' + description: '' + description: "'This data type represents subscription filter criteria to match application instances. '" AppsFromProviders: - description: >- - 'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.' - type: object + title: AppsFromProviders required: - - appProvider + - appProvider + type: object properties: appProvider: - $ref: '#/components/schemas/AppProvider' + type: string + description: Provider of the application and of the AppD. appProducts: $ref: '#/components/schemas/AppProducts' + description: "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'" AppProducts: - description: >- - 'If present, match application instances that belong to application products with certain product names, from one particular provider.' - type: object + title: AppProducts required: - - appName + - appName + type: object properties: appName: - $ref: '#/components/schemas/AppName' + type: string + description: Name to identify the MEC application. versions: $ref: '#/components/schemas/AppProducts.Versions' + description: "'If present, match application instances that belong to application products with certain product names, from one particular provider.'" AppProducts.Versions: - description: >- - 'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.' - type: object + title: AppProducts.Versions required: - - appSoftVersion + - appSoftVersion + type: object properties: appSoftVersion: - $ref: '#/components/schemas/AppSoftVersion' + type: string + description: Identifies the version of software of the MEC application. appDVersion: type: array items: - $ref: '#/components/schemas/AppDVersion' - AppInstances: - description: >- - If appInstIdSelector = APP_IDENTITY match existing application instances with an application instance identifier listed in this attribute. - type: string + type: string + description: '' + description: "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'" AppInstSelectorType: - description: '0 = void' - type: string + title: AppInstSelectorType enum: - - VOID - - APP_IDENTITY - - APP_NAME - - APP_D_ID - - APP_FROM_PROVIDER - AppInstanceState: - description: >- - Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states. + - VOID + - APP_IDENTITY + - APP_NAME + - APP_D_ID + - APP_FROM_PROVIDER type: string - format: enum + description: 0 = void + examples: + - VOID + AppInstanceState: + title: AppInstanceState enum: - - NOT_INSTANTIATED - - STARTED - - STOPPED + - NOT_INSTANTIATED + - STARTED + - STOPPED + type: string + description: Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states. + examples: + - NOT_INSTANTIATED AppInstNotification: + title: AppInstNotification + required: + - _links + - appDId + - appInstanceId + - appPkgId + - id + - notificationType + - subscriptionId + - timeStamp + type: object properties: _links: - description: Links to resources related to this notification. - properties: - subscription: - # description': A link to the related subscription. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LinkType - $ref: '#/components/schemas/LinkType' - required: - - subscription - type: object - x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/Links' appDId: - description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way. appInstanceId: - description: Identifier of application instance. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of application instance. appPkgId: - description: 'Identifier of the onboarded application package. ' type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of the onboarded application package. id: - description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all these notifications shall have the same value. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all these notifications shall have the same value. notificationType: - # description: "Discriminator for the different notification types:\nNOT_INSTANTIATED: the application instance is not instantiated. \nSTARTED: the application instance is up and running. \nSTOPPED: the application instance stops operation." - # type: string - # x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/AppInst.NotificationType' subscriptionId: - description: Identifier of the subscription related to this notification. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of the subscription related to this notification. timeStamp: - # description': Date and time of the notification generation. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' + AppInstanceInfo: + title: AppInstanceInfo required: - id - - notificationType - - subscriptionId - - timeStamp - - appInstanceId - - appPkgId - appDId + - appProvider + - appName + - appSoftVersion + - appDVersion + - appPkgId + - instantiationState - _links type: object - x-etsi-ref: 6.2.2.11 - AppInstanceInfo: - description: >- - 'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.' - type: object - required: - - id - - appDId - - appProvider - - appName - - appSoftVersion - - appDVersion - - appPkgId - - instantiationState - - _links properties: id: - $ref: '#/components/schemas/AppInstanceId' + type: string + description: Identifier of application instance. appInstanceName: - $ref: '#/components/schemas/AppInstanceName' + type: string + description: Name of the application instance. appInstanceDescription: - $ref: '#/components/schemas/AppInstanceDescription' + type: string + description: Human-readable description of the application instance to be created. appDId: - $ref: '#/components/schemas/AppDId' + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. appProvider: - $ref: '#/components/schemas/AppProvider' + type: string + description: Provider of the application and of the AppD. appName: - $ref: '#/components/schemas/AppName' + type: string + description: Name to identify the MEC application. appSoftVersion: - $ref: '#/components/schemas/AppSoftVersion' + type: string + description: Identifies the version of software of the MEC application. appDVersion: - $ref: '#/components/schemas/AppDVersion' + type: string + description: Identifies the version of the application descriptor. appPkgId: - $ref: '#/components/schemas/AppPkgId' + type: string + description: Identifier of the onboarded application package. vimConnectionInfo: type: array items: - $ref: '#/components/schemas/VimConnectionInfo' + $ref: '#/components/schemas/VimConnectionInfo' + description: '' instantiationState: $ref: '#/components/schemas/InstantiationState' instantiatedAppState: $ref: '#/components/schemas/InstantiatedAppState' _links: $ref: '#/components/schemas/AppInstanceInfo.links' - AppInstanceId: - description: >- - Identifier of application instance. - type: string + description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" OperationState: - description: >- - Operation state - type: string - format: enum + title: OperationState enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED - AppInstanceName: - description: Name of the application instance. - type: string - AppInstanceDescription: - description: Human-readable description of the application instance to be created. - type: string - AppDId: - description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.' - type: string - AppProvider: - description: 'Provider of the application and of the AppD.' - type: string - AppName: - description: 'Name to identify the MEC application.' - type: string - AppSoftVersion: - description: 'Identifies the version of software of the MEC application.' - type: string - AppDVersion: - description: 'Identifies the version of the application descriptor.' - type: string - AppPkgId: - description: Identifier of the onboarded application package. + - STARTING + - PROCESSING + - COMPLETED + - FAILED type: string + description: Operation state + examples: + - STARTING InstantiationState: - description: Instantiation state of the application instance - type: string + title: InstantiationState enum: - - NOT_INSTANTIATED - - INSTANTIATED + - NOT_INSTANTIATED + - INSTANTIATED + type: string + description: Instantiation state of the application instance + examples: + - NOT_INSTANTIATED InstantiatedAppState: - description: >- - 'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.' - type: object + title: InstantiatedAppState required: - - operationalState + - operationalState + type: object properties: operationalState: $ref: '#/components/schemas/OperationalState' + description: "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'" OperationalState: - description: Operational state is applicable in the instantiation state INSTANTIATED - type: string + title: OperationalState enum: - - STARTED - - STOPPED + - STARTED + - STOPPED + type: string + description: Operational state is applicable in the instantiation state INSTANTIATED + examples: + - STARTED AppInstanceInfo.links: - description: >- - Links to resources related to this resource. - type: object + title: AppInstanceInfo.links required: - - self + - self + type: object properties: self: $ref: '#/components/schemas/LinkType' @@ -1091,71 +1539,66 @@ components: $ref: '#/components/schemas/LinkType' operate: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. LcmOperation: - description: >- - Type of the actual LCM operation represented by this application instance LCM operation occurrence - type: string - format: enum + title: LcmOperation enum: - - INSTATIATE - - OPERATE - - TERMINATE + - INSTATIATE + - OPERATE + - TERMINATE + type: string + description: Type of the actual LCM operation represented by this application instance LCM operation occurrence + examples: + - INSTATIATE AppLcmOpOccNotification: - description: >- - 'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers' - type: object + title: AppLcmOpOccNotification required: - - id - - notificationType - - subscriptionId - - timeStamp - - appLcmOpOccId - - appInstanceId - - _links + - id + - notificationType + - subscriptionId + - timeStamp + - appLcmOpOccId + - appInstanceId + - _links + type: object properties: id: - $ref: '#/components/schemas/AppLcmOpOccNotification.Id' + type: string + description: "''" notificationType: $ref: '#/components/schemas/AppLcmOpOcc.NotificationType' subscriptionId: - $ref: '#/components/schemas/SubscriptionId' + type: string + description: Identifier of the subscription related to this notification. timeStamp: $ref: '#/components/schemas/TimeStamp' appLcmOpOccId: - $ref: '#/components/schemas/AppLcmOpOccId' + type: string + description: Identifier of application lifecycle management operation occurrence. appInstanceId: - $ref: '#/components/schemas/AppInstanceId' + type: string + description: Identifier of application instance. _links: $ref: '#/components/schemas/AppLcmOpOccNotification.links' - AppLcmOpOccNotification.Id: - description: >- - '' - type: string + description: "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'" AppLcmOpOcc.NotificationType: - description: >- - Discriminator for the different notification types - type: string + title: AppLcmOpOcc.NotificationType enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED - SubscriptionId: - description: >- - Identifier of the subscription related to this notification. - type: string - AppLcmOpOccId: - description: >- - Identifier of application lifecycle management operation occurrence. + - STARTING + - PROCESSING + - COMPLETED + - FAILED type: string + description: Discriminator for the different notification types + examples: + - STARTING AppLcmOpOccNotification.links: - description: >- - Links to resources related to this resource. - type: object + title: AppLcmOpOccNotification.links required: - - appInstance - - subscription - - appLcmOpOcc + - appInstance + - subscription + - appLcmOpOcc + type: object properties: appInstance: $ref: '#/components/schemas/LinkType' @@ -1163,350 +1606,227 @@ components: $ref: '#/components/schemas/LinkType' appLcmOpOcc: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. InstantiateAppRequest: + title: InstantiateAppRequest + required: + - selectedMECHostInfo + type: object properties: locationConstraints: - # description': Defines the location constraints for the application instance to be created. See note 3. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': LocationConstraints $ref: '#/components/schemas/LocationConstraints' selectedMECHostInfo: - description: Describes the information of selected host for the application instance. See note 2. - items: - $ref: '#/components/schemas/MECHostInformation' minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: MECHostInformation - vimConnectionInfo: - description: 'Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links. - - This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.' items: - $ref: '#/components/schemas/VimConnectionInfo' + $ref: '#/components/schemas/MECHostInformation' + description: Describes the information of selected host for the application instance. See note 2. + vimConnectionInfo: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: VimConnectionInfo + items: + $ref: '#/components/schemas/VimConnectionInfo' + description: >- + Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links. + + This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2. virtualComputeDescriptor: - # description': Describes CPU, Memory and acceleration requirements of the virtual machine for the application instance to be created. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': VirtualComputeDescription - $ref: '#/components/schemas/VirtualComputeDescription' + type: string + description: Ref NFV virtualStorageDescriptor: - description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1. - items: - $ref: '#/components/schemas/VirtualStorageDescriptor' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: VirtualStorageDescriptor + items: + type: string + description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1. + LinkType: + title: LinkType required: - - selectedMECHostInfo + - href type: object - x-etsi-notes: "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only." - x-etsi-ref: 6.2.2.7 - LinkType: properties: href: - description: URI referring to a resource - format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - required: - - href - type: object - x-etsi-ref: 6.5.2 + description: URI referring to a resource LocationConstraints: - description: >- - 'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776' - type: object + title: LocationConstraints required: - - countryCode + - countryCode + type: object properties: countryCode: - $ref: '#/components/schemas/CountryCode' + type: string + description: The two-letter ISO 3166 country code in capital letters. civicAddressElement: type: array items: $ref: '#/components/schemas/CivicAddressElement' - CountryCode: - description: 'The two-letter ISO 3166 country code in capital letters.' - type: string + description: '' + description: "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'" CivicAddressElement: - description: >- - 'The civic address.' - type: object + title: CivicAddressElement required: - - caType - - caValue + - caType + - caValue + type: object properties: caType: - $ref: '#/components/schemas/CaType' + type: integer + description: "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'" + contentEncoding: int32 caValue: - $ref: '#/components/schemas/CaValue' - CaType: - description: >- - 'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.' - type: integer - CaValue: - description: >- - 'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.' - type: string + type: string + description: "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'" + description: "'The civic address.'" MECHostInformation: + title: MECHostInformation + required: + - hostId + type: object properties: hostId: - #description: 'User defined MEC host ID. ' - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: '1' - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" hostName: - description: Human-readable name of MEC host. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Human-readable name of MEC host. + OperateAppRequest: + title: OperateAppRequest required: - - hostId + - changeStateTo type: object - x-etsi-ref: 6.2.2.17 - OperateAppRequest: properties: changeStateTo: - #description: "The desired operational state: \nSTARTED: the application instance is up and running.\nSTOPPED: the application instance stops operation." - # x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/ChangeStateTo' gracefulStopTimeout: - description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2. type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Integer + description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2. + contentEncoding: int32 stopType: - #description: 'The stop type' - #x-etsi-mec-cardinality: 0..1 $ref: '#/components/schemas/StopType' - required: - - changeStateTo - type: object - x-etsi-notes: "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent." - x-etsi-ref: 6.2.2.8 StopType: - description: >- - Signals forceful or graceful stop - type: string + title: StopType enum: - - FORCEFUL - - GRACEFUL - ChangeStateTo: - description: 'The desired operational state' + - FORCEFUL + - GRACEFUL type: string - format: enum + description: Signals forceful or graceful stop + examples: + - FORCEFUL + ChangeStateTo: + title: ChangeStateTo enum: - - STARTED - - STOPPED + - STARTED + - STOPPED + type: string + description: The desired operational state + examples: + - STARTED ProblemDetails: + title: ProblemDetails + type: object properties: detail: - description: A human-readable explanation specific to this occurrence of the problem type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: A human-readable explanation specific to this occurrence of the problem instance: - description: A URI reference that identifies the specific occurrence of the problem - format: uri type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI + description: A URI reference that identifies the specific occurrence of the problem status: - description: The HTTP status code for this occurrence of the problem - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 title: - description: A short, human-readable summary of the problem type type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: A short, human-readable summary of the problem type type: - description: A URI reference according to IETF RFC 3986 that identifies the problem type - format: uri type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - type: object + description: A URI reference according to IETF RFC 3986 that identifies the problem type TerminateAppRequest: + title: TerminateAppRequest + required: + - terminationType + type: object properties: gracefulTerminationTimeout: - description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources." type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Integer + description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources." + contentEncoding: int32 terminationType: - # description: 'Indicates whether forceful or graceful termination is requested.' - # x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/TerminationType' + TimeStamp: + title: TimeStamp required: - - terminationType + - nanoSeconds + - seconds type: object - x-etsi-notes: "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service." - x-etsi-ref: 6.2.2.9 - TimeStamp: properties: nanoSeconds: - description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - format: Uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 seconds: - description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC." - format: Uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - required: - - seconds - - nanoSeconds - type: object - x-etsi-ref: 6.2.5.4 + description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 TerminationType: - description: >- - 'Indicates whether forceful or graceful termination is requested.' - type: string - format: enum + title: TerminationType enum: - - FORCEFUL - - GRACEFUL + - FORCEFUL + - GRACEFUL + type: string + description: "'Indicates whether forceful or graceful termination is requested.'" + examples: + - FORCEFUL VimConnectionInfo: + title: VimConnectionInfo + required: + - id + - vimType + type: object properties: accessInfo: - #description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.' - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" extra: - #description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" id: - description: The identifier of the VIM Connection. This identifier is managed by the MEO. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The identifier of the VIM Connection. This identifier is managed by the MEO. interfaceInfo: - #description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.' - $ref: '#/components/schemas/KeyValuePairs' - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePairs + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" vimId: - description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise. vimType: - description: 'Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ' type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. + Links: + title: Links required: - - id - - vimType + - subscription type: object - x-etsi-ref: 6.2.2.18 - VirtualComputeDescription: - description: Ref NFV - type: string - VirtualStorageDescriptor: - description: Ref NFV + properties: + subscription: + $ref: '#/components/schemas/LinkType' + description: Links to resources related to this notification. + SubscriptionType: + title: SubscriptionType + enum: + - AppInstanceStateChange + - AppLcmOpOccStateChange type: string - KeyValuePairs: - description: >- - 'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259' - type: object - additionalProperties: true - - responses: - 204: - description: No Content - 206: - description: Partial content - 400: - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 401: - description: 'Unauthorized : used when the client did not submit credentials.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 403: - description: 'Forbidden : operation is not allowed given the current status of the resource.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 404: - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 406: - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 409: - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 412: - description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when - using ETags to avoid write conflicts when using PUT' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 414: - description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 415: - description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - - 416: - description: 'Range Not Satisfiable .' - 422: - description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - example: - application/problem+json: - problemDetails: - type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' - title: Too many targets - status: '422' - detail: The target area for the request is considered too large - instance: /meAppClient.example.com/77777/msgs/abc - 429: - description: 'Too Many Requests : used when a rate limiter has triggered.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' + examples: + - AppInstanceStateChange +security: +- {} +tags: +- name: app-lcm + description: App lifecycle management +- name: app-lcm-notifications + description: App lifecycle management notifications +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/MEC010-2_AppPkgMgmt.yaml b/MEC010-2_AppPkgMgmt.yaml index a3fe87d..b5a46fc 100644 --- a/MEC010-2_AppPkgMgmt.yaml +++ b/MEC010-2_AppPkgMgmt.yaml @@ -1,868 +1,1367 @@ +openapi: 3.1.0 info: - title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management" - version: 2.1.1 - description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI." - license: - name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' + title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' contact: name: ETSI Forge - email: cti_support@etsi.org url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api -externalDocs: - description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" - url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' + email: cti_support@etsi.org + version: '2.1.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - - url: 'https://localhost/app_pkgm/v1' -openapi: 3.0.0 -tags: - - name: app-pkgm - description: App Package management - - name: app-pkgm-notifications - description: App Package management notifications +- url: https://localhost/app_pkgm/v1 + variables: {} paths: /app_packages: post: tags: - - 'app-pkgm' - summary: 'Create a resource for on-boarding an application package to a MEO' - description: 'Create a resource for on-boarding an application package to a MEO' + - app-pkgm + summary: app_packagesPOST + description: Create a resource for on-boarding an application package to a MEO operationId: app_packagesPOST + parameters: [] requestBody: description: Resource to be created - required: true content: application/json: schema: $ref: '#/components/schemas/CreateAppPkg' + required: true responses: '201': description: Successful response for resource creation + headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AppPkgInfo' + description: '' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false get: tags: - - 'app-pkgm' - summary: 'Queries information relating to on-boarded application packages in the MEO' - description: 'queries information relating to on-boarded application packages in the MEO' + - app-pkgm + summary: app_packagesGET + description: queries information relating to on-boarded application packages in the MEO operationId: app_packagesGET parameters: - - in: query - name: filter - schema: - type: string - required: false - description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' - - in: query - name: all_fields - schema: - type: string - required: false - description: 'Include all complex attributes in the response.' - - in: query - name: fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be included into the response' - - in: query - name: exclude_fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be excluded from the response.' - - in: query - name: exclude_default - schema: - type: string - required: false - description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string responses: '200': - description: 'Contains a representation of the application package resource' + description: Contains a representation of the application package resource + headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AppPkgInfo' + description: '' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_packages/{appPkgId}: - parameters: - - in: path - name: appPkgId - schema: - type: string - required: true - description: 'Identifier of an individual application package resource' get: tags: - - 'app-pkgm' - summary: 'Queries the information related to individual application package resources' - description: 'Queries the information related to individual application package resources' + - app-pkgm + summary: app_packageGET + description: Queries the information related to individual application package resources operationId: app_packageGET + parameters: + - name: appPkgId + in: path + description: Identifier of an individual application package resource + required: true + style: simple + schema: + type: string responses: '200': - description: 'Contains a representation of the application package resource' + description: Contains a representation of the application package resource + headers: {} content: application/json: schema: $ref: '#/components/schemas/AppPkgInfo' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false delete: tags: - - 'app-pkgm' - summary: 'Deletes an individual application package resources' - description: 'Deletes an individual application package resources' + - app-pkgm + summary: app_packageDELETE + description: Deletes an individual application package resources operationId: app_packageDELETE + parameters: + - name: appPkgId + in: path + description: Identifier of an individual application package resource + required: true + style: simple + schema: + type: string responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false patch: tags: - - 'app-pkgm' - summary: 'Updates the operational state of an individual application package resource' - description: 'Updates the operational state of an individual application package resources' + - app-pkgm + summary: app_packagePATCH + description: Updates the operational state of an individual application package resources operationId: app_packagePATCH + parameters: + - name: appPkgId + in: path + description: Identifier of an individual application package resource + required: true + style: simple + schema: + type: string requestBody: description: Operational state to be set - required: true content: application/json: schema: $ref: '#/components/schemas/AppPkgInfoModifications' + required: true responses: '200': - description: 'Shows that the operation has been completed successfully' + description: Shows that the operation has been completed successfully + headers: {} content: application/json: schema: $ref: '#/components/schemas/AppPkgInfoModifications' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '409': - $ref: '#/components/responses/409' + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /subscriptions: post: tags: - - 'app-pkgm' - summary: 'Subscribe to notifications about on-boarding an application package' - description: 'Subscribe to notifications about on-boarding an application package' + - app-pkgm + summary: subscriptionsPOST + description: Subscribe to notifications about on-boarding an application package operationId: subscriptionsPOST + parameters: [] requestBody: - description: The input parameters of subscribe operation to notifications - required: true + description: The input parameters of subscribe operation to notifications content: application/json: schema: $ref: '#/components/schemas/AppPkgSubscription' - + required: true responses: '201': description: Successful response for created subscription + headers: {} content: application/json: schema: - $ref: '#/components/schemas/AppPkgSubscriptionInfo' + $ref: '#/components/schemas/AppPkgSubscriptionInfo' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - callbacks: - notification: - '{$request.body#/subscription.href}': - post: - summary: 'Callback POST used to send a notification' - description: ' The notification is triggered when a new application package is onboarded' - operationId: notificationPOST - requestBody: - description: Subscription notification - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgNotification' - responses: - '204': - $ref: '#/components/responses/204' - + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false get: tags: - - 'app-pkgm' - summary: 'used to retrieve the information of subscriptions to individual application package resource in MEO' - description: 'used to retrieve the information of subscriptions to individual application package resource in MEO package' + - app-pkgm + summary: subscriptionsGET + description: used to retrieve the information of subscriptions to individual application package resource in MEO package operationId: subscriptionsGET + parameters: [] responses: '200': - description: List of zero or more subscriptions + description: List of zero or more subscriptions + headers: {} content: application/json: schema: - $ref: '#/components/schemas/AppPkgSubscriptionLinkList' + $ref: '#/components/schemas/AppPkgSubscriptionLinkList' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - /subscriptions/{subscriptionId}: - parameters: - - in: path - name: subscriptionId - schema: - type: string - description: 'Identifier of an individual subscription to notifications about application package changes' - required: true + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions/{subscriptionId}: get: tags: - - 'app-pkgm' - summary: 'Used to represent an individual subscription to notifications about application package changes.' - description: 'Used to represent an individual subscription to notifications about application package changes.' + - app-pkgm + summary: individualSubscriptionGET + description: Used to represent an individual subscription to notifications about application package changes. operationId: individualSubscriptionGET + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual subscription to notifications about application package changes + required: true + style: simple + schema: + type: string responses: '200': - description: Representation of the resource. + description: Representation of the resource. + headers: {} content: application/json: schema: - $ref: '#/components/schemas/AppPkgSubscriptionInfo' + $ref: '#/components/schemas/AppPkgSubscriptionInfo' '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false delete: tags: - - 'app-pkgm' - summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' - description: 'Deletes the individual subscription to notifications about application package changes in MEO.' + - app-pkgm + summary: individualSubscriptionDELETE + description: Deletes the individual subscription to notifications about application package changes in MEO. operationId: individualSubscriptionDELETE - responses: - '204': - $ref: '#/components/responses/204' - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '429': - $ref: '#/components/responses/429' -############################################################################### -# Notification endpoint AppPkgNotification # -############################################################################### - /user_defined_notification: - post: - tags: - - 'app-pkgm-notifications' - summary: 'Registers a notification endpoint to notify application package operations' - description: 'Registers a notification endpoint to notify application package operations' - operationId: app_pkg_notificationPOST - requestBody: - description: Notification endpoint to be created + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual subscription to notifications about application package changes required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgNotification' + style: simple + schema: + type: string responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_packages/{appPkgId}/appd: - parameters: - - in: path - name: appPkgId - schema: - type: string - description: 'Identifier of an on-boarded individual application package' - required: true get: tags: - - 'app-pkgm' - summary: 'Reads the content of the AppD of on-boarded individual application package resources.' - description: 'Reads the content of the AppD of on-boarded individual application package resources.' + - app-pkgm + summary: appPkgIdGET + description: Reads the content of the AppD of on-boarded individual application package resources. operationId: appPkgIdGET parameters: - - in: query - name: filter - schema: - type: string - required: false - description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' - - in: query - name: all_fields - schema: - type: string - required: false - description: 'Include all complex attributes in the response.' - - in: query - name: fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be included into the response' - - in: query - name: exclude_fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be excluded from the response.' - - in: query - name: exclude_default - schema: - type: string - required: false - description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + - name: appPkgId + in: path + description: Identifier of an on-boarded individual application package + required: true + style: simple + schema: + type: string + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string responses: '200': - description: Content of the AppD is returned. + description: Content of the AppD is returned. + headers: {} content: text/plain: schema: - $ref: '#/components/schemas/AppD' + $ref: '#/components/schemas/AppD' application/zip: schema: - $ref: '#/components/schemas/AppD' + type: object + contentMediaType: application/zip '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /onboarded_app_packages/{appDId}/appd: - parameters: - - in: path - name: appDId - schema: - type: string - description: 'Identifier of an application descriptor' - required: true get: tags: - - 'app-pkgm' - summary: 'Reads the content of the AppD of on-boarded individual application package resources.' - description: 'Reads the content of the AppD of on-boarded individual application package resources.' + - app-pkgm + summary: appDGET + description: Reads the content of the AppD of on-boarded individual application package resources. operationId: appDGET parameters: - - in: query - name: filter - schema: - type: string - required: false - description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' - - in: query - name: all_fields - schema: - type: string - required: false - description: 'Include all complex attributes in the response.' - - in: query - name: fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be included into the response' - - in: query - name: exclude_fields - schema: - type: string - required: false - description: 'Complex attributes of AppPkgInfo to be excluded from the response.' - - in: query - name: exclude_default - schema: - type: string - required: false - description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + - name: appDId + in: path + description: Identifier of an application descriptor + required: true + style: simple + schema: + type: string + - name: filter + in: query + description: Attribute-based filtering parameters according to ETSI GS MEC 009 + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes of AppPkgInfo to be included into the response + style: form + explode: true + schema: + type: string + - name: exclude_fields + in: query + description: Complex attributes of AppPkgInfo to be excluded from the response. + style: form + explode: true + schema: + type: string + - name: exclude_default + in: query + description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. + style: form + explode: true + schema: + type: string responses: '200': - description: Content of the AppD is returned. + description: Content of the AppD is returned. + headers: {} content: text/plain: schema: - $ref: '#/components/schemas/AppD' + $ref: '#/components/schemas/AppD' application/zip: schema: - $ref: '#/components/schemas/AppD' + type: object + contentMediaType: application/zip '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /app_packages/{appPkgId}/package_content: - parameters: - - in: path - name: appPkgId - schema: - type: string - description: 'Identifier of an on-boarded individual application package' - required: true get: tags: - - 'app-pkgm' - summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.' - description: 'Fetch the onboarded application package content identified by appPkgId or appDId.' + - app-pkgm + summary: appPkgGET + description: Fetch the onboarded application package content identified by appPkgId or appDId. operationId: appPkgGET + parameters: + - name: appPkgId + in: path + description: Identifier of an on-boarded individual application package + required: true + style: simple + schema: + type: string responses: '200': - $ref: '#/components/responses/AppPkgContent.200' + description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. + headers: {} + content: {} '206': - $ref: '#/components/responses/206' + description: Partial content + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '416': - $ref: '#/components/responses/416' + description: Range Not Satisfiable . + headers: {} + content: {} '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false put: tags: - - 'app-pkgm' - summary: 'Uploads the content of application package.' - description: 'Uploads the content of application package.' + - app-pkgm + summary: appPkgPUT + description: Uploads the content of application package. operationId: appPkgPUT + parameters: + - name: appPkgId + in: path + description: Identifier of an on-boarded individual application package + required: true + style: simple + schema: + type: string requestBody: + description: '' content: - application/zip: + text/plain: schema: - type: string - format: binary + type: object + contentMediaType: text/plain + required: false responses: '202': - description: 'The application package has been accepted for uploading, but the processing has not been completed.' + description: The application package has been accepted for uploading, but the processing has not been completed. + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '409': - $ref: '#/components/responses/409' + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /onboarded_app_packages/{appDId}/package_content: - parameters: - - in: path - name: appDId - description: 'Identifier of an application descriptor' - schema: - type: string - required: true get: tags: - - 'app-pkgm' - summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.' - description: 'Fetch the onboarded application package content identified by appPkgId or appDId.' + - app-pkgm + summary: appDIdGET + description: Fetch the onboarded application package content identified by appPkgId or appDId. operationId: appDIdGET + parameters: + - name: appDId + in: path + description: Identifier of an application descriptor + required: true + style: simple + schema: + type: string responses: '200': - $ref: '#/components/responses/AppPkgContent.200' + description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. + headers: {} + content: {} '206': - $ref: '#/components/responses/206' + description: Partial content + headers: {} + content: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '416': + description: Range Not Satisfiable . + headers: {} + content: {} + '406': + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + put: + tags: + - app-pkgm + summary: appDIdPUT + description: Uploads the content of application package. + operationId: appDIdPUT + parameters: + - name: appDId + in: path + description: Identifier of an application descriptor + required: true + style: simple + schema: + type: string + requestBody: + description: '' + content: + text/plain: + schema: + type: object + contentMediaType: text/plain + required: false + responses: + '202': + description: The application package has been accepted for uploading, but the processing has not been completed. + headers: {} + content: {} + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' - '416': - $ref: '#/components/responses/416' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' - put: + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /user_defined_notification: + post: tags: - - 'app-pkgm' - summary: 'Uploads the content of application package.' - description: 'Uploads the content of application package.' - operationId: appDIdPUT + - app-pkgm-notifications + summary: app_pkg_notificationPOST + description: Registers a notification endpoint to notify application package operations + operationId: app_pkg_notificationPOST + parameters: [] requestBody: + description: Notification endpoint to be created content: - application/zip: + application/json: schema: - type: string - format: binary + $ref: '#/components/schemas/AppPkgNotification' + required: true responses: - '202': - description: 'The application package has been accepted for uploading, but the processing has not been completed.' - '400': - $ref: '#/components/responses/400' + '204': + description: No Content + headers: {} + content: {} '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' - '406': - $ref: '#/components/responses/406' - '409': - $ref: '#/components/responses/409' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] components: schemas: - Algorithm: - description: " Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512." - type: string AppD: + title: AppD + required: + - appDId + - appDVersion + - appDescription + - appName + - appProvider + - appSoftVersion + - mecVersion + - swImageDescriptor + - virtualComputeDescriptor + type: object properties: appDId: - description: "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note\_1." type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1. appDNSRule: - description: Describes DNS rules the MEC application requires. - items: - $ref: '#/components/schemas/DNSRuleDescriptor' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: DNSRuleDescriptor + items: + $ref: '#/components/schemas/DNSRuleDescriptor' + description: Describes DNS rules the MEC application requires. appDVersion: - description: Identifies the version of the application descriptor. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifies the version of the application descriptor. appDescription: - description: Human readable description of the MEC application. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Human readable description of the MEC application. appExtCpd: - description: Describes external interface(s) exposed by this MEC application. + minItems: 0 + type: array items: $ref: '#/components/schemas/AppExternalCpd' + description: Describes external interface(s) exposed by this MEC application. + appFeatureOptional: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: AppExternalCpd - appFeatureOptional: - description: Describes features a MEC application may use if available. items: $ref: '#/components/schemas/FeatureDependency' + description: Describes features a MEC application may use if available. + appFeatureRequired: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: FeatureDependency - appFeatureRequired: - description: Describes features a MEC application requires to run. items: $ref: '#/components/schemas/FeatureDependency' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: FeatureDependency + description: Describes features a MEC application requires to run. appInfoName: - description: Human readable name for the MEC application. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Human readable name for the MEC application. appLatency: - # description': Describes the maximum latency tolerated by the MEC application. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': LatencyDescriptor $ref: '#/components/schemas/LatencyDescriptor' appName: - description: Name to identify the MEC application. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Name to identify the MEC application. appProvider: - description: Provider of the application and of the AppD. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Provider of the application and of the AppD. appServiceOptional: - description: Describes services a MEC application may use if available. + minItems: 0 + type: array items: $ref: '#/components/schemas/ServiceDependency' + description: Describes services a MEC application may use if available. + appServiceProduced: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: ServiceDependency - appServiceProduced: - description: Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps. items: $ref: '#/components/schemas/ServiceDescriptor' + description: Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps. + appServiceRequired: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: ServiceDescriptor - appServiceRequired: - description: Describes services a MEC application requires to run. items: $ref: '#/components/schemas/ServiceDependency' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: ServiceDependency + description: Describes services a MEC application requires to run. appSoftVersion: - description: Identifies the version of software of the MEC application. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifies the version of software of the MEC application. appTrafficRule: - description: Describes traffic rules the MEC application requires. - items: - $ref: '#/components/schemas/TrafficRuleDescriptor' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: TrafficRuleDescriptor + items: + $ref: '#/components/schemas/TrafficRuleDescriptor' + description: Describes traffic rules the MEC application requires. changeAppInstanceStateOpConfig: - # description': Configuration parameters for the change application instance state operation. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ChangeAppInstanceStateOpConfig - $ref: '#/components/schemas/ChangeAppInstanceStateOpConfig' + type: string + description: NFV mecVersion: - description: Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. - items: - type: string minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String + items: + type: string + description: Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. swImageDescriptor: - # description': Describes the software image which is directly loaded on the virtualisation machine instantiating this Application. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': SwImageDescriptor - $ref: '#/components/schemas/SwImageDescriptor' + type: string + description: Ref NFV terminateAppInstanceOpConfig: - # description': Configuration parameters for the Terminate application instance operation. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TerminateAppInstanceOpConfig - $ref: '#/components/schemas/TerminateAppInstanceOpConfig' + type: string + description: NFV transportDependencies: - description: Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2. - items: - $ref: '#/components/schemas/TransportDependency' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: TransportDependency + items: + $ref: '#/components/schemas/TransportDependency' + description: Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2. virtualComputeDescriptor: - # description': Describes CPU, Memory and acceleration requirements of the virtual machine. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': VirtualComputeDescription - $ref: '#/components/schemas/VirtualComputeDescription' + type: string + description: Ref NFV virtualStorageDescriptor: - description: Defines descriptors of virtual storage resources to be used by the MEC application. - items: - $ref: '#/components/schemas/VirtualStorageDescriptor' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: VirtualStorageDescriptor + items: + type: string + description: Defines descriptors of virtual storage resources to be used by the MEC application. + AppExternalCpd: + title: AppExternalCpd required: - - appDId - - appName - - appProvider - - appSoftVersion - - appDVersion - - mecVersion - - appDescription - - virtualComputeDescriptor - - swImageDescriptor + - inherited_attributes type: object - x-etsi-notes: "NOTE 1:\tThe appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2:\tThis attribute indicates groups of transport bindings which a service-producing MEC application requires to be supported by the platform in order to be able to produce its services. At least one of the indicated groups needs to be supported to fulfil the requirements." - x-etsi-ref: 6.2.1.2 - AppExternalCpd: properties: inherited_attributes: - description: All attributes inherited from Cpd. type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: inherited_attributes + description: All attributes inherited from Cpd. virtualNetworkInterfaceRequirements: - description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. - items: - $ref: '#/components/schemas/VirtualNetworkInterfaceRequirements' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - #x-etsi-mec-origin-type: VirtualNetworkInterfaceRequirements - required: - - inherited_attributes - type: object - x-etsi-ref: 6.2.1.6 - CallbackUri: - description: >- - The URI of the endpoint for the notification to be sent to. - type: string - format: uri - AppDId: - description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.' - type: string - AppProvider: - description: 'Provider of the application and of the AppD.' - type: string - AppName: - description: 'Name to identify the MEC application.' - type: string - AppDVersion: - description: 'Identifies the version of the application descriptor.' - type: string - AppPkgId: - description: Identifier of the onboarded application package. - type: string - SubscriptionId: - description: >- - Identifier of the subscription related to this notification. - type: string - AppPkgArtifactInfo: - description: Additional information of application package artifacts that are not application software images. Type is TBD + items: + type: string + description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. AppPkgInfo: - description: >- - 'The data type AppPkgInfo represents the parameters for an application package resource' - type: object + title: AppPkgInfo required: - - id - - appDId - - appName - - appSoftwareVersion - - appDVersion - - checksum - - softwareImages - - onboardingState - - operationalState - - usageState - - _links + - id + - appDId + - appName + - appSoftwareVersion + - appDVersion + - checksum + - softwareImages + - onboardingState + - operationalState + - usageState + - _links + type: object properties: id: - $ref: '#/components/schemas/AppPkgId' + type: string + description: Identifier of the onboarded application package. appDId: - $ref: '#/components/schemas/AppDId' + type: string + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. appProvider: - $ref: '#/components/schemas/AppProvider' + type: string + description: Provider of the application and of the AppD. appName: - $ref: '#/components/schemas/AppName' + type: string + description: Name to identify the MEC application. appSoftwareVersion: - $ref: '#/components/schemas/AppSoftwareVersion' + type: string + description: Software version of the application. This is updated when there is any change to the software in the onboarded application package. appDVersion: - $ref: '#/components/schemas/AppDVersion' + type: string + description: Identifies the version of the application descriptor. checksum: $ref: '#/components/schemas/Checksum' softwareImages: - $ref: '#/components/schemas/AppPkgSWImageInfo' + type: object + description: Information of application software image in application package. Type is TBD additionalArtifacts: - $ref: '#/components/schemas/AppPkgArtifactInfo' + type: object + description: Additional information of application package artifacts that are not application software images. Type is TBD onboardingState: $ref: '#/components/schemas/OnboardingState' operationalState: @@ -870,63 +1369,56 @@ components: usageState: $ref: '#/components/schemas/UsageState' userDefinedData: - $ref: '#/components/schemas/KeyValuePairs' + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" _links: $ref: '#/components/schemas/AppPkgInfo.links' + description: "'The data type AppPkgInfo represents the parameters for an application package resource'" AppPkgInfoModifications: - description: >- - 'The data type represents the operational state for an application package resource' + title: AppPkgInfoModifications + required: + - operationState type: object - required: - - operationState properties: operationState: - type: string - enum: - - DISABLED - - ENABLED - AppSoftwareVersion: - description: >- - Software version of the application. This is updated when there is any change to the software in the onboarded application package. - type: string + $ref: '#/components/schemas/OperationState' + description: "'The data type represents the operational state for an application package resource'" AppPkg.OperationalState: - description: >- - Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests. - type: string + title: AppPkg.OperationalState enum: - - ENABLED - - DISABLED - OnboardingState: - description: >- - Onboarding state of application package + - ENABLED + - DISABLED type: string - format: enum + description: 'Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.' + examples: + - ENABLED + OnboardingState: + title: OnboardingState enum: - - CREATED - - UPLOADING - - PROCESSING - - ONBOARDED - UsageState: - description: >- - Usage state of the onboarded instance of the application package + - CREATED + - UPLOADING + - PROCESSING + - ONBOARDED type: string - format: enum + description: Onboarding state of application package + examples: + - CREATED + UsageState: + title: UsageState enum: - - IN_USE - - NOT_IN_USE - KeyValuePairs: - description: >- - 'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259' - type: object - additionalProperties: true + - IN_USE + - NOT_IN_USE + type: string + description: Usage state of the onboarded instance of the application package + examples: + - IN_USE AppPkgInfo.links: - description: >- - Links to resources related to this resource. - type: object + title: AppPkgInfo.links required: - - self - - appD - - appPkgContent + - self + - appD + - appPkgContent + type: object properties: self: $ref: '#/components/schemas/LinkType' @@ -934,117 +1426,114 @@ components: $ref: '#/components/schemas/LinkType' appPkgContent: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. AppPkgNotification: - description: >- - 'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded' - type: object + title: AppPkgNotification required: - - id - - notificationType - - subscriptionId - - timeStamp - - appPkgId - - appDId - - operationalState - - _links + - id + - notificationType + - subscriptionId + - timeStamp + - appPkgId + - appDId + - operationalState + - _links + type: object properties: id: - $ref: '#/components/schemas/AppPkgNotification.Id' + type: string + description: "''" notificationType: $ref: '#/components/schemas/AppPkg.NotificationType' subscriptionId: - $ref: '#/components/schemas/SubscriptionId' + type: string + description: Identifier of the subscription related to this notification. timeStamp: $ref: '#/components/schemas/TimeStamp' appPkgId: - $ref: '#/components/schemas/AppPkgId' + type: string + description: Identifier of the onboarded application package. appDId: - $ref: '#/components/schemas/AppDId' - operationalState: type: string - enum: - - DISABLED - - ENABLED + description: Identifier of this MEC application descriptor. This attribute shall be globally unique. + operationalState: + $ref: '#/components/schemas/OperationalState' _links: $ref: '#/components/schemas/AppPkgNotification.links' - AppPkgNotification.Id: - description: >- - '' - type: string + description: "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'" AppPkg.NotificationType: - description: >- - Discriminator for the different notification types - type: string + title: AppPkg.NotificationType enum: - - AppPackageOnBoarded - - AppPacakgeEnabled - - AppPacakgeDisabled - - AppPackageDeleted + - AppPackageOnBoarded + - AppPacakgeEnabled + - AppPacakgeDisabled + - AppPackageDeleted + type: string + description: Discriminator for the different notification types + examples: + - AppPackageOnBoarded AppPkgNotification.links: - description: >- - Links to resources related to this resource. - type: object + title: AppPkgNotification.links required: - - subscription + - subscription + type: object properties: subscription: $ref: '#/components/schemas/LinkType' - AppPkgSWImageInfo: - description: Information of application software image in application package. Type is TBD + description: Links to resources related to this resource. AppPkgSubscriptionInfo: - description: >- - 'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package' - type: object + title: AppPkgSubscriptionInfo required: - - id - - subscriptionType - - callbackUri - - _links + - id + - subscriptionType + - callbackUri + - _links + type: object properties: id: - $ref: '#/components/schemas/AppPkgSubscriptionInfo.Id' + type: string + description: "''" subscriptionType: $ref: '#/components/schemas/AppPkg.SubscriptionType' callbackUri: - $ref: '#/components/schemas/CallbackUri' + type: string + description: The URI of the endpoint for the notification to be sent to. _links: $ref: '#/components/schemas/AppPkgSubscriptionInfo.links' - AppPkgSubscriptionInfo.Id: - description: >- - '' - type: string + description: "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'" AppPkg.SubscriptionType: - description: >- - Subscribed notification type. - type: string + title: AppPkg.SubscriptionType enum: - - AppPackageOnBoarding - - AppPacakgeOperationChange - - AppPackageDeletion + - AppPackageOnBoarding + - AppPacakgeOperationChange + - AppPackageDeletion + type: string + description: Subscribed notification type. + examples: + - AppPackageOnBoarding AppPkgSubscriptionInfo.links: - description: >- - Links to resources related to this resource. - type: object + title: AppPkgSubscriptionInfo.links required: - - self + - self + type: object properties: self: $ref: '#/components/schemas/LinkType' + description: Links to resources related to this resource. AppPkgSubscriptionLinkList: - description: >- - 'The data type represents a subscription link list of notification on application package management' - type: object + title: AppPkgSubscriptionLinkList required: - - _links + - _links + type: object properties: _links: $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links' + description: "'The data type represents a subscription link list of notification on application package management'" AppPkgSubscriptionLinkList.links: - description: >- - Links to resources related to this resource. - type: object + title: AppPkgSubscriptionLinkList.links required: - - self + - self + type: object properties: self: $ref: '#/components/schemas/LinkType' @@ -1052,725 +1541,506 @@ components: type: array items: $ref: '#/components/schemas/Subscriptions.AppPkgSubscription' + description: '' + description: Links to resources related to this resource. Subscriptions.AppPkgSubscription: - description: >- - 'The data type represents the input parameters of "subscription operation" to notification of application package management for the onboarding, or operational state change of application package.' - type: object + title: Subscriptions.AppPkgSubscription required: - - href - - subsctiptionType + - href + - subsctiptionType + type: object properties: href: - $ref: '#/components/schemas/Href' + type: string + description: The URI referring to the subscription. subsctiptionType: $ref: '#/components/schemas/SubsctiptionType.AppPkg' - Href: - description: >- - The URI referring to the subscription. - type: string - format: uri + description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" AppPkgSubscription: - description: >- - 'The data type represents the input parameters of "subscription operation" to notification of application package management for the onboarding, or operational state change of application package.' - type: object + title: AppPkgSubscription required: - - callbackUri - - subsctiptionType + - callbackUri + - subsctiptionType + type: object properties: callbackUri: - $ref: '#/components/schemas/CallbackUri' + type: string + description: The URI of the endpoint for the notification to be sent to. subsctiptionType: - $ref: '#/components/schemas/SubsctiptionType.AppPkg' + $ref: '#/components/schemas/SubsctiptionType.AppPkg' appPkgFilter: type: array items: - $ref: '#/components/schemas/AppPkgFilter' + type: string + description: '' + description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" SubsctiptionType.AppPkg: - description: >- - 'Subscribed notification type' - type: string + title: SubsctiptionType.AppPkg enum: - - AppPackageOnBoarding - - AppPacakgeOperationChange - - AppPackageDeletion - AppPkgFilter: - type: string - description: >- - The attribute-based filter is to filter application packages on which the query applies. - ChangeAppInstanceStateOpConfig: - description: NFV + - AppPackageOnBoarding + - AppPacakgeOperationChange + - AppPackageDeletion type: string + description: "'Subscribed notification type'" + examples: + - AppPackageOnBoarding Checksum: - description: '' - properties: - algorithm: - $ref: '#/components/schemas/Algorithm' - hash: - $ref: '#/components/schemas/Hash' + title: Checksum required: - algorithm - hash type: object + properties: + algorithm: + type: string + description: Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. + hash: + type: string + description: "'String 1 The hexadecimal value of the checksum'" CreateAppPkg: + title: CreateAppPkg + required: + - appPkgName + - appPkgPath + - appPkgVersion + - checksum + type: object properties: appPkgName: - description: Name of the application package to be onboarded. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Name of the application package to be onboarded. appPkgPath: - # description': Address information of the application package. See note. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': Uri - $ref: '#/components/schemas/URI' + type: string appPkgVersion: - description: 'Version of the application package to be onboarded. - - The appPkgName with appPkgVersion can be used to uniquely identify the application package.' type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: >- + Version of the application package to be onboarded. + + The appPkgName with appPkgVersion can be used to uniquely identify the application package. appProvider: - description: The provider's name of the application package to be onboarded. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: The provider's name of the application package to be onboarded. checksum: - # description': Checksum of the onboarded application package. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': Checksum $ref: '#/components/schemas/Checksum' userDefinedData: - #description: User defined data for the application package. - #type: object - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: KeyValuePair - $ref: '#/components/schemas/KeyValuePairs' + type: object + description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" + DNSRuleDescriptor: + title: DNSRuleDescriptor required: - - appPkgName - - appPkgVersion - - checksum - - appPkgPath + - dnsRuleId + - domainName + - ipAddress + - ipAddressType type: object - x-etsi-notes: "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7]." - x-etsi-ref: 6.2.3.2 - DNSRuleDescriptor: properties: dnsRuleId: - description: Identifies the DNS Rule type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Identifies the DNS Rule domainName: - description: FQDN of the DNS rule type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: FQDN of the DNS rule ipAddress: - description: IP address given by the DNS rule type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: IP address given by the DNS rule ipAddressType: - #description: 'Specifies the IP address type, value: IP_V6, IP_V4' - #type: string - #x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/IpAddressType' ttl: - description: Time-to-live value type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Int - required: - - dnsRuleId - - domainName - - ipAddressType - - ipAddress - type: object - x-etsi-ref: 6.2.1.13 + description: Time-to-live value + contentEncoding: int32 IpAddressType: - description: 'Specifies the IP address type' - type: string + title: IpAddressType enum: - - IP_V6 - - IP_V4 + - IP_V6 + - IP_V4 + type: string + description: Specifies the IP address type + examples: + - IP_V6 FeatureDependency: + title: FeatureDependency + required: + - featureName + - version + type: object properties: featureName: - description: The name of the feature, for example, UserApps, UEIdentity, etc. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The name of the feature, for example, UserApps, UEIdentity, etc. version: - description: The version of the feature. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The version of the feature. + InterfaceDescriptor: + title: InterfaceDescriptor required: - - featureName - - version + - interfaceType type: object - x-etsi-ref: 6.2.1.8 - Hash: - description: '''String 1 The hexadecimal value of the checksum''' - type: string - InterfaceDescriptor: properties: dstIPAddress: - description: If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface. dstMACAddress: - description: If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface. interfaceType: - #description: 'Type of interface: TUNNEL, MAC, IP, etc.' $ref: '#/components/schemas/InterfaceType' - #x-etsi-mec-cardinality: '1' srcMACAddress: - description: If the interface type is MAC, the source address identifies the MAC address of the interface. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: If the interface type is MAC, the source address identifies the MAC address of the interface. tunnelInfo: - # description': Included only if the destination address type is tunnel. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TunnelInfo $ref: '#/components/schemas/TunnelInfo' - required: - - interfaceType - type: object - x-etsi-ref: 6.2.1.11 InterfaceType: - description: 'Type of interface.' - type: string + title: InterfaceType enum: - - TUNNEL - - MAC - - IP + - TUNNEL + - MAC + - IP + type: string + description: Type of interface. + examples: + - TUNNEL LatencyDescriptor: + title: LatencyDescriptor + required: + - maxLatency + type: object properties: maxLatency: - description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note. - format: Uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note. + contentEncoding: int32 + LinkType: + title: LinkType required: - - maxLatency + - href type: object - x-etsi-notes: "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance)." - x-etsi-ref: 6.2.1.14 - LinkType: properties: href: - description: URI referring to a resource - format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - required: - - href - type: object - x-etsi-ref: 6.5.2 + description: URI referring to a resource ProblemDetails: + title: ProblemDetails + type: object properties: detail: - description: A human-readable explanation specific to this occurrence of the problem type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: A human-readable explanation specific to this occurrence of the problem instance: - description: A URI reference that identifies the specific occurrence of the problem - format: uri type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI + description: A URI reference that identifies the specific occurrence of the problem status: - description: The HTTP status code for this occurrence of the problem - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 title: - description: A short, human-readable summary of the problem type type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: A short, human-readable summary of the problem type type: - description: A URI reference according to IETF RFC 3986 that identifies the problem type - format: uri type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - type: object - SerializerTypes: - type: string + description: A URI reference according to IETF RFC 3986 that identifies the problem type ServiceDependency: + title: ServiceDependency + required: + - serName + - version + type: object properties: requestedPermissions: - description: 'Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4]. - - The format of this attribute is left for the data model design stage.' - items: - $ref: '#/components/schemas/Not_specified' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Not_specified + items: + type: string + description: >- + Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4]. + + The format of this attribute is left for the data model design stage. serCategory: - # description': A Category reference of the service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': CategoryRef - $ref: '#/components/schemas/CategoryRef' + type: object + description: See MEC011 serName: - description: The name of the service, for example, RNIS, LocationService, etc. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The name of the service, for example, RNIS, LocationService, etc. serTransportDependencies: - description: Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note. - items: - $ref: '#/components/schemas/TransportDependency' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: TransportDependency + items: + $ref: '#/components/schemas/TransportDependency' + description: Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note. version: - description: The version of the service. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The version of the service. + ServiceDescriptor: + title: ServiceDescriptor required: - serName - version type: object - x-etsi-notes: "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application." - x-etsi-ref: 6.2.1.17 - ServiceDescriptor: - description: >- - 'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.' - type: object - required: - - serName - - version properties: serName: - $ref: '#/components/schemas/SerName' + type: string + description: The name of the service, for example, RNIS, LocationService, etc. serCategory: - $ref: '#/components/schemas/CategoryRef' + type: object + description: See MEC011 version: - $ref: '#/components/schemas/SerVersion' + type: string + description: The version of the service. transportsSupported: $ref: '#/components/schemas/TransportsSupported' - SerName: - description: 'The name of the service, for example, RNIS, LocationService, etc.' - type: string - SerVersion: - description: The version of the service. - type: string + description: "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'" TransportsSupported: - description: >- - 'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.' + title: TransportsSupported type: object - required: - - featureName - - version properties: transport: $ref: '#/components/schemas/TransportDescriptor' serializers: - $ref: '#/components/schemas/Serializers' - Serializers: - description: >- - 'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 ' - type: array - minItems: 1 - items: - $ref: '#/components/schemas/SerializerTypes' - SwImageDescriptor: - description: Ref NFV - type: string - TerminateAppInstanceOpConfig: - description: NFV - type: string - x-etsi-ref: 6.2.2.9 + minItems: 1 + type: array + items: + type: string + description: "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '" + description: "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'" TimeStamp: + title: TimeStamp + required: + - nanoSeconds + - seconds + type: object properties: nanoSeconds: - description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - format: Uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 seconds: - description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC." - format: Uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - required: - - seconds - - nanoSeconds - type: object - x-etsi-ref: 6.2.5.4 + description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 TrafficFilter: + title: TrafficFilter + type: object properties: dSCP: - description: Used to match all IPv4 packets that have the same DSCP. type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Int + description: Used to match all IPv4 packets that have the same DSCP. + contentEncoding: int32 dstAddress: - description: 'A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.' - items: - type: string minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - dstPort: - description: A port or a range of ports. items: type: string + description: A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes. + dstPort: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - dstTunnelPort: - description: Used for GTP tunnel based traffic rule. items: type: string + description: A port or a range of ports. + dstTunnelPort: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - protocol: - description: Specify the protocol of the traffic filter. items: type: string + description: Used for GTP tunnel based traffic rule. + protocol: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String + items: + type: string + description: Specify the protocol of the traffic filter. qCI: - description: Used to match all packets that have the same QCI. type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Int + description: Used to match all packets that have the same QCI. + contentEncoding: int32 srcAddress: - description: 'An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.' - items: - type: string minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - srcPort: - description: A port or a range of ports. items: type: string + description: An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes. + srcPort: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - srcTunnelAddress: - description: Used for GTP tunnel based traffic rule. items: type: string + description: A port or a range of ports. + srcTunnelAddress: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - srcTunnelPort: - description: Used for GTP tunnel based traffic rule. items: type: string + description: Used for GTP tunnel based traffic rule. + srcTunnelPort: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String + items: + type: string + description: Used for GTP tunnel based traffic rule. tC: - description: Used to match all IPv6 packets that have the same TC. type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Int + description: Used to match all IPv6 packets that have the same TC. + contentEncoding: int32 tag: - description: Used for tag based traffic rule. - items: - type: string minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - tgtTunnelAddress: - description: Used for GTP tunnel based traffic rule. items: type: string + description: Used for tag based traffic rule. + tgtTunnelAddress: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - type: object - x-etsi-ref: 6.2.1.10 + items: + type: string + description: Used for GTP tunnel based traffic rule. TrafficRuleDescriptor: + title: TrafficRuleDescriptor + required: + - action + - filterType + - priority + - trafficFilter + - trafficRuleId + type: object properties: action: - #description: 'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter, the example actions includes: DROP, FORWARD_DECAPSULATED, FORWARD_AS_IS, PASSTHROUGH, DUPLICATED_DECAPSULATED, DUPLICATE_AS_IS.' - # type: string - #x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/Action' dstInterface: - # description': Describes the destination interface information, if the action is FORWARD. Some applications (e.g. inline/tap) require two interfaces, where the first is on the UE side and the second is on the EPC side. - # x-etsi-mec-cardinality': 0..2 - # x-etsi-mec-origin-type': InterfaceDescriptor - type: array - minItems: 0 maxItems: 2 + minItems: 0 + type: array items: - $ref: '#/components/schemas/InterfaceDescriptor' + $ref: '#/components/schemas/InterfaceDescriptor' + description: '' filterType: - #description: 'Definition of filter type: per FLOW or PACKET If it is per FLOW, the filter matches UE->EPC packets and the reverse packets are handled by the same context.' - #x-etsi-mec-cardinality: '1' $ref: '#/components/schemas/FilterType' priority: - description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence. type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Int + description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence. + contentEncoding: int32 trafficFilter: - description: The filter used to identify specific flow/packets that need to be handled by the MEC host. - items: - $ref: '#/components/schemas/TrafficFilter' minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: TrafficFilter + items: + $ref: '#/components/schemas/TrafficFilter' + description: The filter used to identify specific flow/packets that need to be handled by the MEC host. trafficRuleId: - description: Identifies the traffic rule. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - trafficRuleId - - filterType - - priority - - trafficFilter - - action - type: object - x-etsi-ref: 6.2.1.9 + description: Identifies the traffic rule. Action: - description: >- - 'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.' - type: string + title: Action enum: - - DROP - - FORWARD_DECAPSULATED - - FORWARD_AS_IS - - PASSTHROUGH - - DUPLICATED_DECAPSULATED - - DUPLICATE_AS_IS - FilterType: - description: 'Definition of filter type: per FLOW or PACKET' + - DROP + - FORWARD_DECAPSULATED + - FORWARD_AS_IS + - PASSTHROUGH + - DUPLICATED_DECAPSULATED + - DUPLICATE_AS_IS type: string + description: "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'" + examples: + - DROP + FilterType: + title: FilterType enum: - - FLOW - - PACKET + - FLOW + - PACKET + type: string + description: 'Definition of filter type: per FLOW or PACKET' + examples: + - FLOW TransportDependency: + title: TransportDependency + required: + - labels + - serializers + - transport + type: object properties: labels: - description: Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table. - items: - type: string minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - serializers: - description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport. items: - $ref: '#/components/schemas/SerializerTypes' + type: string + description: Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table. + serializers: minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: SerializerTypes + items: + type: string + description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport. transport: - # description': Information about the transport in this transport binding. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': TransportDescriptor $ref: '#/components/schemas/TransportDescriptor' + TransportDescriptor: + title: TransportDescriptor required: - - transport - - serializers - - labels + - protocol + - security + - type + - version type: object - x-etsi-ref: 6.2.1.18 - TransportDescriptor: properties: protocol: - description: The name of the protocol used. Shall be set to HTTP for a REST API. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The name of the protocol used. Shall be set to HTTP for a REST API. security: - # description': Information about the security used by the transport in ETSI GS MEC 011 [i.4]. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': SecurityInfo - $ref: '#/components/schemas/SecurityInfo' + type: object + description: See MEC011 type: - # description': Type of the transport, as defined in the TransportTypes type in ETSI GS MEC 011 [i.4]. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': TransportTypes - $ref: '#/components/schemas/TransportTypes' + type: string version: - description: The version of the protocol used. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: The version of the protocol used. + TunnelInfo: + title: TunnelInfo required: - - type - - protocol - - version - - security + - tunnelDstAddress + - tunnelSrcAddress + - tunnelType type: object - x-etsi-ref: 6.2.1.19 - TransportTypes: - type: string - TunnelInfo: properties: tunnelDstAddress: - description: Destination address of the tunnel. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Destination address of the tunnel. tunnelSpecificData: - #description: Parameters specific to the tunnel. - #type: object - #x-etsi-mec-cardinality: 0..1 - #x-etsi-mec-origin-type: Not_specified - $ref: '#/components/schemas/Not_specified' + type: string tunnelSrcAddress: - description: Source address of the tunnel. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Source address of the tunnel. tunnelType: - #description: 'Type of tunnel: GTP-U, GRE, etc.' $ref: '#/components/schemas/TunnelType' - #x-etsi-mec-cardinality: '1' - required: - - tunnelType - - tunnelDstAddress - - tunnelSrcAddress - type: object - x-etsi-ref: 6.2.1.12 TunnelType: - description: 'Type of tunnel.' - type: string + title: TunnelType enum: - - GTP-U - - GRE - VirtualComputeDescription: - description: Ref NFV - type: string - VirtualNetworkInterfaceRequirements: - type: string - VirtualStorageDescriptor: - description: Ref NFV + - GTP-U + - GRE type: string - SecurityInfo: - description: 'See MEC011' - CategoryRef: - description: 'See MEC011' - URI: + description: Type of tunnel. + examples: + - GTP-U + OperationalState: + title: OperationalState + enum: + - DISABLED + - ENABLED type: string - Not_specified: + examples: + - DISABLED + OperationState: + title: OperationState + enum: + - DISABLED + - ENABLED type: string - - responses: - 204: - description: No Content - 206: - description: Partial content - 400: - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 401: - description: 'Unauthorized : used when the client did not submit credentials.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 403: - description: 'Forbidden : operation is not allowed given the current status of the resource.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 404: - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 406: - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 409: - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 412: - description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 414: - description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - 415: - description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - - 416: - description: 'Range Not Satisfiable .' - 422: - description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - example: - application/problem+json: - problemDetails: - type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' - title: Too many targets - status: '422' - detail: The target area for the request is considered too large - instance: /meAppClient.example.com/77777/msgs/abc - 429: - description: 'Too Many Requests : used when a rate limiter has triggered.' - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - AppPkgContent.200: - description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. + examples: + - DISABLED +security: +- {} +tags: +- name: app-pkgm + description: App Package management +- name: app-pkgm-notifications + description: App Package management notifications +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml deleted file mode 100644 index 3e2a75f..0000000 --- a/OAS3.1.0/MEC010-2_AppGrant.yaml-OpenApi31Yaml.yaml +++ /dev/null @@ -1,657 +0,0 @@ -openapi: 3.1.0 -info: - title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' - contact: - name: ETSI Forge - url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api - email: cti_support@etsi.org - version: '2.1.1' -jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema -servers: -- url: https://localhost/granting/v1 - variables: {} -paths: - /grants: - post: - tags: - - granting - summary: grantPOST - description: requests a grant for a particular application lifecycle operation - operationId: grantPOST - parameters: [] - requestBody: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/GrantRequest' - required: true - responses: - '201': - description: grant was created successfully (synchronous mode) - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/Grant' - '202': - description: the request was accepted for processing - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /grants/{grantId}: - get: - tags: - - granting - summary: GrantGET - description: read the grant - operationId: GrantGET - parameters: - - name: grantId - in: path - description: Identifier of the individual grant. - required: true - style: simple - schema: - type: string - responses: - '200': - description: IA representation of the "individual grant" resource - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/Grant' - '202': - description: returned when the process of creating the grant is ongoing, no grant is available yet - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] -components: - schemas: - AppExtCpConfig: - title: AppExtCpConfig - type: object - properties: - cpInstanceId: - type: string - description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created." - cpProtocolData: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CpProtocolData' - description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. - linkPortId: - type: string - description: Identifier of a pre-configured link port to which the external CP will be associated. See note. - AppExtCpData: - title: AppExtCpData - required: - - cpConfig - - cpdId - type: object - properties: - cpConfig: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/AppExtCpConfig' - description: List of instance data that need to be configured on the CP instances created from the respective CPD. - cpdId: - type: string - description: The identifier of the CPD in the AppD. - ResourceDefinition.Type: - title: ResourceDefinition.Type - enum: - - COMPUTE - - VL - - STORAGE - - LINKPORT - type: string - description: Type of the resource definition referenced. - examples: - - COMPUTE - CpProtocolData: - title: CpProtocolData - required: - - layerProtocol - type: object - properties: - ipOverEthernet: - $ref: '#/components/schemas/IpOverEthernetAddressData' - layerProtocol: - $ref: '#/components/schemas/IpOverEthernetAddressData' - ExtLinkPortData: - title: ExtLinkPortData - required: - - id - - resourceHandle - type: object - properties: - id: - type: string - description: Identifier of this link port as provided by the entity that has created the link port. - resourceHandle: - $ref: '#/components/schemas/ResourceHandle' - ExtVirtualLinkData: - title: ExtVirtualLinkData - required: - - extCps - - id - - resourceId - type: object - properties: - extCps: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/AppExtCpData' - description: External CPs of the application instance to be connected to this external VL. - extLinkPorts: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ExtLinkPortData' - description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL. - id: - type: string - description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance. - resourceId: - type: string - description: The identifier of the resource in the scope of the VIM. - vimConnectionId: - type: string - description: Identifier of the VIM connection to manage this resource. - Grant: - title: Grant - required: - - id - - appInstanceId - - appLcmOpOccId - - _links - type: object - properties: - id: - type: string - appInstanceId: - type: string - description: Identifier of application instance. - appLcmOpOccId: - type: string - description: Identifier of application lifecycle management operation occurrence. - vimConnections: - type: array - items: - $ref: '#/components/schemas/VimConnectionInfo' - description: '' - zones: - type: array - items: - $ref: '#/components/schemas/ZoneInfo' - description: '' - zoneGroups: - type: array - items: - $ref: '#/components/schemas/ZoneGroupInfo' - description: '' - addResources: - type: array - items: - $ref: '#/components/schemas/GrantInfo' - description: '' - tempResources: - type: array - items: - $ref: '#/components/schemas/GrantInfo' - description: '' - removeResources: - type: array - items: - $ref: '#/components/schemas/GrantInfo' - description: '' - updateResources: - type: array - items: - $ref: '#/components/schemas/GrantInfo' - description: '' - vimAssets: - $ref: '#/components/schemas/VimAssets' - extVirtualLinks: - type: array - items: - $ref: '#/components/schemas/ExtVirtualLinkData' - description: '' - additionalParams: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - _links: - $ref: '#/components/schemas/Grant.links' - description: "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '" - VimAssets: - title: VimAssets - type: object - properties: - softwareImages: - type: array - items: - $ref: '#/components/schemas/SoftwareImages' - description: '' - description: Information about assets for the application that are managed by the MEO in the VIM, such as software images. - SoftwareImages: - title: SoftwareImages - required: - - appDSoftwareImageId - - vimSoftwareImageId - type: object - properties: - appDSoftwareImageId: - type: string - description: Identifier which references the software image descriptor in the AppD. - vimConnectionId: - type: string - description: Identifier of the VIM connection to access the software image referenced in this structure. - vimSoftwareImageId: - type: string - description: Identifier of the software image in the resource management layer (i.e. VIM). - Grant.links: - title: Grant.links - required: - - appLcmOpOcc - - appInstance - type: object - properties: - appLcmOpOcc: - $ref: '#/components/schemas/LinkType' - appInstance: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - GrantInfo: - title: GrantInfo - required: - - resourceDefinitionId - type: object - properties: - resourceDefinitionId: - type: string - description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure. - resourceGroupId: - type: string - description: Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated. - vimConnectionId: - type: string - description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. - zoneId: - type: string - description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated. - GrantRequest: - title: GrantRequest - required: - - appInstanceId - - appLcmOpOccId - - appDId - - operation - - _links - type: object - properties: - appInstanceId: - type: string - description: Identifier of application instance. - appLcmOpOccId: - type: string - description: Identifier of application lifecycle management operation occurrence. - appDId: - type: string - description: Identifier of this MEC application descriptor. This attribute shall be globally unique. - operation: - $ref: '#/components/schemas/GrantRequest.Operation' - addResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' - description: '' - tempResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' - description: '' - removeResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' - description: '' - updateResources: - type: array - items: - $ref: '#/components/schemas/ResourceDefinition' - description: '' - additionalParams: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - _links: - $ref: '#/components/schemas/GrantRequest.links' - description: "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'" - GrantRequest.Operation: - title: GrantRequest.Operation - enum: - - INSTANTIATE - - OPERATE - - TERMINATE - type: string - description: "'The lifecycle management operation for which granting is requested'" - examples: - - INSTANTIATE - GrantRequest.links: - title: GrantRequest.links - required: - - appLcmOpOcc - - appInstance - type: object - properties: - appLcmOpOcc: - $ref: '#/components/schemas/LinkType' - appInstance: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - IpOverEthernetAddressData: - title: IpOverEthernetAddressData - type: object - properties: - macAddress: - type: string - description: "'MAC address. If this attribute is not present, it shall be chosen by the VIM'" - ipAddresses: - type: array - items: - $ref: '#/components/schemas/IpAddress' - description: List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. - description: "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'" - IpAddress: - title: IpAddress - required: - - type - type: object - properties: - type: - $ref: '#/components/schemas/IpAddress.Type' - fixedAddresses: - type: array - items: - type: string - description: Fixed addresses to assign (from the subnet defined by subnetId if provided). - numDynamicAddresses: - type: integer - description: Number of dynamic addresses to assign (from the subnet defined by subnetId if provided) - contentEncoding: int32 - addressRange: - $ref: '#/components/schemas/AddressRange' - subnetId: - type: string - description: Subnet defined by the identifier of the subnet resource in the VIM. - description: "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'" - IpAddress.Type: - title: IpAddress.Type - enum: - - IPV4 - - IPV6 - type: string - description: The type of the IP addresses. - examples: - - IPV4 - AddressRange: - title: AddressRange - required: - - minAddress - - maxAddress - type: object - properties: - minAddress: - type: string - description: Lowest IP address belonging to the range. - maxAddress: - type: string - description: Highest IP address belonging to the range. - description: An IP address range to be used, e.g. in case of egress connections. - LinkType: - title: LinkType - required: - - href - type: object - properties: - href: - type: string - description: URI referring to a resource - ProblemDetails: - title: ProblemDetails - type: object - properties: - detail: - type: string - description: A human-readable explanation specific to this occurrence of the problem - instance: - type: string - description: A URI reference that identifies the specific occurrence of the problem - status: - type: integer - description: The HTTP status code for this occurrence of the problem - contentEncoding: int32 - title: - type: string - description: A short, human-readable summary of the problem type - type: - type: string - description: A URI reference according to IETF RFC 3986 that identifies the problem type - ResourceDefinition: - title: ResourceDefinition - required: - - id - - type - - resourceTemplateId - - resource - type: object - properties: - id: - type: string - description: Identifier of the related ResourceDefinition structure from the related GrantRequest structure. - type: - $ref: '#/components/schemas/ResourceDefinition.Type' - vduId: - type: string - description: Reference to the related VDU in the AppD applicable to this resource. - resourceTemplateId: - type: string - description: Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD. - resource: - $ref: '#/components/schemas/Resource' - description: "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '" - Resource: - title: Resource - required: - - vimConnectionInfo - - resourceId - type: object - properties: - vimConnectionInfo: - $ref: '#/components/schemas/VimConnectionInfo' - resourceId: - type: string - description: Identifier of the resource in the scope of the VIM. - description: Resource information for an existing resource - ResourceHandle: - title: ResourceHandle - required: - - resourceId - type: object - properties: - resourceId: - type: string - description: Identifier of the resource in the scope of the VIM. - vimConnectionId: - type: string - description: Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure. - vimLevelResourceType: - type: string - description: Type of the resource in the scope of the VIM. See note. - VimConnectionInfo: - title: VimConnectionInfo - required: - - id - - vimType - type: object - properties: - accessInfo: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - extra: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - id: - type: string - description: The identifier of the VIM Connection. This identifier is managed by the MEO. - interfaceInfo: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - vimId: - type: string - description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise. - vimType: - type: string - description: Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. - VimSoftwareImage: - title: VimSoftwareImage - required: - - appDSoftwareImageId - - vimSoftwareImageId - type: object - properties: - appDSoftwareImageId: - type: string - description: Identifier which references the software image descriptor in the AppD. - vimConnectionId: - type: string - description: Identifier of the VIM connection to access the software image referenced in this structure. - vimSoftwareImageId: - type: string - description: Identifier of the software image in the resource management layer (i.e. VIM). - ZoneGroupInfo: - title: ZoneGroupInfo - required: - - zoneId - type: object - properties: - zoneId: - minItems: 1 - type: array - items: - type: string - description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group. - ZoneInfo: - title: ZoneInfo - required: - - id - - zoneId - type: object - properties: - id: - type: string - description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure. - vimConnectionId: - type: string - zoneId: - type: string - description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM). -security: -- {} -tags: -- name: granting - description: Grant operations -externalDocs: - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml deleted file mode 100644 index a792a8d..0000000 --- a/OAS3.1.0/MEC010-2_AppLcm.yaml-OpenApi31Yaml.yaml +++ /dev/null @@ -1,1832 +0,0 @@ -openapi: 3.1.0 -info: - title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' - contact: - name: ETSI Forge - url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api - email: cti_support@etsi.org - version: '2.1.1' -jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema -servers: -- url: https://localhost/app_lcm/v1 - variables: {} -paths: - /app_instances: - post: - tags: - - '' - summary: appInstancePOST - description: Create an application instance resource - operationId: appInstancePOST - parameters: [] - requestBody: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAppInstanceRequest' - required: true - responses: - '201': - description: An application instance identifier and the related resource has been created successfully. - headers: {} - content: - application/zip: - schema: - type: object - description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" - contentMediaType: application/zip - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - get: - tags: - - '' - summary: appInstanceGET - description: queries information relating to on-boarded application packages in the MEO - operationId: appInstanceGET - parameters: - - name: filter - in: query - description: Attribute-based filtering parameters according to ETSI GS MEC 009 - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes of AppPkgInfo to be included into the response - style: form - explode: true - schema: - type: string - - name: exclude_fields - in: query - description: Complex attributes of AppPkgInfo to be excluded from the response. - style: form - explode: true - schema: - type: string - - name: exclude_default - in: query - description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. - style: form - explode: true - schema: - type: string - responses: - '200': - description: Array the representations of zero or more application instances - headers: {} - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AppInstanceInfo' - description: '' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_instances/{appInstanceId}: - get: - tags: - - '' - summary: appInstanceIdGET - description: Retrieves the information of an individual application instance via reading an individual application instance. - operationId: appInstanceIdGET - parameters: - - name: appInstanceId - in: path - description: Identifier of an individual application instance - required: true - style: simple - schema: - type: string - responses: - '200': - description: Contains a representation of the read resource. - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppInstanceInfo' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - delete: - tags: - - '' - summary: appInstanceIdDELETE - description: Deletes an individual application instance resource. - operationId: appInstanceIdDELETE - parameters: - - name: appInstanceId - in: path - description: Identifier of an individual application instance - required: true - style: simple - schema: - type: string - responses: - '204': - description: No Content - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /subscriptions: - post: - tags: - - '' - summary: appLcmSubscriptionsPOST - description: subscribe to the notification of application instance operational state change - operationId: appLcmSubscriptionsPOST - parameters: - - name: subscriptionType - in: query - description: >- - "Query parameter to filter on a specific subscription type. Permitted values: - • "AppInstanceStateChange" - • "AppLcmOpOccStateChange" - " - required: true - style: form - explode: true - schema: - oneOf: - - $ref: '#/components/schemas/AppInst.SubscriptionType' - - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' - requestBody: - description: '' - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppInstSubscriptionRequest' - - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest' - contentMediaType: application/json - required: true - responses: - '201': - description: a representation of the created SubscriptionInfo. - headers: {} - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppInstSubscriptionInfo' - - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - get: - tags: - - '' - summary: appLcmSubscriptionsGET - description: Retrieves the information of multiple subscriptions to notifications related to an application instance. - operationId: appLcmSubscriptionsGET - parameters: - - name: subscriptionType - in: query - description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' - style: form - explode: true - schema: - type: string - responses: - '200': - description: List of all subscriptions is returned. - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/SubscriptionLinkList' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /subscriptions/{subscriptionId}: - get: - tags: - - '' - summary: individualSubscriptionGET - description: Used to represent an individual subscription to notifications about application package changes. - operationId: individualSubscriptionGET - parameters: - - name: subscriptionId - in: path - description: Represents an individual subscription to notification related to an application instance - required: true - style: simple - schema: - type: string - - name: subscriptionType - in: query - description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' - required: true - style: form - explode: true - schema: - type: string - responses: - '200': - description: Representation of the resource. - headers: {} - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppInstSubscriptionInfo' - - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - delete: - tags: - - '' - summary: individualSubscriptionDELETE - description: Deletes the individual subscription to notifications about application package changes in MEO. - operationId: individualSubscriptionDELETE - parameters: - - name: subscriptionId - in: path - description: Represents an individual subscription to notification related to an application instance - required: true - style: simple - schema: - type: string - responses: - '204': - description: No Content - headers: {} - content: {} - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /user_defined_notification: - post: - tags: - - '' - summary: appInstNotificationPOST - description: Delivers a notification from the application lifecycle management resource to the subscriber. - operationId: appInstNotificationPOST - parameters: [] - requestBody: - description: '' - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppInstNotification' - - $ref: '#/components/schemas/AppLcmOpOccNotification' - contentMediaType: application/json - required: true - responses: - '204': - description: No Content - headers: {} - content: {} - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_instances/{appInstanceId}/instantiate: - post: - tags: - - '' - summary: appLcmInstanciatePOST - description: task of instantiating an application instance. - operationId: appLcmInstanciatePOST - parameters: - - name: appInstanceId - in: path - description: Identifier of an individual application instance - required: true - style: simple - schema: - type: string - requestBody: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/InstantiateAppRequest' - required: true - responses: - '202': - description: accepted for processing, but the processing has not yet been completed. - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_instances/{appInstanceId}/terminate: - post: - tags: - - '' - summary: appLcmTerminatePOST - description: terminate an application instance. - operationId: appLcmTerminatePOST - parameters: - - name: appInstanceId - in: path - description: Identifier of an individual application instance - required: true - style: simple - schema: - type: string - requestBody: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/TerminateAppRequest' - required: true - responses: - '202': - description: accepted for processing, but the processing has not yet been completed. - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_instances/{appInstanceId}/operate: - post: - tags: - - '' - summary: appLcmOperatePOST - description: change the operational state, i.e. start or stop, of the application instance - operationId: appLcmOperatePOST - parameters: - - name: appInstanceId - in: path - description: Identifier of an individual application instance - required: true - style: simple - schema: - type: string - requestBody: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/OperateAppRequest' - required: true - responses: - '202': - description: accepted for processing, but the processing has not yet been completed. - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_lcm_op_occs: - get: - tags: - - '' - summary: appLcmOpOccsGET - description: retrieves information of operation status about multiple application instance lifecycle management operation occurrences - operationId: appLcmOpOccsGET - parameters: - - name: filter - in: query - description: Attribute-based filtering parameters according to ETSI GS MEC 009 - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes of AppPkgInfo to be included into the response - style: form - explode: true - schema: - type: string - - name: exclude_fields - in: query - description: Complex attributes of AppPkgInfo to be excluded from the response. - style: form - explode: true - schema: - type: string - - name: exclude_default - in: query - description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. - style: form - explode: true - schema: - type: string - responses: - '200': - description: Status information for zero or more application instance lifecycle management operation occurrences was queried successfully - headers: {} - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AppInstanceLcmOpOcc' - description: '' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_lcm_op_occs/{appLcmOpOccId}: - get: - tags: - - '' - summary: appLcmOpOccsbyIdGET - description: reads the status information of an individual application LCM operation occurrence - operationId: appLcmOpOccsbyIdGET - parameters: - - name: appLcmOpOccId - in: path - description: Identifies an individual application LCM operation occurrence - required: true - style: simple - schema: - type: string - responses: - '200': - description: Information about an application LCM operation occurrence was read successfully - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppInstanceLcmOpOcc' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] -components: - schemas: - AppInstanceLcmOpOcc: - title: AppInstanceLcmOpOcc - required: - - id - - operationState - - stateEnteredTime - - startTime - - lcmOperation - - _links - type: object - properties: - id: - type: string - description: "'Identifier of the subscription to application LCM operation occurrence notification'" - operationState: - $ref: '#/components/schemas/OperationState' - stateEnteredTime: - $ref: '#/components/schemas/TimeStamp' - startTime: - $ref: '#/components/schemas/TimeStamp' - lcmOperation: - $ref: '#/components/schemas/LcmOperation' - operationParams: - $ref: '#/components/schemas/OperationParams' - _links: - $ref: '#/components/schemas/AppInstanceLcmOpOcc.links' - description: "'This data type represents an application lifecycle management operation occurrence'" - OperationParams: - title: OperationParams - enum: - - INSTANTIATE - - OPERATE - - TERMINATE - type: string - description: "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'" - examples: - - INSTANTIATE - AppInstanceLcmOpOcc.links: - title: AppInstanceLcmOpOcc.links - required: - - self - - appInstance - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - appInstance: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - SubscriptionLinkList: - title: SubscriptionLinkList - required: - - _links - type: object - properties: - _links: - $ref: '#/components/schemas/SubscriptionLinkList.links' - description: "'The data type represents a subscription link list of notification on application lifecycle management. '" - SubscriptionLinkList.links: - title: SubscriptionLinkList.links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - subscriptions: - type: array - items: - $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' - description: '' - description: Links to resources related to this resource. - SubscriptionLinkList.links.subscriptions: - title: SubscriptionLinkList.links.subscriptions - required: - - href - - subscriptionType - type: object - properties: - href: - type: string - subscriptionType: - $ref: '#/components/schemas/SubscriptionType' - description: A link list to the subscriptions - AppLcmOpOccSubscriptionInfo: - title: AppLcmOpOccSubscriptionInfo - required: - - id - - subscriptionType - - callbackUri - - _links - type: object - properties: - id: - type: string - description: "''" - subscriptionType: - const: AppLcmOpOccStateChange - type: string - description: Shall be set to AppLcmOpOccStateChange. - examples: - - AppLcmOpOccStateChange - callbackUri: - type: string - description: The URI of the endpoint for the notification to be sent to. - _links: - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links' - description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'" - AppLcmOpOcc.SubscriptionType: - title: AppLcmOpOcc.SubscriptionType - const: AppLcmOpOccStateChange - type: string - description: Shall be set to AppLcmOpOccStateChange. - examples: - - AppLcmOpOccStateChange - AppLcmOpOccSubscriptionInfo.links: - title: AppLcmOpOccSubscriptionInfo.links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - AppInstSubscriptionInfo: - title: AppInstSubscriptionInfo - required: - - id - - subscriptionType - - notificationType - - callbackUri - - _links - type: object - properties: - id: - type: string - description: "'Identifier of the subscription to application instance operational state change notification.'" - subscriptionType: - const: AppInstanceStateChange - type: string - description: Shall be set to AppInstanceStateChange. - examples: - - AppInstanceStateChange - notificationType: - $ref: '#/components/schemas/AppInst.NotificationType' - callbackUri: - type: string - description: The URI of the endpoint for the notification to be sent to. - _links: - $ref: '#/components/schemas/AppInstSubscriptionInfo.links' - description: "'The data type represents a subscription to notification of application instance operational state change.'" - AppInst.SubscriptionType: - title: AppInst.SubscriptionType - const: AppInstanceStateChange - type: string - description: Shall be set to AppInstanceStateChange. - examples: - - AppInstanceStateChange - AppInst.NotificationType: - title: AppInst.NotificationType - enum: - - NOT_INSTANTIATED - - STARTED - - STOPPED - type: string - description: Subscribed notification - examples: - - NOT_INSTANTIATED - AppInstSubscriptionInfo.links: - title: AppInstSubscriptionInfo.links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - AppLcmOpOccSubscriptionRequest: - title: AppLcmOpOccSubscriptionRequest - required: - - callbackUri - - subscriptionType - type: object - properties: - appLcmOpOccSubscriptionFilter: - $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter' - callbackUri: - type: string - subscriptionType: - type: string - description: Shall be set to "AppLcmOpOccStateChange". - AppLcmOpOccSubscriptionFilter: - title: AppLcmOpOccSubscriptionFilter - type: object - properties: - appInstanceSubscriptionFilter: - $ref: '#/components/schemas/AppInstanceSubscriptionFilter' - notificationTypes: - $ref: '#/components/schemas/NotificationTypes' - operationStates: - $ref: '#/components/schemas/OperationStates' - operationTypes: - $ref: '#/components/schemas/OperationTypes' - NotificationTypes: - title: NotificationTypes - const: AppLcmOperationOccurrenceNotification - type: string - description: Match particular notification types. - examples: - - AppLcmOperationOccurrenceNotification - OperationStates: - title: OperationStates - enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED - type: string - description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'" - examples: - - STARTING - OperationTypes: - title: OperationTypes - enum: - - INSTANTIATE - - OPERATE - - TERMINATE - type: string - description: "'Type of the LCM operation represented by this application instance LCM operation occurrence.'" - examples: - - INSTANTIATE - CreateAppInstanceRequest: - title: CreateAppInstanceRequest - required: - - appDId - type: object - properties: - appDId: - type: string - description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. - appInstanceDescription: - type: string - description: Human-readable description of the application instance to be created. - appInstanceName: - type: string - description: Human-readable name of the application instance to be created. - AppInstSubscriptionRequest: - title: AppInstSubscriptionRequest - required: - - subscriptionType - - callbackUri - type: object - properties: - subscriptionType: - const: AppInstanceStateChange - type: string - description: Shall be set to AppInstanceStateChange. - examples: - - AppInstanceStateChange - callbackUri: - type: string - description: The URI of the endpoint for the notification to be sent to. - appInstanceState: - $ref: '#/components/schemas/AppInstanceState' - appInstanceSubscriptionFilter: - $ref: '#/components/schemas/AppInstanceSubscriptionFilter' - AppInstanceSubscriptionFilter: - title: AppInstanceSubscriptionFilter - required: - - appInstSelectorType - type: object - properties: - appInstSelectorType: - $ref: '#/components/schemas/AppInstSelectorType' - appInstances: - type: array - items: - type: string - description: '' - appsFromProviders: - type: array - items: - $ref: '#/components/schemas/AppsFromProviders' - description: '' - description: "'This data type represents subscription filter criteria to match application instances. '" - AppsFromProviders: - title: AppsFromProviders - required: - - appProvider - type: object - properties: - appProvider: - type: string - description: Provider of the application and of the AppD. - appProducts: - $ref: '#/components/schemas/AppProducts' - description: "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'" - AppProducts: - title: AppProducts - required: - - appName - type: object - properties: - appName: - type: string - description: Name to identify the MEC application. - versions: - $ref: '#/components/schemas/AppProducts.Versions' - description: "'If present, match application instances that belong to application products with certain product names, from one particular provider.'" - AppProducts.Versions: - title: AppProducts.Versions - required: - - appSoftVersion - type: object - properties: - appSoftVersion: - type: string - description: Identifies the version of software of the MEC application. - appDVersion: - type: array - items: - type: string - description: '' - description: "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'" - AppInstSelectorType: - title: AppInstSelectorType - enum: - - VOID - - APP_IDENTITY - - APP_NAME - - APP_D_ID - - APP_FROM_PROVIDER - type: string - description: 0 = void - examples: - - VOID - AppInstanceState: - title: AppInstanceState - enum: - - NOT_INSTANTIATED - - STARTED - - STOPPED - type: string - description: Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states. - examples: - - NOT_INSTANTIATED - AppInstNotification: - title: AppInstNotification - required: - - _links - - appDId - - appInstanceId - - appPkgId - - id - - notificationType - - subscriptionId - - timeStamp - type: object - properties: - _links: - $ref: '#/components/schemas/Links' - appDId: - type: string - description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way. - appInstanceId: - type: string - description: Identifier of application instance. - appPkgId: - type: string - description: Identifier of the onboarded application package. - id: - type: string - description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all these notifications shall have the same value. - notificationType: - $ref: '#/components/schemas/AppInst.NotificationType' - subscriptionId: - type: string - description: Identifier of the subscription related to this notification. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - AppInstanceInfo: - title: AppInstanceInfo - required: - - id - - appDId - - appProvider - - appName - - appSoftVersion - - appDVersion - - appPkgId - - instantiationState - - _links - type: object - properties: - id: - type: string - description: Identifier of application instance. - appInstanceName: - type: string - description: Name of the application instance. - appInstanceDescription: - type: string - description: Human-readable description of the application instance to be created. - appDId: - type: string - description: Identifier of this MEC application descriptor. This attribute shall be globally unique. - appProvider: - type: string - description: Provider of the application and of the AppD. - appName: - type: string - description: Name to identify the MEC application. - appSoftVersion: - type: string - description: Identifies the version of software of the MEC application. - appDVersion: - type: string - description: Identifies the version of the application descriptor. - appPkgId: - type: string - description: Identifier of the onboarded application package. - vimConnectionInfo: - type: array - items: - $ref: '#/components/schemas/VimConnectionInfo' - description: '' - instantiationState: - $ref: '#/components/schemas/InstantiationState' - instantiatedAppState: - $ref: '#/components/schemas/InstantiatedAppState' - _links: - $ref: '#/components/schemas/AppInstanceInfo.links' - description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" - OperationState: - title: OperationState - enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED - type: string - description: Operation state - examples: - - STARTING - InstantiationState: - title: InstantiationState - enum: - - NOT_INSTANTIATED - - INSTANTIATED - type: string - description: Instantiation state of the application instance - examples: - - NOT_INSTANTIATED - InstantiatedAppState: - title: InstantiatedAppState - required: - - operationalState - type: object - properties: - operationalState: - $ref: '#/components/schemas/OperationalState' - description: "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'" - OperationalState: - title: OperationalState - enum: - - STARTED - - STOPPED - type: string - description: Operational state is applicable in the instantiation state INSTANTIATED - examples: - - STARTED - AppInstanceInfo.links: - title: AppInstanceInfo.links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - instantiate: - $ref: '#/components/schemas/LinkType' - terminate: - $ref: '#/components/schemas/LinkType' - operate: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - LcmOperation: - title: LcmOperation - enum: - - INSTATIATE - - OPERATE - - TERMINATE - type: string - description: Type of the actual LCM operation represented by this application instance LCM operation occurrence - examples: - - INSTATIATE - AppLcmOpOccNotification: - title: AppLcmOpOccNotification - required: - - id - - notificationType - - subscriptionId - - timeStamp - - appLcmOpOccId - - appInstanceId - - _links - type: object - properties: - id: - type: string - description: "''" - notificationType: - $ref: '#/components/schemas/AppLcmOpOcc.NotificationType' - subscriptionId: - type: string - description: Identifier of the subscription related to this notification. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - appLcmOpOccId: - type: string - description: Identifier of application lifecycle management operation occurrence. - appInstanceId: - type: string - description: Identifier of application instance. - _links: - $ref: '#/components/schemas/AppLcmOpOccNotification.links' - description: "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'" - AppLcmOpOcc.NotificationType: - title: AppLcmOpOcc.NotificationType - enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED - type: string - description: Discriminator for the different notification types - examples: - - STARTING - AppLcmOpOccNotification.links: - title: AppLcmOpOccNotification.links - required: - - appInstance - - subscription - - appLcmOpOcc - type: object - properties: - appInstance: - $ref: '#/components/schemas/LinkType' - subscription: - $ref: '#/components/schemas/LinkType' - appLcmOpOcc: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - InstantiateAppRequest: - title: InstantiateAppRequest - required: - - selectedMECHostInfo - type: object - properties: - locationConstraints: - $ref: '#/components/schemas/LocationConstraints' - selectedMECHostInfo: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/MECHostInformation' - description: Describes the information of selected host for the application instance. See note 2. - vimConnectionInfo: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/VimConnectionInfo' - description: >- - Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links. - - This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2. - virtualComputeDescriptor: - type: string - description: Ref NFV - virtualStorageDescriptor: - minItems: 0 - type: array - items: - type: string - description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1. - LinkType: - title: LinkType - required: - - href - type: object - properties: - href: - type: string - description: URI referring to a resource - LocationConstraints: - title: LocationConstraints - required: - - countryCode - type: object - properties: - countryCode: - type: string - description: The two-letter ISO 3166 country code in capital letters. - civicAddressElement: - type: array - items: - $ref: '#/components/schemas/CivicAddressElement' - description: '' - description: "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'" - CivicAddressElement: - title: CivicAddressElement - required: - - caType - - caValue - type: object - properties: - caType: - type: integer - description: "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'" - contentEncoding: int32 - caValue: - type: string - description: "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'" - description: "'The civic address.'" - MECHostInformation: - title: MECHostInformation - required: - - hostId - type: object - properties: - hostId: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - hostName: - type: string - description: Human-readable name of MEC host. - OperateAppRequest: - title: OperateAppRequest - required: - - changeStateTo - type: object - properties: - changeStateTo: - $ref: '#/components/schemas/ChangeStateTo' - gracefulStopTimeout: - type: integer - description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2. - contentEncoding: int32 - stopType: - $ref: '#/components/schemas/StopType' - StopType: - title: StopType - enum: - - FORCEFUL - - GRACEFUL - type: string - description: Signals forceful or graceful stop - examples: - - FORCEFUL - ChangeStateTo: - title: ChangeStateTo - enum: - - STARTED - - STOPPED - type: string - description: The desired operational state - examples: - - STARTED - ProblemDetails: - title: ProblemDetails - type: object - properties: - detail: - type: string - description: A human-readable explanation specific to this occurrence of the problem - instance: - type: string - description: A URI reference that identifies the specific occurrence of the problem - status: - type: integer - description: The HTTP status code for this occurrence of the problem - contentEncoding: int32 - title: - type: string - description: A short, human-readable summary of the problem type - type: - type: string - description: A URI reference according to IETF RFC 3986 that identifies the problem type - TerminateAppRequest: - title: TerminateAppRequest - required: - - terminationType - type: object - properties: - gracefulTerminationTimeout: - type: integer - description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources." - contentEncoding: int32 - terminationType: - $ref: '#/components/schemas/TerminationType' - TimeStamp: - title: TimeStamp - required: - - nanoSeconds - - seconds - type: object - properties: - nanoSeconds: - type: integer - description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - contentEncoding: int32 - seconds: - type: integer - description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - contentEncoding: int32 - TerminationType: - title: TerminationType - enum: - - FORCEFUL - - GRACEFUL - type: string - description: "'Indicates whether forceful or graceful termination is requested.'" - examples: - - FORCEFUL - VimConnectionInfo: - title: VimConnectionInfo - required: - - id - - vimType - type: object - properties: - accessInfo: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - extra: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - id: - type: string - description: The identifier of the VIM Connection. This identifier is managed by the MEO. - interfaceInfo: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - vimId: - type: string - description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise. - vimType: - type: string - description: Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. - Links: - title: Links - required: - - subscription - type: object - properties: - subscription: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this notification. - SubscriptionType: - title: SubscriptionType - enum: - - AppInstanceStateChange - - AppLcmOpOccStateChange - type: string - examples: - - AppInstanceStateChange -security: -- {} -tags: -- name: app-lcm - description: App lifecycle management -- name: app-lcm-notifications - description: App lifecycle management notifications -externalDocs: - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml deleted file mode 100644 index b5a46fc..0000000 --- a/OAS3.1.0/MEC010-2_AppPkgMgmt.yaml-OpenApi31Yaml.yaml +++ /dev/null @@ -1,2046 +0,0 @@ -openapi: 3.1.0 -info: - title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' - contact: - name: ETSI Forge - url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api - email: cti_support@etsi.org - version: '2.1.1' -jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema -servers: -- url: https://localhost/app_pkgm/v1 - variables: {} -paths: - /app_packages: - post: - tags: - - app-pkgm - summary: app_packagesPOST - description: Create a resource for on-boarding an application package to a MEO - operationId: app_packagesPOST - parameters: [] - requestBody: - description: Resource to be created - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAppPkg' - required: true - responses: - '201': - description: Successful response for resource creation - headers: {} - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AppPkgInfo' - description: '' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - get: - tags: - - app-pkgm - summary: app_packagesGET - description: queries information relating to on-boarded application packages in the MEO - operationId: app_packagesGET - parameters: - - name: filter - in: query - description: Attribute-based filtering parameters according to ETSI GS MEC 009 - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes of AppPkgInfo to be included into the response - style: form - explode: true - schema: - type: string - - name: exclude_fields - in: query - description: Complex attributes of AppPkgInfo to be excluded from the response. - style: form - explode: true - schema: - type: string - - name: exclude_default - in: query - description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. - style: form - explode: true - schema: - type: string - responses: - '200': - description: Contains a representation of the application package resource - headers: {} - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AppPkgInfo' - description: '' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_packages/{appPkgId}: - get: - tags: - - app-pkgm - summary: app_packageGET - description: Queries the information related to individual application package resources - operationId: app_packageGET - parameters: - - name: appPkgId - in: path - description: Identifier of an individual application package resource - required: true - style: simple - schema: - type: string - responses: - '200': - description: Contains a representation of the application package resource - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgInfo' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - delete: - tags: - - app-pkgm - summary: app_packageDELETE - description: Deletes an individual application package resources - operationId: app_packageDELETE - parameters: - - name: appPkgId - in: path - description: Identifier of an individual application package resource - required: true - style: simple - schema: - type: string - responses: - '204': - description: No Content - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - patch: - tags: - - app-pkgm - summary: app_packagePATCH - description: Updates the operational state of an individual application package resources - operationId: app_packagePATCH - parameters: - - name: appPkgId - in: path - description: Identifier of an individual application package resource - required: true - style: simple - schema: - type: string - requestBody: - description: Operational state to be set - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgInfoModifications' - required: true - responses: - '200': - description: Shows that the operation has been completed successfully - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgInfoModifications' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /subscriptions: - post: - tags: - - app-pkgm - summary: subscriptionsPOST - description: Subscribe to notifications about on-boarding an application package - operationId: subscriptionsPOST - parameters: [] - requestBody: - description: The input parameters of subscribe operation to notifications - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgSubscription' - required: true - responses: - '201': - description: Successful response for created subscription - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgSubscriptionInfo' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - get: - tags: - - app-pkgm - summary: subscriptionsGET - description: used to retrieve the information of subscriptions to individual application package resource in MEO package - operationId: subscriptionsGET - parameters: [] - responses: - '200': - description: List of zero or more subscriptions - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgSubscriptionLinkList' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /subscriptions/{subscriptionId}: - get: - tags: - - app-pkgm - summary: individualSubscriptionGET - description: Used to represent an individual subscription to notifications about application package changes. - operationId: individualSubscriptionGET - parameters: - - name: subscriptionId - in: path - description: Identifier of an individual subscription to notifications about application package changes - required: true - style: simple - schema: - type: string - responses: - '200': - description: Representation of the resource. - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgSubscriptionInfo' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - delete: - tags: - - app-pkgm - summary: individualSubscriptionDELETE - description: Deletes the individual subscription to notifications about application package changes in MEO. - operationId: individualSubscriptionDELETE - parameters: - - name: subscriptionId - in: path - description: Identifier of an individual subscription to notifications about application package changes - required: true - style: simple - schema: - type: string - responses: - '204': - description: No Content - headers: {} - content: {} - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_packages/{appPkgId}/appd: - get: - tags: - - app-pkgm - summary: appPkgIdGET - description: Reads the content of the AppD of on-boarded individual application package resources. - operationId: appPkgIdGET - parameters: - - name: appPkgId - in: path - description: Identifier of an on-boarded individual application package - required: true - style: simple - schema: - type: string - - name: filter - in: query - description: Attribute-based filtering parameters according to ETSI GS MEC 009 - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes of AppPkgInfo to be included into the response - style: form - explode: true - schema: - type: string - - name: exclude_fields - in: query - description: Complex attributes of AppPkgInfo to be excluded from the response. - style: form - explode: true - schema: - type: string - - name: exclude_default - in: query - description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. - style: form - explode: true - schema: - type: string - responses: - '200': - description: Content of the AppD is returned. - headers: {} - content: - text/plain: - schema: - $ref: '#/components/schemas/AppD' - application/zip: - schema: - type: object - contentMediaType: application/zip - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /onboarded_app_packages/{appDId}/appd: - get: - tags: - - app-pkgm - summary: appDGET - description: Reads the content of the AppD of on-boarded individual application package resources. - operationId: appDGET - parameters: - - name: appDId - in: path - description: Identifier of an application descriptor - required: true - style: simple - schema: - type: string - - name: filter - in: query - description: Attribute-based filtering parameters according to ETSI GS MEC 009 - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes of AppPkgInfo to be included into the response - style: form - explode: true - schema: - type: string - - name: exclude_fields - in: query - description: Complex attributes of AppPkgInfo to be excluded from the response. - style: form - explode: true - schema: - type: string - - name: exclude_default - in: query - description: Indicates to exclude the following complex attributes of AppPkgInfo from the response. - style: form - explode: true - schema: - type: string - responses: - '200': - description: Content of the AppD is returned. - headers: {} - content: - text/plain: - schema: - $ref: '#/components/schemas/AppD' - application/zip: - schema: - type: object - contentMediaType: application/zip - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /app_packages/{appPkgId}/package_content: - get: - tags: - - app-pkgm - summary: appPkgGET - description: Fetch the onboarded application package content identified by appPkgId or appDId. - operationId: appPkgGET - parameters: - - name: appPkgId - in: path - description: Identifier of an on-boarded individual application package - required: true - style: simple - schema: - type: string - responses: - '200': - description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. - headers: {} - content: {} - '206': - description: Partial content - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '416': - description: Range Not Satisfiable . - headers: {} - content: {} - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - put: - tags: - - app-pkgm - summary: appPkgPUT - description: Uploads the content of application package. - operationId: appPkgPUT - parameters: - - name: appPkgId - in: path - description: Identifier of an on-boarded individual application package - required: true - style: simple - schema: - type: string - requestBody: - description: '' - content: - text/plain: - schema: - type: object - contentMediaType: text/plain - required: false - responses: - '202': - description: The application package has been accepted for uploading, but the processing has not been completed. - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /onboarded_app_packages/{appDId}/package_content: - get: - tags: - - app-pkgm - summary: appDIdGET - description: Fetch the onboarded application package content identified by appPkgId or appDId. - operationId: appDIdGET - parameters: - - name: appDId - in: path - description: Identifier of an application descriptor - required: true - style: simple - schema: - type: string - responses: - '200': - description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. - headers: {} - content: {} - '206': - description: Partial content - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '416': - description: Range Not Satisfiable . - headers: {} - content: {} - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - put: - tags: - - app-pkgm - summary: appDIdPUT - description: Uploads the content of application package. - operationId: appDIdPUT - parameters: - - name: appDId - in: path - description: Identifier of an application descriptor - required: true - style: simple - schema: - type: string - requestBody: - description: '' - content: - text/plain: - schema: - type: object - contentMediaType: text/plain - required: false - responses: - '202': - description: The application package has been accepted for uploading, but the processing has not been completed. - headers: {} - content: {} - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '409': - description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /user_defined_notification: - post: - tags: - - app-pkgm-notifications - summary: app_pkg_notificationPOST - description: Registers a notification endpoint to notify application package operations - operationId: app_pkg_notificationPOST - parameters: [] - requestBody: - description: Notification endpoint to be created - content: - application/json: - schema: - $ref: '#/components/schemas/AppPkgNotification' - required: true - responses: - '204': - description: No Content - headers: {} - content: {} - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] -components: - schemas: - AppD: - title: AppD - required: - - appDId - - appDVersion - - appDescription - - appName - - appProvider - - appSoftVersion - - mecVersion - - swImageDescriptor - - virtualComputeDescriptor - type: object - properties: - appDId: - type: string - description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1. - appDNSRule: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DNSRuleDescriptor' - description: Describes DNS rules the MEC application requires. - appDVersion: - type: string - description: Identifies the version of the application descriptor. - appDescription: - type: string - description: Human readable description of the MEC application. - appExtCpd: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AppExternalCpd' - description: Describes external interface(s) exposed by this MEC application. - appFeatureOptional: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FeatureDependency' - description: Describes features a MEC application may use if available. - appFeatureRequired: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FeatureDependency' - description: Describes features a MEC application requires to run. - appInfoName: - type: string - description: Human readable name for the MEC application. - appLatency: - $ref: '#/components/schemas/LatencyDescriptor' - appName: - type: string - description: Name to identify the MEC application. - appProvider: - type: string - description: Provider of the application and of the AppD. - appServiceOptional: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ServiceDependency' - description: Describes services a MEC application may use if available. - appServiceProduced: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ServiceDescriptor' - description: Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps. - appServiceRequired: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ServiceDependency' - description: Describes services a MEC application requires to run. - appSoftVersion: - type: string - description: Identifies the version of software of the MEC application. - appTrafficRule: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TrafficRuleDescriptor' - description: Describes traffic rules the MEC application requires. - changeAppInstanceStateOpConfig: - type: string - description: NFV - mecVersion: - minItems: 1 - type: array - items: - type: string - description: Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. - swImageDescriptor: - type: string - description: Ref NFV - terminateAppInstanceOpConfig: - type: string - description: NFV - transportDependencies: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TransportDependency' - description: Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2. - virtualComputeDescriptor: - type: string - description: Ref NFV - virtualStorageDescriptor: - minItems: 0 - type: array - items: - type: string - description: Defines descriptors of virtual storage resources to be used by the MEC application. - AppExternalCpd: - title: AppExternalCpd - required: - - inherited_attributes - type: object - properties: - inherited_attributes: - type: object - description: All attributes inherited from Cpd. - virtualNetworkInterfaceRequirements: - minItems: 0 - type: array - items: - type: string - description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. - AppPkgInfo: - title: AppPkgInfo - required: - - id - - appDId - - appName - - appSoftwareVersion - - appDVersion - - checksum - - softwareImages - - onboardingState - - operationalState - - usageState - - _links - type: object - properties: - id: - type: string - description: Identifier of the onboarded application package. - appDId: - type: string - description: Identifier of this MEC application descriptor. This attribute shall be globally unique. - appProvider: - type: string - description: Provider of the application and of the AppD. - appName: - type: string - description: Name to identify the MEC application. - appSoftwareVersion: - type: string - description: Software version of the application. This is updated when there is any change to the software in the onboarded application package. - appDVersion: - type: string - description: Identifies the version of the application descriptor. - checksum: - $ref: '#/components/schemas/Checksum' - softwareImages: - type: object - description: Information of application software image in application package. Type is TBD - additionalArtifacts: - type: object - description: Additional information of application package artifacts that are not application software images. Type is TBD - onboardingState: - $ref: '#/components/schemas/OnboardingState' - operationalState: - $ref: '#/components/schemas/AppPkg.OperationalState' - usageState: - $ref: '#/components/schemas/UsageState' - userDefinedData: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - _links: - $ref: '#/components/schemas/AppPkgInfo.links' - description: "'The data type AppPkgInfo represents the parameters for an application package resource'" - AppPkgInfoModifications: - title: AppPkgInfoModifications - required: - - operationState - type: object - properties: - operationState: - $ref: '#/components/schemas/OperationState' - description: "'The data type represents the operational state for an application package resource'" - AppPkg.OperationalState: - title: AppPkg.OperationalState - enum: - - ENABLED - - DISABLED - type: string - description: 'Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.' - examples: - - ENABLED - OnboardingState: - title: OnboardingState - enum: - - CREATED - - UPLOADING - - PROCESSING - - ONBOARDED - type: string - description: Onboarding state of application package - examples: - - CREATED - UsageState: - title: UsageState - enum: - - IN_USE - - NOT_IN_USE - type: string - description: Usage state of the onboarded instance of the application package - examples: - - IN_USE - AppPkgInfo.links: - title: AppPkgInfo.links - required: - - self - - appD - - appPkgContent - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - appD: - $ref: '#/components/schemas/LinkType' - appPkgContent: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - AppPkgNotification: - title: AppPkgNotification - required: - - id - - notificationType - - subscriptionId - - timeStamp - - appPkgId - - appDId - - operationalState - - _links - type: object - properties: - id: - type: string - description: "''" - notificationType: - $ref: '#/components/schemas/AppPkg.NotificationType' - subscriptionId: - type: string - description: Identifier of the subscription related to this notification. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - appPkgId: - type: string - description: Identifier of the onboarded application package. - appDId: - type: string - description: Identifier of this MEC application descriptor. This attribute shall be globally unique. - operationalState: - $ref: '#/components/schemas/OperationalState' - _links: - $ref: '#/components/schemas/AppPkgNotification.links' - description: "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'" - AppPkg.NotificationType: - title: AppPkg.NotificationType - enum: - - AppPackageOnBoarded - - AppPacakgeEnabled - - AppPacakgeDisabled - - AppPackageDeleted - type: string - description: Discriminator for the different notification types - examples: - - AppPackageOnBoarded - AppPkgNotification.links: - title: AppPkgNotification.links - required: - - subscription - type: object - properties: - subscription: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - AppPkgSubscriptionInfo: - title: AppPkgSubscriptionInfo - required: - - id - - subscriptionType - - callbackUri - - _links - type: object - properties: - id: - type: string - description: "''" - subscriptionType: - $ref: '#/components/schemas/AppPkg.SubscriptionType' - callbackUri: - type: string - description: The URI of the endpoint for the notification to be sent to. - _links: - $ref: '#/components/schemas/AppPkgSubscriptionInfo.links' - description: "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'" - AppPkg.SubscriptionType: - title: AppPkg.SubscriptionType - enum: - - AppPackageOnBoarding - - AppPacakgeOperationChange - - AppPackageDeletion - type: string - description: Subscribed notification type. - examples: - - AppPackageOnBoarding - AppPkgSubscriptionInfo.links: - title: AppPkgSubscriptionInfo.links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - description: Links to resources related to this resource. - AppPkgSubscriptionLinkList: - title: AppPkgSubscriptionLinkList - required: - - _links - type: object - properties: - _links: - $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links' - description: "'The data type represents a subscription link list of notification on application package management'" - AppPkgSubscriptionLinkList.links: - title: AppPkgSubscriptionLinkList.links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - subscriptions: - type: array - items: - $ref: '#/components/schemas/Subscriptions.AppPkgSubscription' - description: '' - description: Links to resources related to this resource. - Subscriptions.AppPkgSubscription: - title: Subscriptions.AppPkgSubscription - required: - - href - - subsctiptionType - type: object - properties: - href: - type: string - description: The URI referring to the subscription. - subsctiptionType: - $ref: '#/components/schemas/SubsctiptionType.AppPkg' - description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" - AppPkgSubscription: - title: AppPkgSubscription - required: - - callbackUri - - subsctiptionType - type: object - properties: - callbackUri: - type: string - description: The URI of the endpoint for the notification to be sent to. - subsctiptionType: - $ref: '#/components/schemas/SubsctiptionType.AppPkg' - appPkgFilter: - type: array - items: - type: string - description: '' - description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" - SubsctiptionType.AppPkg: - title: SubsctiptionType.AppPkg - enum: - - AppPackageOnBoarding - - AppPacakgeOperationChange - - AppPackageDeletion - type: string - description: "'Subscribed notification type'" - examples: - - AppPackageOnBoarding - Checksum: - title: Checksum - required: - - algorithm - - hash - type: object - properties: - algorithm: - type: string - description: Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. - hash: - type: string - description: "'String 1 The hexadecimal value of the checksum'" - CreateAppPkg: - title: CreateAppPkg - required: - - appPkgName - - appPkgPath - - appPkgVersion - - checksum - type: object - properties: - appPkgName: - type: string - description: Name of the application package to be onboarded. - appPkgPath: - type: string - appPkgVersion: - type: string - description: >- - Version of the application package to be onboarded. - - The appPkgName with appPkgVersion can be used to uniquely identify the application package. - appProvider: - type: string - description: The provider's name of the application package to be onboarded. - checksum: - $ref: '#/components/schemas/Checksum' - userDefinedData: - type: object - description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" - DNSRuleDescriptor: - title: DNSRuleDescriptor - required: - - dnsRuleId - - domainName - - ipAddress - - ipAddressType - type: object - properties: - dnsRuleId: - type: string - description: Identifies the DNS Rule - domainName: - type: string - description: FQDN of the DNS rule - ipAddress: - type: string - description: IP address given by the DNS rule - ipAddressType: - $ref: '#/components/schemas/IpAddressType' - ttl: - type: integer - description: Time-to-live value - contentEncoding: int32 - IpAddressType: - title: IpAddressType - enum: - - IP_V6 - - IP_V4 - type: string - description: Specifies the IP address type - examples: - - IP_V6 - FeatureDependency: - title: FeatureDependency - required: - - featureName - - version - type: object - properties: - featureName: - type: string - description: The name of the feature, for example, UserApps, UEIdentity, etc. - version: - type: string - description: The version of the feature. - InterfaceDescriptor: - title: InterfaceDescriptor - required: - - interfaceType - type: object - properties: - dstIPAddress: - type: string - description: If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface. - dstMACAddress: - type: string - description: If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface. - interfaceType: - $ref: '#/components/schemas/InterfaceType' - srcMACAddress: - type: string - description: If the interface type is MAC, the source address identifies the MAC address of the interface. - tunnelInfo: - $ref: '#/components/schemas/TunnelInfo' - InterfaceType: - title: InterfaceType - enum: - - TUNNEL - - MAC - - IP - type: string - description: Type of interface. - examples: - - TUNNEL - LatencyDescriptor: - title: LatencyDescriptor - required: - - maxLatency - type: object - properties: - maxLatency: - type: integer - description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note. - contentEncoding: int32 - LinkType: - title: LinkType - required: - - href - type: object - properties: - href: - type: string - description: URI referring to a resource - ProblemDetails: - title: ProblemDetails - type: object - properties: - detail: - type: string - description: A human-readable explanation specific to this occurrence of the problem - instance: - type: string - description: A URI reference that identifies the specific occurrence of the problem - status: - type: integer - description: The HTTP status code for this occurrence of the problem - contentEncoding: int32 - title: - type: string - description: A short, human-readable summary of the problem type - type: - type: string - description: A URI reference according to IETF RFC 3986 that identifies the problem type - ServiceDependency: - title: ServiceDependency - required: - - serName - - version - type: object - properties: - requestedPermissions: - minItems: 0 - type: array - items: - type: string - description: >- - Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4]. - - The format of this attribute is left for the data model design stage. - serCategory: - type: object - description: See MEC011 - serName: - type: string - description: The name of the service, for example, RNIS, LocationService, etc. - serTransportDependencies: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TransportDependency' - description: Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note. - version: - type: string - description: The version of the service. - ServiceDescriptor: - title: ServiceDescriptor - required: - - serName - - version - type: object - properties: - serName: - type: string - description: The name of the service, for example, RNIS, LocationService, etc. - serCategory: - type: object - description: See MEC011 - version: - type: string - description: The version of the service. - transportsSupported: - $ref: '#/components/schemas/TransportsSupported' - description: "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'" - TransportsSupported: - title: TransportsSupported - type: object - properties: - transport: - $ref: '#/components/schemas/TransportDescriptor' - serializers: - minItems: 1 - type: array - items: - type: string - description: "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '" - description: "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'" - TimeStamp: - title: TimeStamp - required: - - nanoSeconds - - seconds - type: object - properties: - nanoSeconds: - type: integer - description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - contentEncoding: int32 - seconds: - type: integer - description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - contentEncoding: int32 - TrafficFilter: - title: TrafficFilter - type: object - properties: - dSCP: - type: integer - description: Used to match all IPv4 packets that have the same DSCP. - contentEncoding: int32 - dstAddress: - minItems: 0 - type: array - items: - type: string - description: A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes. - dstPort: - minItems: 0 - type: array - items: - type: string - description: A port or a range of ports. - dstTunnelPort: - minItems: 0 - type: array - items: - type: string - description: Used for GTP tunnel based traffic rule. - protocol: - minItems: 0 - type: array - items: - type: string - description: Specify the protocol of the traffic filter. - qCI: - type: integer - description: Used to match all packets that have the same QCI. - contentEncoding: int32 - srcAddress: - minItems: 0 - type: array - items: - type: string - description: An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes. - srcPort: - minItems: 0 - type: array - items: - type: string - description: A port or a range of ports. - srcTunnelAddress: - minItems: 0 - type: array - items: - type: string - description: Used for GTP tunnel based traffic rule. - srcTunnelPort: - minItems: 0 - type: array - items: - type: string - description: Used for GTP tunnel based traffic rule. - tC: - type: integer - description: Used to match all IPv6 packets that have the same TC. - contentEncoding: int32 - tag: - minItems: 0 - type: array - items: - type: string - description: Used for tag based traffic rule. - tgtTunnelAddress: - minItems: 0 - type: array - items: - type: string - description: Used for GTP tunnel based traffic rule. - TrafficRuleDescriptor: - title: TrafficRuleDescriptor - required: - - action - - filterType - - priority - - trafficFilter - - trafficRuleId - type: object - properties: - action: - $ref: '#/components/schemas/Action' - dstInterface: - maxItems: 2 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/InterfaceDescriptor' - description: '' - filterType: - $ref: '#/components/schemas/FilterType' - priority: - type: integer - description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence. - contentEncoding: int32 - trafficFilter: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/TrafficFilter' - description: The filter used to identify specific flow/packets that need to be handled by the MEC host. - trafficRuleId: - type: string - description: Identifies the traffic rule. - Action: - title: Action - enum: - - DROP - - FORWARD_DECAPSULATED - - FORWARD_AS_IS - - PASSTHROUGH - - DUPLICATED_DECAPSULATED - - DUPLICATE_AS_IS - type: string - description: "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'" - examples: - - DROP - FilterType: - title: FilterType - enum: - - FLOW - - PACKET - type: string - description: 'Definition of filter type: per FLOW or PACKET' - examples: - - FLOW - TransportDependency: - title: TransportDependency - required: - - labels - - serializers - - transport - type: object - properties: - labels: - minItems: 1 - type: array - items: - type: string - description: Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table. - serializers: - minItems: 1 - type: array - items: - type: string - description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport. - transport: - $ref: '#/components/schemas/TransportDescriptor' - TransportDescriptor: - title: TransportDescriptor - required: - - protocol - - security - - type - - version - type: object - properties: - protocol: - type: string - description: The name of the protocol used. Shall be set to HTTP for a REST API. - security: - type: object - description: See MEC011 - type: - type: string - version: - type: string - description: The version of the protocol used. - TunnelInfo: - title: TunnelInfo - required: - - tunnelDstAddress - - tunnelSrcAddress - - tunnelType - type: object - properties: - tunnelDstAddress: - type: string - description: Destination address of the tunnel. - tunnelSpecificData: - type: string - tunnelSrcAddress: - type: string - description: Source address of the tunnel. - tunnelType: - $ref: '#/components/schemas/TunnelType' - TunnelType: - title: TunnelType - enum: - - GTP-U - - GRE - type: string - description: Type of tunnel. - examples: - - GTP-U - OperationalState: - title: OperationalState - enum: - - DISABLED - - ENABLED - type: string - examples: - - DISABLED - OperationState: - title: OperationState - enum: - - DISABLED - - ENABLED - type: string - examples: - - DISABLED -security: -- {} -tags: -- name: app-pkgm - description: App Package management -- name: app-pkgm-notifications - description: App Package management notifications -externalDocs: - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf -- GitLab From d69ec6c2d1134a2094a7814d1a3d74c7e563d3e4 Mon Sep 17 00:00:00 2001 From: piscione Date: Fri, 26 Nov 2021 13:10:07 +0100 Subject: [PATCH 3/4] Updated specifications: fix on examples, callback and minor. --- MEC010-2_AppGrant.yaml | 45 +++++++---------- MEC010-2_AppLcm.yaml | 101 +++++++++++++++++++++++---------------- MEC010-2_AppPkgMgmt.yaml | 100 +++++++++++++++++++++----------------- 3 files changed, 134 insertions(+), 112 deletions(-) diff --git a/MEC010-2_AppGrant.yaml b/MEC010-2_AppGrant.yaml index 3e2a75f..8b3bb78 100644 --- a/MEC010-2_AppGrant.yaml +++ b/MEC010-2_AppGrant.yaml @@ -2,26 +2,35 @@ openapi: 3.1.0 info: title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' + version: '2.1.1' + license: + name: BSD-3-Clause + url: https://forge.etsi.org/legal-matters contact: name: ETSI Forge url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api email: cti_support@etsi.org - version: '2.1.1' +externalDocs: + description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - url: https://localhost/granting/v1 variables: {} +tags: + - name: granting + description: Grant operations paths: /grants: post: tags: - granting - summary: grantPOST + summary: 'requests a grant for a particular application lifecycle operation' description: requests a grant for a particular application lifecycle operation operationId: grantPOST parameters: [] requestBody: - description: '' + content: application/json: schema: @@ -87,7 +96,7 @@ paths: get: tags: - granting - summary: GrantGET + summary: 'read the grant' description: read the grant operationId: GrantGET parameters: @@ -100,7 +109,7 @@ paths: type: string responses: '200': - description: IA representation of the "individual grant" resource + description: A representation of the "individual grant" resource headers: {} content: application/json: @@ -322,25 +331,9 @@ components: softwareImages: type: array items: - $ref: '#/components/schemas/SoftwareImages' + $ref: '#/components/schemas/VimSoftwareImage' description: '' description: Information about assets for the application that are managed by the MEO in the VIM, such as software images. - SoftwareImages: - title: SoftwareImages - required: - - appDSoftwareImageId - - vimSoftwareImageId - type: object - properties: - appDSoftwareImageId: - type: string - description: Identifier which references the software image descriptor in the AppD. - vimConnectionId: - type: string - description: Identifier of the VIM connection to access the software image referenced in this structure. - vimSoftwareImageId: - type: string - description: Identifier of the software image in the resource management layer (i.e. VIM). Grant.links: title: Grant.links required: @@ -648,10 +641,4 @@ components: type: string description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM). security: -- {} -tags: -- name: granting - description: Grant operations -externalDocs: - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf +- {} \ No newline at end of file diff --git a/MEC010-2_AppLcm.yaml b/MEC010-2_AppLcm.yaml index a792a8d..76a5176 100644 --- a/MEC010-2_AppLcm.yaml +++ b/MEC010-2_AppLcm.yaml @@ -2,12 +2,24 @@ openapi: 3.1.0 info: title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' contact: name: ETSI Forge url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api email: cti_support@etsi.org version: '2.1.1' + +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema +tags: +- name: app-lcm + description: App lifecycle management +- name: app-lcm-notifications + description: App lifecycle management notifications servers: - url: https://localhost/app_lcm/v1 variables: {} @@ -15,8 +27,8 @@ paths: /app_instances: post: tags: - - '' - summary: appInstancePOST + - 'app-lcm' + summary: 'Create an application instance resource' description: Create an application instance resource operationId: appInstancePOST parameters: [] @@ -32,11 +44,9 @@ paths: description: An application instance identifier and the related resource has been created successfully. headers: {} content: - application/zip: + application/json: schema: - type: object - description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" - contentMediaType: application/zip + $ref: '#/components/schemas/AppInstanceInfo' '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -82,8 +92,8 @@ paths: deprecated: false get: tags: - - '' - summary: appInstanceGET + - 'app-lcm' + summary: 'Queries information relating to on-boarded application packages in the MEO' description: queries information relating to on-boarded application packages in the MEO operationId: appInstanceGET parameters: @@ -181,8 +191,8 @@ paths: /app_instances/{appInstanceId}: get: tags: - - '' - summary: appInstanceIdGET + - 'app-lcm' + summary: 'Retrieves the information of an individual application instance via reading an individual application instance.' description: Retrieves the information of an individual application instance via reading an individual application instance. operationId: appInstanceIdGET parameters: @@ -246,8 +256,8 @@ paths: deprecated: false delete: tags: - - '' - summary: appInstanceIdDELETE + - 'app-lcm' + summary: 'Deletes an individual application instance resource.' description: Deletes an individual application instance resource. operationId: appInstanceIdDELETE parameters: @@ -317,8 +327,8 @@ paths: /subscriptions: post: tags: - - '' - summary: appLcmSubscriptionsPOST + - 'app-lcm-notifications' + summary: 'subscribe to the notification of application instance operational state change' description: subscribe to the notification of application instance operational state change operationId: appLcmSubscriptionsPOST parameters: @@ -399,11 +409,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' + callbacks: + notification: + '{$request.body#/callbackUri}': + post: + summary: 'Callback POST used to send a notification' + description: 'Notification for informing the subscribers about operational state of application instance resources or state changes of an application LCM operation occurrence. It depends on subscription type.' + operationId: notificationPOST + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstNotification' + - $ref: '#/components/schemas/AppLcmOpOccNotification' + responses: + '204': + description: "No content" deprecated: false get: tags: - - '' - summary: appLcmSubscriptionsGET + - 'app-lcm-notifications' + summary: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.' description: Retrieves the information of multiple subscriptions to notifications related to an application instance. operationId: appLcmSubscriptionsGET parameters: @@ -469,8 +498,8 @@ paths: /subscriptions/{subscriptionId}: get: tags: - - '' - summary: individualSubscriptionGET + - 'app-lcm-notifications' + summary: 'Used to represent an individual subscription to notifications about application package changes.' description: Used to represent an individual subscription to notifications about application package changes. operationId: individualSubscriptionGET parameters: @@ -545,8 +574,8 @@ paths: deprecated: false delete: tags: - - '' - summary: individualSubscriptionDELETE + - 'app-lcm-notifications' + summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' description: Deletes the individual subscription to notifications about application package changes in MEO. operationId: individualSubscriptionDELETE parameters: @@ -595,8 +624,8 @@ paths: /user_defined_notification: post: tags: - - '' - summary: appInstNotificationPOST + - 'app-lcm-notifications' + summary: 'Delivers a notification from the application lifecycle management resource to the subscriber.' description: Delivers a notification from the application lifecycle management resource to the subscriber. operationId: appInstNotificationPOST parameters: [] @@ -655,8 +684,8 @@ paths: /app_instances/{appInstanceId}/instantiate: post: tags: - - '' - summary: appLcmInstanciatePOST + - 'app-lcm' + summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' description: task of instantiating an application instance. operationId: appLcmInstanciatePOST parameters: @@ -733,8 +762,8 @@ paths: /app_instances/{appInstanceId}/terminate: post: tags: - - '' - summary: appLcmTerminatePOST + - 'app-lcm' + summary: 'terminate an application instance.' description: terminate an application instance. operationId: appLcmTerminatePOST parameters: @@ -811,8 +840,8 @@ paths: /app_instances/{appInstanceId}/operate: post: tags: - - '' - summary: appLcmOperatePOST + - 'app-lcm' + summary: 'change the operational state, i.e. start or stop, of the application instance' description: change the operational state, i.e. start or stop, of the application instance operationId: appLcmOperatePOST parameters: @@ -889,8 +918,8 @@ paths: /app_lcm_op_occs: get: tags: - - '' - summary: appLcmOpOccsGET + - 'app-lcm' + summary: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences' description: retrieves information of operation status about multiple application instance lifecycle management operation occurrences operationId: appLcmOpOccsGET parameters: @@ -988,8 +1017,8 @@ paths: /app_lcm_op_occs/{appLcmOpOccId}: get: tags: - - '' - summary: appLcmOpOccsbyIdGET + - 'app-lcm' + summary: 'reads the status information of an individual application LCM operation occurrence' description: reads the status information of an individual application LCM operation occurrence operationId: appLcmOpOccsbyIdGET parameters: @@ -1822,11 +1851,3 @@ components: - AppInstanceStateChange security: - {} -tags: -- name: app-lcm - description: App lifecycle management -- name: app-lcm-notifications - description: App lifecycle management notifications -externalDocs: - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf diff --git a/MEC010-2_AppPkgMgmt.yaml b/MEC010-2_AppPkgMgmt.yaml index b5a46fc..f12fde3 100644 --- a/MEC010-2_AppPkgMgmt.yaml +++ b/MEC010-2_AppPkgMgmt.yaml @@ -2,12 +2,24 @@ openapi: 3.1.0 info: title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management' description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.' + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' contact: name: ETSI Forge url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api email: cti_support@etsi.org version: '2.1.1' jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema + +externalDocs: + description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf +tags: +- name: app-pkgm + description: App Package management +- name: app-pkgm-notifications + description: App Package management notifications servers: - url: https://localhost/app_pkgm/v1 variables: {} @@ -16,7 +28,7 @@ paths: post: tags: - app-pkgm - summary: app_packagesPOST + summary: 'Create a resource for on-boarding an application package to a MEO' description: Create a resource for on-boarding an application package to a MEO operationId: app_packagesPOST parameters: [] @@ -85,7 +97,7 @@ paths: get: tags: - app-pkgm - summary: app_packagesGET + summary: Queries information relating to on-boarded application packages in the MEO' description: queries information relating to on-boarded application packages in the MEO operationId: app_packagesGET parameters: @@ -184,7 +196,7 @@ paths: get: tags: - app-pkgm - summary: app_packageGET + summary: 'Queries the information related to individual application package resources' description: Queries the information related to individual application package resources operationId: app_packageGET parameters: @@ -249,7 +261,7 @@ paths: delete: tags: - app-pkgm - summary: app_packageDELETE + summary: 'Deletes an individual application package resources' description: Deletes an individual application package resources operationId: app_packageDELETE parameters: @@ -311,7 +323,7 @@ paths: patch: tags: - app-pkgm - summary: app_packagePATCH + summary: 'Updates the operational state of an individual application package resource' description: Updates the operational state of an individual application package resources operationId: app_packagePATCH parameters: @@ -392,7 +404,7 @@ paths: post: tags: - app-pkgm - summary: subscriptionsPOST + summary: 'Subscribe to notifications about on-boarding an application package' description: Subscribe to notifications about on-boarding an application package operationId: subscriptionsPOST parameters: [] @@ -453,11 +465,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - deprecated: false + callbacks: + notification: + '{$request.body#/subscription.href}': + post: + summary: 'Callback POST used to send a notification' + description: ' The notification is triggered when a new application package is onboarded' + operationId: notificationPOST + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgNotification' + responses: + '204': + description: "No content" get: tags: - app-pkgm - summary: subscriptionsGET + summary: 'used to retrieve the information of subscriptions to individual application package resource in MEO' description: used to retrieve the information of subscriptions to individual application package resource in MEO package operationId: subscriptionsGET parameters: [] @@ -517,7 +545,7 @@ paths: get: tags: - app-pkgm - summary: individualSubscriptionGET + summary: 'Used to represent an individual subscription to notifications about application package changes.' description: Used to represent an individual subscription to notifications about application package changes. operationId: individualSubscriptionGET parameters: @@ -582,7 +610,7 @@ paths: delete: tags: - app-pkgm - summary: individualSubscriptionDELETE + summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' description: Deletes the individual subscription to notifications about application package changes in MEO. operationId: individualSubscriptionDELETE parameters: @@ -632,7 +660,7 @@ paths: get: tags: - app-pkgm - summary: appPkgIdGET + summary: 'Reads the content of the AppD of on-boarded individual application package resources.' description: Reads the content of the AppD of on-boarded individual application package resources. operationId: appPkgIdGET parameters: @@ -686,10 +714,7 @@ paths: text/plain: schema: $ref: '#/components/schemas/AppD' - application/zip: - schema: - type: object - contentMediaType: application/zip + application/zip: {} '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -738,7 +763,7 @@ paths: get: tags: - app-pkgm - summary: appDGET + summary: 'Reads the content of the AppD of on-boarded individual application package resources.' description: Reads the content of the AppD of on-boarded individual application package resources. operationId: appDGET parameters: @@ -792,10 +817,7 @@ paths: text/plain: schema: $ref: '#/components/schemas/AppD' - application/zip: - schema: - type: object - contentMediaType: application/zip + application/zip: {} '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -844,7 +866,7 @@ paths: get: tags: - app-pkgm - summary: appPkgGET + summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.' description: Fetch the onboarded application package content identified by appPkgId or appDId. operationId: appPkgGET parameters: @@ -859,11 +881,13 @@ paths: '200': description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD. headers: {} - content: {} + content: + application/zip: {} '206': description: Partial content headers: {} - content: {} + content: + application/zip: {} '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -914,7 +938,7 @@ paths: put: tags: - app-pkgm - summary: appPkgPUT + summary: 'Uploads the content of application package.' description: Uploads the content of application package. operationId: appPkgPUT parameters: @@ -928,10 +952,7 @@ paths: requestBody: description: '' content: - text/plain: - schema: - type: object - contentMediaType: text/plain + application/zip: {} required: false responses: '202': @@ -993,7 +1014,7 @@ paths: get: tags: - app-pkgm - summary: appDIdGET + summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.' description: Fetch the onboarded application package content identified by appPkgId or appDId. operationId: appDIdGET parameters: @@ -1063,7 +1084,7 @@ paths: put: tags: - app-pkgm - summary: appDIdPUT + summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.' description: Uploads the content of application package. operationId: appDIdPUT parameters: @@ -1077,10 +1098,7 @@ paths: requestBody: description: '' content: - text/plain: - schema: - type: object - contentMediaType: text/plain + application/zip: {} required: false responses: '202': @@ -1138,11 +1156,14 @@ paths: $ref: '#/components/schemas/ProblemDetails' deprecated: false parameters: [] +############################################################################### +# Notification endpoint AppPkgNotification # +############################################################################### /user_defined_notification: post: tags: - app-pkgm-notifications - summary: app_pkg_notificationPOST + summary: 'Registers a notification endpoint to notify application package operations' description: Registers a notification endpoint to notify application package operations operationId: app_pkg_notificationPOST parameters: [] @@ -2036,11 +2057,4 @@ components: - DISABLED security: - {} -tags: -- name: app-pkgm - description: App Package management -- name: app-pkgm-notifications - description: App Package management notifications -externalDocs: - description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1' - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf + -- GitLab From f0a32cd6151f9b3814d7314b371ab1a15a423342 Mon Sep 17 00:00:00 2001 From: piscione Date: Thu, 2 Dec 2021 19:32:03 +0100 Subject: [PATCH 4/4] Update JSON version of OAS3.1.0. --- MEC010-2_AppGrant.json | 905 ++++++------ MEC010-2_AppLcm.json | 2334 ++++++++++++++++++++----------- MEC010-2_AppPkgMgmt.json | 2820 +++++++++++++++++++++++--------------- 3 files changed, 3629 insertions(+), 2430 deletions(-) diff --git a/MEC010-2_AppGrant.json b/MEC010-2_AppGrant.json index e8e3ad8..e4ffcfc 100644 --- a/MEC010-2_AppGrant.json +++ b/MEC010-2_AppGrant.json @@ -1,28 +1,30 @@ { + "openapi": "3.1.0", "info": { "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management", - "version": "2.1.1", "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.", + "version": "2.1.1", "license": { "name": "BSD-3-Clause", "url": "https://forge.etsi.org/legal-matters" }, "contact": { "name": "ETSI Forge", - "email": "cti_support@etsi.org", - "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api" + "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api", + "email": "cti_support@etsi.org" } }, "externalDocs": { "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1", "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf" }, + "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { - "url": "https://localhost/granting/v1" + "url": "https://localhost/granting/v1", + "variables": {} } ], - "openapi": "3.0.0", "tags": [ { "name": "granting", @@ -38,19 +40,21 @@ "summary": "requests a grant for a particular application lifecycle operation", "description": "requests a grant for a particular application lifecycle operation", "operationId": "grantPOST", + "parameters": [], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRequest" } } - } + }, + "required": true }, "responses": { "201": { "description": "grant was created successfully (synchronous mode)", + "headers": {}, "content": { "application/json": { "schema": { @@ -60,41 +64,82 @@ } }, "202": { - "description": "the request was accepted for processing" + "description": "the request was accepted for processing", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/grants/{grantId}": { - "parameters": [ - { - "in": "path", - "name": "grantId", - "description": "Identifier of the individual grant.", - "schema": { - "type": "string" - }, - "required": true - } - ], "get": { "tags": [ "granting" @@ -102,9 +147,22 @@ "summary": "read the grant", "description": "read the grant", "operationId": "GrantGET", + "parameters": [ + { + "name": "grantId", + "in": "path", + "description": "Identifier of the individual grant.", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "IA representation of the \"individual grant\" resource ", + "description": "A representation of the \"individual grant\" resource", + "headers": {}, "content": { "application/json": { "schema": { @@ -114,116 +172,148 @@ } }, "202": { - "description": "returned when the process of creating the grant is ongoing, no grant is available yet" + "description": "returned when the process of creating the grant is ongoing, no grant is available yet", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] } }, "components": { "schemas": { "AppExtCpConfig": { + "title": "AppExtCpConfig", + "type": "object", "properties": { "cpInstanceId": { - "description": "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created. ", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created." }, "cpProtocolData": { - "description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/CpProtocolData" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "CpProtocolData" + "description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note." }, "linkPortId": { - "description": "Identifier of a pre-configured link port to which the external CP will be associated. See note.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of a pre-configured link port to which the external CP will be associated. See note." } - }, - "type": "object", - "x-etsi-notes": "NOTE:\tThe following conditions apply to the attributes \"linkPortId\" and \" cpProtocolData\": \nThe \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. \nAt least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance.\nIf the \"linkPortId\" attribute is absent, the MEPM shall create a link port.\nIf the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port, and the MEPM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port.\nIf both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by \"linkPortId\".", - "x-etsi-ref": "6.2.4.13" + } }, "AppExtCpData": { + "title": "AppExtCpData", + "required": [ + "cpConfig", + "cpdId" + ], + "type": "object", "properties": { "cpConfig": { - "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.", + "minItems": 1, + "type": "array", "items": { "$ref": "#/components/schemas/AppExtCpConfig" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "AppExtCpConfig" + "description": "List of instance data that need to be configured on the CP instances created from the respective CPD." }, "cpdId": { - "description": "The identifier of the CPD in the AppD.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the CPD in the AppD." } - }, - "required": [ - "cpdId", - "cpConfig" - ], - "type": "object", - "x-etsi-ref": "6.2.4.12" - }, - "AppInstanceId": { - "description": "Identifier of application instance.", - "type": "string" - }, - "AppDId": { - "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.", - "type": "string" - }, - "AppLcmOpOccId": { - "description": "Identifier of application lifecycle management operation occurrence.", - "type": "string" - }, - "KeyValuePairs": { - "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'", - "type": "object", - "additionalProperties": true + } }, "ResourceDefinition.Type": { - "description": "Type of the resource definition referenced.", - "type": "string", - "format": "enum", + "title": "ResourceDefinition.Type", "enum": [ "COMPUTE", "VL", "STORAGE", "LINKPORT" + ], + "type": "string", + "description": "Type of the resource definition referenced.", + "examples": [ + "COMPUTE" ] }, "CpProtocolData": { + "title": "CpProtocolData", + "required": [ + "layerProtocol" + ], + "type": "object", "properties": { "ipOverEthernet": { "$ref": "#/components/schemas/IpOverEthernetAddressData" @@ -231,142 +321,133 @@ "layerProtocol": { "$ref": "#/components/schemas/IpOverEthernetAddressData" } - }, + } + }, + "ExtLinkPortData": { + "title": "ExtLinkPortData", "required": [ - "layerProtocol" + "id", + "resourceHandle" ], "type": "object", - "x-etsi-notes": "NOTE:\tThis attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.", - "x-etsi-ref": "6.2.4.14" - }, - "ExtLinkPortData": { "properties": { "id": { - "description": "Identifier of this link port as provided by the entity that has created the link port.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of this link port as provided by the entity that has created the link port." }, "resourceHandle": { "$ref": "#/components/schemas/ResourceHandle" } - }, + } + }, + "ExtVirtualLinkData": { + "title": "ExtVirtualLinkData", "required": [ + "extCps", "id", - "resourceHandle" + "resourceId" ], "type": "object", - "x-etsi-ref": "6.2.4.9" - }, - "ExtVirtualLinkData": { "properties": { "extCps": { - "description": "External CPs of the application instance to be connected to this external VL.", + "minItems": 1, + "type": "array", "items": { "$ref": "#/components/schemas/AppExtCpData" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "AppExtCpData" + "description": "External CPs of the application instance to be connected to this external VL." }, "extLinkPorts": { - "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/ExtLinkPortData" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "ExtLinkPortData" + "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL." }, "id": { - "description": "The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance." }, "resourceId": { - "description": "The identifier of the resource in the scope of the VIM.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the resource in the scope of the VIM." }, "vimConnectionId": { - "description": "Identifier of the VIM connection to manage this resource. ", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the VIM connection to manage this resource." } - }, - "required": [ - "id", - "resourceId", - "extCps" - ], - "type": "object", - "x-etsi-ref": "6.2.4.8" + } }, "Grant": { - "description": "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '", - "type": "object", + "title": "Grant", "required": [ "id", "appInstanceId", "appLcmOpOccId", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/Grant.Id" + "type": "string" }, "appInstanceId": { - "$ref": "#/components/schemas/AppInstanceId" + "type": "string", + "description": "Identifier of application instance." }, "appLcmOpOccId": { - "$ref": "#/components/schemas/AppLcmOpOccId" + "type": "string", + "description": "Identifier of application lifecycle management operation occurrence." }, "vimConnections": { "type": "array", "items": { "$ref": "#/components/schemas/VimConnectionInfo" - } + }, + "description": "" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneInfo" - } + }, + "description": "" }, "zoneGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneGroupInfo" - } + }, + "description": "" }, "addResources": { "type": "array", "items": { "$ref": "#/components/schemas/GrantInfo" - } + }, + "description": "" }, "tempResources": { "type": "array", "items": { "$ref": "#/components/schemas/GrantInfo" - } + }, + "description": "" }, "removeResources": { "type": "array", "items": { "$ref": "#/components/schemas/GrantInfo" - } + }, + "description": "" }, "updateResources": { "type": "array", "items": { "$ref": "#/components/schemas/GrantInfo" - } + }, + "description": "" }, "vimAssets": { "$ref": "#/components/schemas/VimAssets" @@ -375,41 +456,40 @@ "type": "array", "items": { "$ref": "#/components/schemas/ExtVirtualLinkData" - } + }, + "description": "" }, "additionalParams": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "_links": { "$ref": "#/components/schemas/Grant.links" } - } - }, - "Grant.Id": { - "type": "string" + }, + "description": "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '" }, "VimAssets": { - "description": "Information about assets for the application that are managed by the MEO in the VIM, such as software images.", + "title": "VimAssets", "type": "object", "properties": { "softwareImages": { "type": "array", "items": { - "$ref": "#/components/schemas/SoftwareImages" - } + "$ref": "#/components/schemas/VimSoftwareImage" + }, + "description": "" } - } - }, - "SoftwareImages": { - "$ref": "#/components/schemas/VimSoftwareImage" + }, + "description": "Information about assets for the application that are managed by the MEO in the VIM, such as software images." }, "Grant.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "Grant.links", "required": [ "appLcmOpOcc", "appInstance" ], + "type": "object", "properties": { "appLcmOpOcc": { "$ref": "#/components/schemas/LinkType" @@ -417,44 +497,36 @@ "appInstance": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "GrantInfo": { + "title": "GrantInfo", + "required": [ + "resourceDefinitionId" + ], + "type": "object", "properties": { "resourceDefinitionId": { - "description": "Identifier of the related \"ResourceDefinition\" structure from the related \"GrantRequest\" structure.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the related \"ResourceDefinition\" structure from the related \"GrantRequest\" structure." }, "resourceGroupId": { - "description": "Identifier of the \"infrastructure resource group\", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by \"vimConnectionId\" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by \"vimConnectionId\" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the \"infrastructure resource group\", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by \"vimConnectionId\" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by \"vimConnectionId\" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated." }, "vimConnectionId": { - "description": "Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated." }, "zoneId": { - "description": "Reference to the identifier of the \"ZoneInfo\" structure in the \"Grant\" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Reference to the identifier of the \"ZoneInfo\" structure in the \"Grant\" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated." } - }, - "required": [ - "resourceDefinitionId" - ], - "type": "object", - "x-etsi-ref": "6.2.4.5" + } }, "GrantRequest": { - "description": "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'", - "type": "object", + "title": "GrantRequest", "required": [ "appInstanceId", "appLcmOpOccId", @@ -462,15 +534,19 @@ "operation", "_links" ], + "type": "object", "properties": { "appInstanceId": { - "$ref": "#/components/schemas/AppInstanceId" + "type": "string", + "description": "Identifier of application instance." }, "appLcmOpOccId": { - "$ref": "#/components/schemas/AppLcmOpOccId" + "type": "string", + "description": "Identifier of application lifecycle management operation occurrence." }, "appDId": { - "$ref": "#/components/schemas/AppDId" + "type": "string", + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique." }, "operation": { "$ref": "#/components/schemas/GrantRequest.Operation" @@ -479,50 +555,60 @@ "type": "array", "items": { "$ref": "#/components/schemas/ResourceDefinition" - } + }, + "description": "" }, "tempResources": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceDefinition" - } + }, + "description": "" }, "removeResources": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceDefinition" - } + }, + "description": "" }, "updateResources": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceDefinition" - } + }, + "description": "" }, "additionalParams": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "_links": { "$ref": "#/components/schemas/GrantRequest.links" } - } + }, + "description": "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'" }, "GrantRequest.Operation": { - "description": "'The lifecycle management operation for which granting is requested'", - "type": "string", + "title": "GrantRequest.Operation", "enum": [ "INSTANTIATE", "OPERATE", "TERMINATE" + ], + "type": "string", + "description": "'The lifecycle management operation for which granting is requested'", + "examples": [ + "INSTANTIATE" ] }, "GrantRequest.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "GrantRequest.links", "required": [ "appLcmOpOcc", "appInstance" ], + "type": "object", "properties": { "appLcmOpOcc": { "$ref": "#/components/schemas/LinkType" @@ -530,490 +616,297 @@ "appInstance": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "IpOverEthernetAddressData": { - "description": "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'", + "title": "IpOverEthernetAddressData", "type": "object", "properties": { "macAddress": { - "$ref": "#/components/schemas/MacAddress" + "type": "string", + "description": "'MAC address. If this attribute is not present, it shall be chosen by the VIM'" }, "ipAddresses": { - "$ref": "#/components/schemas/IpAddresses" + "type": "array", + "items": { + "$ref": "#/components/schemas/IpAddress" + }, + "description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet." } - } - }, - "MacAddress": { - "description": "'MAC address. If this attribute is not present, it shall be chosen by the VIM'", - "type": "string" - }, - "IpAddresses": { - "description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.", - "type": "array", - "items": { - "$ref": "#/components/schemas/IpAddress" - } + }, + "description": "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'" }, "IpAddress": { - "description": "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'", - "type": "object", + "title": "IpAddress", "required": [ "type" ], + "type": "object", "properties": { "type": { "$ref": "#/components/schemas/IpAddress.Type" }, "fixedAddresses": { - "$ref": "#/components/schemas/FixedAddresses" + "type": "array", + "items": { + "type": "string" + }, + "description": "Fixed addresses to assign (from the subnet defined by subnetId if provided)." }, "numDynamicAddresses": { - "$ref": "#/components/schemas/NumDynamicAddresses" + "type": "integer", + "description": "Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)", + "contentEncoding": "int32" }, "addressRange": { "$ref": "#/components/schemas/AddressRange" }, "subnetId": { - "$ref": "#/components/schemas/SubnetId" + "type": "string", + "description": "Subnet defined by the identifier of the subnet resource in the VIM." } - } + }, + "description": "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'" }, "IpAddress.Type": { - "description": "The type of the IP addresses.", - "type": "string", + "title": "IpAddress.Type", "enum": [ "IPV4", "IPV6" + ], + "type": "string", + "description": "The type of the IP addresses.", + "examples": [ + "IPV4" ] }, - "FixedAddresses": { - "description": "Fixed addresses to assign (from the subnet defined by subnetId if provided).", - "type": "array", - "items": { - "$ref": "#/components/schemas/FixedAddress" - } - }, - "NumDynamicAddresses": { - "description": "Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)", - "type": "integer" - }, "AddressRange": { - "description": "An IP address range to be used, e.g. in case of egress connections.", - "type": "object", + "title": "AddressRange", "required": [ "minAddress", "maxAddress" ], + "type": "object", "properties": { "minAddress": { - "$ref": "#/components/schemas/MinAddress" + "type": "string", + "description": "Lowest IP address belonging to the range." }, "maxAddress": { - "$ref": "#/components/schemas/MaxAddress" - } - } - }, - "MinAddress": { - "description": "Lowest IP address belonging to the range.", - "type": "string" - }, - "MaxAddress": { - "description": "Highest IP address belonging to the range.", - "type": "string" - }, - "FixedAddress": { - "description": "Fixed addresses to assign (from the subnet defined by subnetId if provided)", - "type": "string" - }, - "SubnetId": { - "description": "Subnet defined by the identifier of the subnet resource in the VIM.", - "type": "string" - }, - "LinkType": { - "properties": { - "href": { - "description": "URI referring to a resource", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" + "description": "Highest IP address belonging to the range." } }, + "description": "An IP address range to be used, e.g. in case of egress connections." + }, + "LinkType": { + "title": "LinkType", "required": [ "href" ], "type": "object", - "x-etsi-ref": "6.5.2" + "properties": { + "href": { + "type": "string", + "description": "URI referring to a resource" + } + } }, "ProblemDetails": { + "title": "ProblemDetails", + "type": "object", "properties": { "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "A human-readable explanation specific to this occurrence of the problem" }, "instance": { - "description": "A URI reference that identifies the specific occurrence of the problem", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" + "description": "A URI reference that identifies the specific occurrence of the problem" }, "status": { - "description": "The HTTP status code for this occurrence of the problem", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The HTTP status code for this occurrence of the problem", + "contentEncoding": "int32" }, "title": { - "description": "A short, human-readable summary of the problem type", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "A short, human-readable summary of the problem type" }, "type": { - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" } - }, - "type": "object" + } }, "ResourceDefinition": { - "description": "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '", - "type": "object", + "title": "ResourceDefinition", "required": [ "id", "type", "resourceTemplateId", "resource" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/ResourceDefinitionId" + "type": "string", + "description": "Identifier of the related ResourceDefinition structure from the related GrantRequest structure." }, "type": { "$ref": "#/components/schemas/ResourceDefinition.Type" }, "vduId": { - "$ref": "#/components/schemas/VduId" + "type": "string", + "description": "Reference to the related VDU in the AppD applicable to this resource." }, "resourceTemplateId": { - "$ref": "#/components/schemas/ResourceTemplateId" + "type": "string", + "description": "Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD." }, "resource": { "$ref": "#/components/schemas/Resource" } - } - }, - "ResourceDefinitionId": { - "description": "Identifier of the related ResourceDefinition structure from the related GrantRequest structure.", - "type": "string" - }, - "VduId": { - "description": "Reference to the related VDU in the AppD applicable to this resource.", - "type": "string" - }, - "ResourceTemplateId": { - "description": "Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD.", - "type": "string" + }, + "description": "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '" }, "Resource": { - "description": "Resource information for an existing resource", - "type": "object", + "title": "Resource", "required": [ "vimConnectionInfo", "resourceId" ], + "type": "object", "properties": { "vimConnectionInfo": { "$ref": "#/components/schemas/VimConnectionInfo" }, "resourceId": { - "$ref": "#/components/schemas/ResourceId" + "type": "string", + "description": "Identifier of the resource in the scope of the VIM." } - } - }, - "ResourceId": { - "description": "Identifier of the resource in the scope of the VIM.", - "type": "string" + }, + "description": "Resource information for an existing resource" }, "ResourceHandle": { + "title": "ResourceHandle", + "required": [ + "resourceId" + ], + "type": "object", "properties": { "resourceId": { - "description": "Identifier of the resource in the scope of the VIM.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the resource in the scope of the VIM." }, "vimConnectionId": { - "description": "Identifier of the VIM connection to manage the resource.The applicable \"VimConnectionInfo\" structure, which is referenced by vimConnectionId, can be obtained from the \"vimConnectionInfo\" attribute of the \"AppInstance\" structure.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the VIM connection to manage the resource.The applicable \"VimConnectionInfo\" structure, which is referenced by vimConnectionId, can be obtained from the \"vimConnectionInfo\" attribute of the \"AppInstance\" structure." }, "vimLevelResourceType": { - "description": "Type of the resource in the scope of the VIM. See note.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Type of the resource in the scope of the VIM. See note." } - }, + } + }, + "VimConnectionInfo": { + "title": "VimConnectionInfo", "required": [ - "resourceId" + "id", + "vimType" ], "type": "object", - "x-etsi-notes": "NOTE:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition.", - "x-etsi-ref": "6.2.4.10" - }, - "VimConnectionInfo": { "properties": { "accessInfo": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "extra": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "id": { - "description": "The identifier of the VIM Connection. This identifier is managed by the MEO.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the VIM Connection. This identifier is managed by the MEO." }, "interfaceInfo": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "vimId": { - "description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise." }, "vimType": { - "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available." } - }, + } + }, + "VimSoftwareImage": { + "title": "VimSoftwareImage", "required": [ - "id", - "vimType" + "appDSoftwareImageId", + "vimSoftwareImageId" ], "type": "object", - "x-etsi-ref": "6.2.2.18" - }, - "VimSoftwareImage": { "properties": { "appDSoftwareImageId": { - "description": "Identifier which references the software image descriptor in the AppD.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier which references the software image descriptor in the AppD." }, "vimConnectionId": { - "description": "Identifier of the VIM connection to access the software image referenced in this structure. ", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the VIM connection to access the software image referenced in this structure." }, "vimSoftwareImageId": { - "description": "Identifier of the software image in the resource management layer (i.e. VIM).", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the software image in the resource management layer (i.e. VIM)." } - }, + } + }, + "ZoneGroupInfo": { + "title": "ZoneGroupInfo", "required": [ - "appDSoftwareImageId", - "vimSoftwareImageId" + "zoneId" ], "type": "object", - "x-etsi-ref": "6.2.4.11" - }, - "ZoneGroupInfo": { "properties": { "zoneId": { - "description": "References of identifiers of \"ZoneInfo\" structures, each of which provides information about a resource zone that belongs to this group.", + "minItems": 1, + "type": "array", "items": { "type": "string" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" + "description": "References of identifiers of \"ZoneInfo\" structures, each of which provides information about a resource zone that belongs to this group." } - }, + } + }, + "ZoneInfo": { + "title": "ZoneInfo", "required": [ + "id", "zoneId" ], "type": "object", - "x-etsi-ref": "6.2.4.7" - }, - "ZoneInfo": { "properties": { "id": { - "description": "The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the \"Grant\" structure.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the \"Grant\" structure." }, "vimConnectionId": { - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "type": "string" }, "zoneId": { - "description": "The identifier of the resource zone, as managed by the resource management layer (typically, the VIM).", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "id", - "zoneId" - ], - "type": "object", - "x-etsi-ref": "6.2.4.6f" - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "206": { - "description": "Partial content" - }, - "400": { - "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized : used when the client did not submit credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden : operation is not allowed given the current status of the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "406": { - "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "412": { - "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "414": { - "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "415": { - "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "416": { - "description": "Range Not Satisfiable ." - }, - "422": { - "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "example": { - "application/problem+json": { - "problemDetails": { - "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", - "title": "Too many targets", - "status": "422", - "detail": "The target area for the request is considered too large", - "instance": "/meAppClient.example.com/77777/msgs/abc" - } - } - } - } - } - }, - "429": { - "description": "Too Many Requests : used when a rate limiter has triggered.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + "description": "The identifier of the resource zone, as managed by the resource management layer (typically, the VIM)." } } } } - } + }, + "security": [ + {} + ] } \ No newline at end of file diff --git a/MEC010-2_AppLcm.json b/MEC010-2_AppLcm.json index f6cafee..60abe05 100644 --- a/MEC010-2_AppLcm.json +++ b/MEC010-2_AppLcm.json @@ -1,7 +1,7 @@ { + "openapi": "3.1.0", "info": { "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management", - "version": "2.1.1", "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.", "license": { "name": "BSD-3-Clause", @@ -9,20 +9,16 @@ }, "contact": { "name": "ETSI Forge", - "email": "cti_support@etsi.org", - "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api" - } + "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api", + "email": "cti_support@etsi.org" + }, + "version": "2.1.1" }, "externalDocs": { "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1", "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf" }, - "servers": [ - { - "url": "https://localhost/app_lcm/v1" - } - ], - "openapi": "3.0.0", + "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "tags": [ { "name": "app-lcm", @@ -33,30 +29,39 @@ "description": "App lifecycle management notifications" } ], + "servers": [ + { + "url": "https://localhost/app_lcm/v1", + "variables": {} + } + ], "paths": { "/app_instances": { "post": { "tags": [ - "" + "app-lcm" ], "summary": "Create an application instance resource", "description": "Create an application instance resource", "operationId": "appInstancePOST", + "parameters": [], "requestBody": { - "required": true, + "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppInstanceRequest" } } - } + }, + "required": true }, "responses": { "201": { "description": "An application instance identifier and the related resource has been created successfully.", + "headers": {}, "content": { - "application/zip": { + "application/json": { "schema": { "$ref": "#/components/schemas/AppInstanceInfo" } @@ -64,136 +69,245 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "get": { "tags": [ - "" + "app-lcm" ], "summary": "Queries information relating to on-boarded application packages in the MEO", "description": "queries information relating to on-boarded application packages in the MEO", "operationId": "appInstanceGET", "parameters": [ { - "in": "query", "name": "filter", + "in": "query", + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + } }, { - "in": "query", "name": "all_fields", + "in": "query", + "description": "Include all complex attributes in the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Include all complex attributes in the response." + } }, { - "in": "query", "name": "fields", + "in": "query", + "description": "Complex attributes of AppPkgInfo to be included into the response", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be included into the response" + } }, { - "in": "query", "name": "exclude_fields", + "in": "query", + "description": "Complex attributes of AppPkgInfo to be excluded from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be excluded from the response." + } }, { - "in": "query", "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } } ], "responses": { "200": { "description": "Array the representations of zero or more application instances", + "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceInfo" - } + }, + "description": "", + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_instances/{appInstanceId}": { - "parameters": [ - { - "in": "path", - "name": "appInstanceId", - "description": "Identifier of an individual application instance", - "schema": { - "type": "string" - }, - "required": true - } - ], "get": { "tags": [ - "" + "app-lcm" ], "summary": "Retrieves the information of an individual application instance via reading an individual application instance.", "description": "Retrieves the information of an individual application instance via reading an individual application instance.", "operationId": "appInstanceIdGET", + "parameters": [ + { + "name": "appInstanceId", + "in": "path", + "description": "Identifier of an individual application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Contains a representation of the read resource.", + "headers": {}, "content": { "application/json": { "schema": { @@ -203,73 +317,197 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "delete": { "tags": [ - "" + "app-lcm" ], "summary": "Deletes an individual application instance resource.", "description": "Deletes an individual application instance resource.", "operationId": "appInstanceIdDELETE", + "parameters": [ + { + "name": "appInstanceId", + "in": "path", + "description": "Identifier of an individual application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/subscriptions": { "post": { "tags": [ - "" + "app-lcm-notifications" ], "summary": "subscribe to the notification of application instance operational state change", "description": "subscribe to the notification of application instance operational state change", "operationId": "appLcmSubscriptionsPOST", "parameters": [ { - "in": "query", "name": "subscriptionType", + "in": "query", "description": "\"Query parameter to filter on a specific subscription type. Permitted values:\n • \"AppInstanceStateChange\"\n • \"AppLcmOpOccStateChange\"\n\"", + "required": true, + "style": "form", + "explode": true, "schema": { "oneOf": [ { @@ -279,12 +517,11 @@ "$ref": "#/components/schemas/AppLcmOpOcc.SubscriptionType" } ] - }, - "required": true + } } ], "requestBody": { - "required": true, + "description": "", "content": { "application/json": { "schema": { @@ -295,14 +532,17 @@ { "$ref": "#/components/schemas/AppLcmOpOccSubscriptionRequest" } - ] + ], + "contentMediaType": "application/json" } } - } + }, + "required": true }, "responses": { "201": { "description": "a representation of the created SubscriptionInfo.", + "headers": {}, "content": { "application/json": { "schema": { @@ -313,52 +553,138 @@ { "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo" } - ] + ], + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" - } - } - }, + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "callbacks": { + "notification": { + "{$request.body#/callbackUri}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": "Notification for informing the subscribers about operational state of application instance resources or state changes of an application LCM operation occurrence. It depends on subscription type.", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppInstNotification" + }, + { + "$ref": "#/components/schemas/AppLcmOpOccNotification" + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "No content" + } + } + } + } + } + }, + "deprecated": false + }, "get": { "tags": [ - "" + "app-lcm-notifications" ], "summary": "Retrieves the information of multiple subscriptions to notifications related to an application instance.", "description": "Retrieves the information of multiple subscriptions to notifications related to an application instance.", "operationId": "appLcmSubscriptionsGET", "parameters": [ { - "in": "query", "name": "subscriptionType", + "in": "query", "description": "Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false + } } ], "responses": { "200": { - "description": " List of all subscriptions is returned.", + "description": "List of all subscriptions is returned.", + "headers": {}, "content": { "application/json": { "schema": { @@ -368,59 +694,111 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/subscriptions/{subscriptionId}": { - "parameters": [ - { - "in": "path", - "name": "subscriptionId", - "description": "Represents an individual subscription to notification related to an application instance", - "schema": { - "type": "string" - }, - "required": true - } - ], "get": { "tags": [ - "" + "app-lcm-notifications" ], "summary": "Used to represent an individual subscription to notifications about application package changes.", "description": "Used to represent an individual subscription to notifications about application package changes.", "operationId": "individualSubscriptionGET", "parameters": [ { - "in": "query", + "name": "subscriptionId", + "in": "path", + "description": "Represents an individual subscription to notification related to an application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + }, + { "name": "subscriptionType", + "in": "query", "description": "Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange", + "required": true, + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": true + } } ], "responses": { "200": { "description": "Representation of the resource.", + "headers": {}, "content": { "application/json": { "schema": { @@ -431,67 +809,166 @@ { "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo" } - ] + ], + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "delete": { "tags": [ - "" + "app-lcm-notifications" ], "summary": "Deletes the individual subscription to notifications about application package changes in MEO.", "description": "Deletes the individual subscription to notifications about application package changes in MEO.", "operationId": "individualSubscriptionDELETE", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Represents an individual subscription to notification related to an application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/user_defined_notification": { "post": { "tags": [ - "" + "app-lcm-notifications" ], "summary": "Delivers a notification from the application lifecycle management resource to the subscriber.", "description": "Delivers a notification from the application lifecycle management resource to the subscriber.", "operationId": "appInstNotificationPOST", + "parameters": [], "requestBody": { - "required": true, + "description": "", "content": { "application/json": { "schema": { @@ -502,316 +979,608 @@ { "$ref": "#/components/schemas/AppLcmOpOccNotification" } - ] + ], + "contentMediaType": "application/json" } } - } + }, + "required": true }, "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_instances/{appInstanceId}/instantiate": { - "parameters": [ - { - "in": "path", - "name": "appInstanceId", - "description": "Identifier of an individual application instance", - "schema": { - "type": "string" - }, - "required": true - } - ], "post": { "tags": [ - "" + "app-lcm" ], - "summary": "task of instantiating an application instance.", + "summary": "Deletes the individual subscription to notifications about application package changes in MEO.", "description": "task of instantiating an application instance.", "operationId": "appLcmInstanciatePOST", + "parameters": [ + { + "name": "appInstanceId", + "in": "path", + "description": "Identifier of an individual application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "requestBody": { - "required": true, + "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstantiateAppRequest" } } - } + }, + "required": true }, "responses": { "202": { - "description": "accepted for processing, but the processing has not yet been completed." + "description": "accepted for processing, but the processing has not yet been completed.", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_instances/{appInstanceId}/terminate": { - "parameters": [ - { - "in": "path", - "name": "appInstanceId", - "description": "Identifier of an individual application instance", - "schema": { - "type": "string" - }, - "required": true - } - ], "post": { "tags": [ - "" + "app-lcm" ], "summary": "terminate an application instance.", "description": "terminate an application instance.", "operationId": "appLcmTerminatePOST", + "parameters": [ + { + "name": "appInstanceId", + "in": "path", + "description": "Identifier of an individual application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "requestBody": { - "required": true, + "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateAppRequest" } } - } + }, + "required": true }, "responses": { "202": { - "description": "accepted for processing, but the processing has not yet been completed." + "description": "accepted for processing, but the processing has not yet been completed.", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_instances/{appInstanceId}/operate": { - "parameters": [ - { - "in": "path", - "name": "appInstanceId", - "description": "Identifier of an individual application instance", - "schema": { - "type": "string" - }, - "required": true - } - ], "post": { "tags": [ - "" + "app-lcm" ], "summary": "change the operational state, i.e. start or stop, of the application instance", "description": "change the operational state, i.e. start or stop, of the application instance", "operationId": "appLcmOperatePOST", + "parameters": [ + { + "name": "appInstanceId", + "in": "path", + "description": "Identifier of an individual application instance", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "requestBody": { - "required": true, + "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperateAppRequest" } } - } + }, + "required": true }, "responses": { "202": { - "description": "accepted for processing, but the processing has not yet been completed." + "description": "accepted for processing, but the processing has not yet been completed.", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_lcm_op_occs": { "get": { "tags": [ - "" + "app-lcm" ], "summary": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences", "description": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences", "operationId": "appLcmOpOccsGET", "parameters": [ { - "in": "query", "name": "filter", + "in": "query", + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + } }, { - "in": "query", "name": "all_fields", + "in": "query", + "description": "Include all complex attributes in the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Include all complex attributes in the response." + } }, { - "in": "query", "name": "fields", + "in": "query", + "description": "Complex attributes of AppPkgInfo to be included into the response", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be included into the response" + } }, { - "in": "query", "name": "exclude_fields", + "in": "query", + "description": "Complex attributes of AppPkgInfo to be excluded from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be excluded from the response." + } }, { - "in": "query", "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } } ], "responses": { "200": { "description": "Status information for zero or more application instance lifecycle management operation occurrences was queried successfully", + "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceLcmOpOcc" - } + }, + "description": "", + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_lcm_op_occs/{appLcmOpOccId}": { - "parameters": [ - { - "in": "path", - "name": "appLcmOpOccId", - "description": "Identifies an individual application LCM operation occurrence", - "schema": { - "type": "string" - }, - "required": true - } - ], "get": { "tags": [ - "" + "app-lcm" ], "summary": "reads the status information of an individual application LCM operation occurrence", "description": "reads the status information of an individual application LCM operation occurrence", "operationId": "appLcmOpOccsbyIdGET", + "parameters": [ + { + "name": "appLcmOpOccId", + "in": "path", + "description": "Identifies an individual application LCM operation occurrence", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Information about an application LCM operation occurrence was read successfully", + "headers": {}, "content": { "application/json": { "schema": { @@ -821,32 +1590,81 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] } }, "components": { "schemas": { "AppInstanceLcmOpOcc": { - "description": "'This data type represents an application lifecycle management operation occurrence'", - "type": "object", + "title": "AppInstanceLcmOpOcc", "required": [ "id", "operationState", @@ -855,9 +1673,11 @@ "lcmOperation", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppInstanceLcmOpOcc.Id" + "type": "string", + "description": "'Identifier of the subscription to application LCM operation occurrence notification'" }, "operationState": { "$ref": "#/components/schemas/OperationState" @@ -877,28 +1697,29 @@ "_links": { "$ref": "#/components/schemas/AppInstanceLcmOpOcc.links" } - } - }, - "AppInstanceLcmOpOcc.Id": { - "description": "'Identifier of the subscription to application LCM operation occurrence notification'", - "type": "string" + }, + "description": "'This data type represents an application lifecycle management operation occurrence'" }, "OperationParams": { - "description": "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'", - "type": "string", + "title": "OperationParams", "enum": [ "INSTANTIATE", "OPERATE", "TERMINATE" + ], + "type": "string", + "description": "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'", + "examples": [ + "INSTANTIATE" ] }, "AppInstanceLcmOpOcc.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppInstanceLcmOpOcc.links", "required": [ "self", "appInstance" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" @@ -906,26 +1727,28 @@ "appInstance": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "SubscriptionLinkList": { - "description": "'The data type represents a subscription link list of notification on application lifecycle management. '", - "type": "object", + "title": "SubscriptionLinkList", "required": [ "_links" ], + "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/SubscriptionLinkList.links" } - } + }, + "description": "'The data type represents a subscription link list of notification on application lifecycle management. '" }, "SubscriptionLinkList.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "SubscriptionLinkList.links", "required": [ "self" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" @@ -934,82 +1757,85 @@ "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions" - } + }, + "description": "" } - } + }, + "description": "Links to resources related to this resource." }, "SubscriptionLinkList.links.subscriptions": { - "description": "A link list to the subscriptions", - "type": "object", + "title": "SubscriptionLinkList.links.subscriptions", "required": [ "href", "subscriptionType" ], + "type": "object", "properties": { "href": { - "type": "string", - "format": "uri" + "type": "string" }, "subscriptionType": { - "type": "string", - "format": "enum", - "enum": [ - "AppInstanceStateChange", - "AppLcmOpOccStateChange" - ] + "$ref": "#/components/schemas/SubscriptionType" } - } + }, + "description": "A link list to the subscriptions" }, "AppLcmOpOccSubscriptionInfo": { - "description": "'This data type represents a subscription to notifications of application life cycle management operation occurrence'", - "type": "object", + "title": "AppLcmOpOccSubscriptionInfo", "required": [ "id", "subscriptionType", "callbackUri", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo.Id" + "type": "string", + "description": "''" }, "subscriptionType": { - "$ref": "#/components/schemas/AppLcmOpOcc.SubscriptionType" + "const": "AppLcmOpOccStateChange", + "type": "string", + "description": "Shall be set to AppLcmOpOccStateChange.", + "examples": [ + "AppLcmOpOccStateChange" + ] }, "callbackUri": { - "$ref": "#/components/schemas/CallbackUri" + "type": "string", + "description": "The URI of the endpoint for the notification to be sent to." }, "_links": { "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo.links" } - } - }, - "AppLcmOpOccSubscriptionInfo.Id": { - "description": "''", - "type": "string" + }, + "description": "'This data type represents a subscription to notifications of application life cycle management operation occurrence'" }, "AppLcmOpOcc.SubscriptionType": { - "description": "Shall be set to AppLcmOpOccStateChange.", + "title": "AppLcmOpOcc.SubscriptionType", + "const": "AppLcmOpOccStateChange", "type": "string", - "enum": [ + "description": "Shall be set to AppLcmOpOccStateChange.", + "examples": [ "AppLcmOpOccStateChange" ] }, "AppLcmOpOccSubscriptionInfo.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppLcmOpOccSubscriptionInfo.links", "required": [ "self" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "AppInstSubscriptionInfo": { - "description": "'The data type represents a subscription to notification of application instance operational state change.'", - "type": "object", + "title": "AppInstSubscriptionInfo", "required": [ "id", "subscriptionType", @@ -1017,87 +1843,91 @@ "callbackUri", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppInstSubscriptionInfo.Id" + "type": "string", + "description": "'Identifier of the subscription to application instance operational state change notification.'" }, "subscriptionType": { - "$ref": "#/components/schemas/AppInst.SubscriptionType" + "const": "AppInstanceStateChange", + "type": "string", + "description": "Shall be set to AppInstanceStateChange.", + "examples": [ + "AppInstanceStateChange" + ] }, "notificationType": { "$ref": "#/components/schemas/AppInst.NotificationType" }, "callbackUri": { - "$ref": "#/components/schemas/CallbackUri" + "type": "string", + "description": "The URI of the endpoint for the notification to be sent to." }, "_links": { "$ref": "#/components/schemas/AppInstSubscriptionInfo.links" } - } - }, - "AppInstSubscriptionInfo.Id": { - "description": "'Identifier of the subscription to application instance operational state change notification.'", - "type": "string" + }, + "description": "'The data type represents a subscription to notification of application instance operational state change.'" }, "AppInst.SubscriptionType": { - "description": "Shall be set to AppInstanceStateChange.", + "title": "AppInst.SubscriptionType", + "const": "AppInstanceStateChange", "type": "string", - "enum": [ + "description": "Shall be set to AppInstanceStateChange.", + "examples": [ "AppInstanceStateChange" ] }, "AppInst.NotificationType": { - "description": "Subscribed notification", - "type": "string", + "title": "AppInst.NotificationType", "enum": [ "NOT_INSTANTIATED", "STARTED", "STOPPED" - ] - }, - "CallbackUri": { - "description": "The URI of the endpoint for the notification to be sent to.", + ], "type": "string", - "format": "uri" + "description": "Subscribed notification", + "examples": [ + "NOT_INSTANTIATED" + ] }, "AppInstSubscriptionInfo.links": { - "description": "Links to resources related to this resource.", + "title": "AppInstSubscriptionInfo.links", + "required": [ + "self" + ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" } }, - "required": [ - "self" - ], - "type": "object" + "description": "Links to resources related to this resource." }, "AppLcmOpOccSubscriptionRequest": { + "title": "AppLcmOpOccSubscriptionRequest", + "required": [ + "callbackUri", + "subscriptionType" + ], + "type": "object", "properties": { "appLcmOpOccSubscriptionFilter": { "$ref": "#/components/schemas/AppLcmOpOccSubscriptionFilter" }, "callbackUri": { - "$ref": "#/components/schemas/URI" + "type": "string" }, "subscriptionType": { - "description": "Shall be set to \"AppLcmOpOccStateChange\".", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Shall be set to \"AppLcmOpOccStateChange\"." } - }, - "required": [ - "subscriptionType", - "callbackUri" - ], - "type": "object", - "x-etsi-ref": "6.2.2.14" - }, - "URI": { - "type": "string" + } }, "AppLcmOpOccSubscriptionFilter": { + "title": "AppLcmOpOccSubscriptionFilter", + "type": "object", "properties": { "appInstanceSubscriptionFilter": { "$ref": "#/components/schemas/AppInstanceSubscriptionFilter" @@ -1114,70 +1944,81 @@ } }, "NotificationTypes": { - "description": "Match particular notification types.", + "title": "NotificationTypes", + "const": "AppLcmOperationOccurrenceNotification", "type": "string", - "enum": [ + "description": "Match particular notification types.", + "examples": [ "AppLcmOperationOccurrenceNotification" ] }, "OperationStates": { - "description": "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'", - "type": "string", + "title": "OperationStates", "enum": [ "STARTING", "PROCESSING", "COMPLETED", "FAILED" + ], + "type": "string", + "description": "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'", + "examples": [ + "STARTING" ] }, "OperationTypes": { - "description": "'Type of the LCM operation represented by this application instance LCM operation occurrence.'", - "type": "string", + "title": "OperationTypes", "enum": [ "INSTANTIATE", "OPERATE", "TERMINATE" + ], + "type": "string", + "description": "'Type of the LCM operation represented by this application instance LCM operation occurrence.'", + "examples": [ + "INSTANTIATE" ] }, "CreateAppInstanceRequest": { + "title": "CreateAppInstanceRequest", + "required": [ + "appDId" + ], + "type": "object", "properties": { "appDId": { - "description": "The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way." }, "appInstanceDescription": { - "description": "Human-readable description of the application instance to be created.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Human-readable description of the application instance to be created." }, "appInstanceName": { - "description": "Human-readable name of the application instance to be created.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Human-readable name of the application instance to be created." } - }, - "required": [ - "appDId" - ], - "type": "object", - "x-etsi-ref": "6.2.2.3" + } }, "AppInstSubscriptionRequest": { - "type": "object", + "title": "AppInstSubscriptionRequest", "required": [ "subscriptionType", "callbackUri" ], + "type": "object", "properties": { "subscriptionType": { - "$ref": "#/components/schemas/AppInst.SubscriptionType" + "const": "AppInstanceStateChange", + "type": "string", + "description": "Shall be set to AppInstanceStateChange.", + "examples": [ + "AppInstanceStateChange" + ] }, "callbackUri": { - "$ref": "#/components/schemas/CallbackUri" + "type": "string", + "description": "The URI of the endpoint for the notification to be sent to." }, "appInstanceState": { "$ref": "#/components/schemas/AppInstanceState" @@ -1188,11 +2029,11 @@ } }, "AppInstanceSubscriptionFilter": { - "description": "'This data type represents subscription filter criteria to match application instances. '", - "type": "object", + "title": "AppInstanceSubscriptionFilter", "required": [ "appInstSelectorType" ], + "type": "object", "properties": { "appInstSelectorType": { "$ref": "#/components/schemas/AppInstSelectorType" @@ -1200,158 +2041,150 @@ "appInstances": { "type": "array", "items": { - "$ref": "#/components/schemas/AppInstances" - } + "type": "string" + }, + "description": "" }, "appsFromProviders": { "type": "array", "items": { "$ref": "#/components/schemas/AppsFromProviders" - } + }, + "description": "" } - } + }, + "description": "'This data type represents subscription filter criteria to match application instances. '" }, "AppsFromProviders": { - "description": "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'", - "type": "object", + "title": "AppsFromProviders", "required": [ "appProvider" ], + "type": "object", "properties": { "appProvider": { - "$ref": "#/components/schemas/AppProvider" + "type": "string", + "description": "Provider of the application and of the AppD." }, "appProducts": { "$ref": "#/components/schemas/AppProducts" } - } + }, + "description": "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'" }, "AppProducts": { - "description": "'If present, match application instances that belong to application products with certain product names, from one particular provider.'", - "type": "object", + "title": "AppProducts", "required": [ "appName" ], + "type": "object", "properties": { "appName": { - "$ref": "#/components/schemas/AppName" + "type": "string", + "description": "Name to identify the MEC application." }, "versions": { "$ref": "#/components/schemas/AppProducts.Versions" } - } + }, + "description": "'If present, match application instances that belong to application products with certain product names, from one particular provider.'" }, "AppProducts.Versions": { - "description": "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'", - "type": "object", + "title": "AppProducts.Versions", "required": [ "appSoftVersion" ], + "type": "object", "properties": { "appSoftVersion": { - "$ref": "#/components/schemas/AppSoftVersion" + "type": "string", + "description": "Identifies the version of software of the MEC application." }, "appDVersion": { "type": "array", "items": { - "$ref": "#/components/schemas/AppDVersion" - } + "type": "string" + }, + "description": "" } - } - }, - "AppInstances": { - "description": "If appInstIdSelector = APP_IDENTITY match existing application instances with an application instance identifier listed in this attribute.", - "type": "string" + }, + "description": "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'" }, "AppInstSelectorType": { - "description": "0 = void", - "type": "string", + "title": "AppInstSelectorType", "enum": [ "VOID", "APP_IDENTITY", "APP_NAME", "APP_D_ID", "APP_FROM_PROVIDER" + ], + "type": "string", + "description": "0 = void", + "examples": [ + "VOID" ] }, "AppInstanceState": { - "description": "Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.", - "type": "string", - "format": "enum", + "title": "AppInstanceState", "enum": [ "NOT_INSTANTIATED", "STARTED", "STOPPED" + ], + "type": "string", + "description": "Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.", + "examples": [ + "NOT_INSTANTIATED" ] }, "AppInstNotification": { + "title": "AppInstNotification", + "required": [ + "_links", + "appDId", + "appInstanceId", + "appPkgId", + "id", + "notificationType", + "subscriptionId", + "timeStamp" + ], + "type": "object", "properties": { "_links": { - "description": "Links to resources related to this notification.", - "properties": { - "subscription": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "subscription" - ], - "type": "object", - "x-etsi-mec-cardinality": "1" + "$ref": "#/components/schemas/Links" }, "appDId": { - "description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way." }, "appInstanceId": { - "description": "Identifier of application instance.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of application instance." }, "appPkgId": { - "description": "Identifier of the onboarded application package. ", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the onboarded application package." }, "id": { - "description": "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the \"notificationId\" attribute of all these notifications shall have the same value.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the \"notificationId\" attribute of all these notifications shall have the same value." }, "notificationType": { "$ref": "#/components/schemas/AppInst.NotificationType" }, "subscriptionId": { - "description": "Identifier of the subscription related to this notification.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of the subscription related to this notification." }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" } - }, - "required": [ - "id", - "notificationType", - "subscriptionId", - "timeStamp", - "appInstanceId", - "appPkgId", - "appDId", - "_links" - ], - "type": "object", - "x-etsi-ref": "6.2.2.11" + } }, "AppInstanceInfo": { - "description": "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'", - "type": "object", + "title": "AppInstanceInfo", "required": [ "id", "appDId", @@ -1363,39 +2196,50 @@ "instantiationState", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppInstanceId" + "type": "string", + "description": "Identifier of application instance." }, "appInstanceName": { - "$ref": "#/components/schemas/AppInstanceName" + "type": "string", + "description": "Name of the application instance." }, "appInstanceDescription": { - "$ref": "#/components/schemas/AppInstanceDescription" + "type": "string", + "description": "Human-readable description of the application instance to be created." }, "appDId": { - "$ref": "#/components/schemas/AppDId" + "type": "string", + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique." }, "appProvider": { - "$ref": "#/components/schemas/AppProvider" + "type": "string", + "description": "Provider of the application and of the AppD." }, "appName": { - "$ref": "#/components/schemas/AppName" + "type": "string", + "description": "Name to identify the MEC application." }, "appSoftVersion": { - "$ref": "#/components/schemas/AppSoftVersion" + "type": "string", + "description": "Identifies the version of software of the MEC application." }, "appDVersion": { - "$ref": "#/components/schemas/AppDVersion" + "type": "string", + "description": "Identifies the version of the application descriptor." }, "appPkgId": { - "$ref": "#/components/schemas/AppPkgId" + "type": "string", + "description": "Identifier of the onboarded application package." }, "vimConnectionInfo": { "type": "array", "items": { "$ref": "#/components/schemas/VimConnectionInfo" - } + }, + "description": "" }, "instantiationState": { "$ref": "#/components/schemas/InstantiationState" @@ -1406,89 +2250,66 @@ "_links": { "$ref": "#/components/schemas/AppInstanceInfo.links" } - } - }, - "AppInstanceId": { - "description": "Identifier of application instance.", - "type": "string" + }, + "description": "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'" }, "OperationState": { - "description": "Operation state", - "type": "string", - "format": "enum", + "title": "OperationState", "enum": [ "STARTING", "PROCESSING", "COMPLETED", "FAILED" + ], + "type": "string", + "description": "Operation state", + "examples": [ + "STARTING" ] }, - "AppInstanceName": { - "description": "Name of the application instance.", - "type": "string" - }, - "AppInstanceDescription": { - "description": "Human-readable description of the application instance to be created.", - "type": "string" - }, - "AppDId": { - "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.", - "type": "string" - }, - "AppProvider": { - "description": "Provider of the application and of the AppD.", - "type": "string" - }, - "AppName": { - "description": "Name to identify the MEC application.", - "type": "string" - }, - "AppSoftVersion": { - "description": "Identifies the version of software of the MEC application.", - "type": "string" - }, - "AppDVersion": { - "description": "Identifies the version of the application descriptor.", - "type": "string" - }, - "AppPkgId": { - "description": "Identifier of the onboarded application package.", - "type": "string" - }, "InstantiationState": { - "description": "Instantiation state of the application instance", - "type": "string", + "title": "InstantiationState", "enum": [ "NOT_INSTANTIATED", "INSTANTIATED" + ], + "type": "string", + "description": "Instantiation state of the application instance", + "examples": [ + "NOT_INSTANTIATED" ] }, "InstantiatedAppState": { - "description": "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'", - "type": "object", + "title": "InstantiatedAppState", "required": [ "operationalState" ], + "type": "object", "properties": { "operationalState": { "$ref": "#/components/schemas/OperationalState" } - } + }, + "description": "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'" }, "OperationalState": { - "description": "Operational state is applicable in the instantiation state INSTANTIATED", - "type": "string", + "title": "OperationalState", "enum": [ "STARTED", "STOPPED" + ], + "type": "string", + "description": "Operational state is applicable in the instantiation state INSTANTIATED", + "examples": [ + "STARTED" ] }, "AppInstanceInfo.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppInstanceInfo.links", "required": [ "self" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" @@ -1502,21 +2323,24 @@ "operate": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "LcmOperation": { - "description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence", - "type": "string", - "format": "enum", + "title": "LcmOperation", "enum": [ "INSTATIATE", "OPERATE", "TERMINATE" + ], + "type": "string", + "description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence", + "examples": [ + "INSTATIATE" ] }, "AppLcmOpOccNotification": { - "description": "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'", - "type": "object", + "title": "AppLcmOpOccNotification", "required": [ "id", "notificationType", @@ -1526,60 +2350,58 @@ "appInstanceId", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppLcmOpOccNotification.Id" + "type": "string", + "description": "''" }, "notificationType": { "$ref": "#/components/schemas/AppLcmOpOcc.NotificationType" }, "subscriptionId": { - "$ref": "#/components/schemas/SubscriptionId" + "type": "string", + "description": "Identifier of the subscription related to this notification." }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" }, "appLcmOpOccId": { - "$ref": "#/components/schemas/AppLcmOpOccId" + "type": "string", + "description": "Identifier of application lifecycle management operation occurrence." }, "appInstanceId": { - "$ref": "#/components/schemas/AppInstanceId" + "type": "string", + "description": "Identifier of application instance." }, "_links": { "$ref": "#/components/schemas/AppLcmOpOccNotification.links" } - } - }, - "AppLcmOpOccNotification.Id": { - "description": "''", - "type": "string" + }, + "description": "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'" }, "AppLcmOpOcc.NotificationType": { - "description": "Discriminator for the different notification types", - "type": "string", + "title": "AppLcmOpOcc.NotificationType", "enum": [ "STARTING", "PROCESSING", "COMPLETED", "FAILED" + ], + "type": "string", + "description": "Discriminator for the different notification types", + "examples": [ + "STARTING" ] }, - "SubscriptionId": { - "description": "Identifier of the subscription related to this notification.", - "type": "string" - }, - "AppLcmOpOccId": { - "description": "Identifier of application lifecycle management operation occurrence.", - "type": "string" - }, "AppLcmOpOccNotification.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppLcmOpOccNotification.links", "required": [ "appInstance", "subscription", "appLcmOpOcc" ], + "type": "object", "properties": { "appInstance": { "$ref": "#/components/schemas/LinkType" @@ -1590,445 +2412,301 @@ "appLcmOpOcc": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "InstantiateAppRequest": { + "title": "InstantiateAppRequest", + "required": [ + "selectedMECHostInfo" + ], + "type": "object", "properties": { "locationConstraints": { "$ref": "#/components/schemas/LocationConstraints" }, "selectedMECHostInfo": { - "description": "Describes the information of selected host for the application instance. See note 2.", + "minItems": 1, + "type": "array", "items": { "$ref": "#/components/schemas/MECHostInformation" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "MECHostInformation" + "description": "Describes the information of selected host for the application instance. See note 2." }, "vimConnectionInfo": { - "description": "Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.\nThis attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/VimConnectionInfo" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "VimConnectionInfo" + "description": "Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.\nThis attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2." }, "virtualComputeDescriptor": { - "$ref": "#/components/schemas/VirtualComputeDescription" + "type": "string", + "description": "Ref NFV" }, "virtualStorageDescriptor": { - "description": "Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.", - "items": { - "$ref": "#/components/schemas/VirtualStorageDescriptor" - }, "minItems": 0, "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "VirtualStorageDescriptor" + "items": { + "type": "string" + }, + "description": "Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1." } - }, + } + }, + "LinkType": { + "title": "LinkType", "required": [ - "selectedMECHostInfo" + "href" ], "type": "object", - "x-etsi-notes": "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only.", - "x-etsi-ref": "6.2.2.7" - }, - "LinkType": { "properties": { "href": { - "description": "URI referring to a resource", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" + "description": "URI referring to a resource" } - }, - "required": [ - "href" - ], - "type": "object", - "x-etsi-ref": "6.5.2" + } }, "LocationConstraints": { - "description": "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'", - "type": "object", + "title": "LocationConstraints", "required": [ "countryCode" ], + "type": "object", "properties": { "countryCode": { - "$ref": "#/components/schemas/CountryCode" + "type": "string", + "description": "The two-letter ISO 3166 country code in capital letters." }, "civicAddressElement": { "type": "array", "items": { "$ref": "#/components/schemas/CivicAddressElement" - } + }, + "description": "" } - } - }, - "CountryCode": { - "description": "The two-letter ISO 3166 country code in capital letters.", - "type": "string" + }, + "description": "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'" }, "CivicAddressElement": { - "description": "'The civic address.'", - "type": "object", + "title": "CivicAddressElement", "required": [ "caType", "caValue" ], + "type": "object", "properties": { "caType": { - "$ref": "#/components/schemas/CaType" + "type": "integer", + "description": "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'", + "contentEncoding": "int32" }, "caValue": { - "$ref": "#/components/schemas/CaValue" + "type": "string", + "description": "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'" } - } - }, - "CaType": { - "description": "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'", - "type": "integer" - }, - "CaValue": { - "description": "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'", - "type": "string" + }, + "description": "'The civic address.'" }, "MECHostInformation": { + "title": "MECHostInformation", + "required": [ + "hostId" + ], + "type": "object", "properties": { "hostId": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "hostName": { - "description": "Human-readable name of MEC host.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Human-readable name of MEC host." } - }, + } + }, + "OperateAppRequest": { + "title": "OperateAppRequest", "required": [ - "hostId" + "changeStateTo" ], "type": "object", - "x-etsi-ref": "6.2.2.17" - }, - "OperateAppRequest": { "properties": { "changeStateTo": { "$ref": "#/components/schemas/ChangeStateTo" }, "gracefulStopTimeout": { - "description": "The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Integer" + "description": "The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.", + "contentEncoding": "int32" }, "stopType": { "$ref": "#/components/schemas/StopType" } - }, - "required": [ - "changeStateTo" - ], - "type": "object", - "x-etsi-notes": "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent.", - "x-etsi-ref": "6.2.2.8" + } }, "StopType": { - "description": "Signals forceful or graceful stop", - "type": "string", + "title": "StopType", "enum": [ "FORCEFUL", "GRACEFUL" + ], + "type": "string", + "description": "Signals forceful or graceful stop", + "examples": [ + "FORCEFUL" ] }, "ChangeStateTo": { - "description": "The desired operational state", - "type": "string", - "format": "enum", + "title": "ChangeStateTo", "enum": [ "STARTED", "STOPPED" + ], + "type": "string", + "description": "The desired operational state", + "examples": [ + "STARTED" ] }, "ProblemDetails": { + "title": "ProblemDetails", + "type": "object", "properties": { "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "A human-readable explanation specific to this occurrence of the problem" }, "instance": { - "description": "A URI reference that identifies the specific occurrence of the problem", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" + "description": "A URI reference that identifies the specific occurrence of the problem" }, "status": { - "description": "The HTTP status code for this occurrence of the problem", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The HTTP status code for this occurrence of the problem", + "contentEncoding": "int32" }, "title": { - "description": "A short, human-readable summary of the problem type", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "A short, human-readable summary of the problem type" }, "type": { - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" } - }, - "type": "object" + } }, "TerminateAppRequest": { + "title": "TerminateAppRequest", + "required": [ + "terminationType" + ], + "type": "object", "properties": { "gracefulTerminationTimeout": { - "description": "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources.", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Integer" + "description": "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources.", + "contentEncoding": "int32" }, "terminationType": { "$ref": "#/components/schemas/TerminationType" } - }, + } + }, + "TimeStamp": { + "title": "TimeStamp", "required": [ - "terminationType" + "nanoSeconds", + "seconds" ], "type": "object", - "x-etsi-notes": "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service.", - "x-etsi-ref": "6.2.2.9" - }, - "TimeStamp": { "properties": { "nanoSeconds": { - "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "format": "Uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" }, "seconds": { - "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "format": "Uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" } - }, - "required": [ - "seconds", - "nanoSeconds" - ], - "type": "object", - "x-etsi-ref": "6.2.5.4" + } }, "TerminationType": { - "description": "'Indicates whether forceful or graceful termination is requested.'", - "type": "string", - "format": "enum", + "title": "TerminationType", "enum": [ "FORCEFUL", "GRACEFUL" + ], + "type": "string", + "description": "'Indicates whether forceful or graceful termination is requested.'", + "examples": [ + "FORCEFUL" ] }, "VimConnectionInfo": { + "title": "VimConnectionInfo", + "required": [ + "id", + "vimType" + ], + "type": "object", "properties": { "accessInfo": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "extra": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "id": { - "description": "The identifier of the VIM Connection. This identifier is managed by the MEO.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the VIM Connection. This identifier is managed by the MEO." }, "interfaceInfo": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "vimId": { - "description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise." }, "vimType": { - "description": "Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available." } - }, + } + }, + "Links": { + "title": "Links", "required": [ - "id", - "vimType" + "subscription" ], "type": "object", - "x-etsi-ref": "6.2.2.18" - }, - "VirtualComputeDescription": { - "description": "Ref NFV", - "type": "string" - }, - "VirtualStorageDescriptor": { - "description": "Ref NFV", - "type": "string" - }, - "KeyValuePairs": { - "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'", - "type": "object", - "additionalProperties": true - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "206": { - "description": "Partial content" - }, - "400": { - "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized : used when the client did not submit credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden : operation is not allowed given the current status of the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "406": { - "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "412": { - "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "414": { - "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "415": { - "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "416": { - "description": "Range Not Satisfiable ." - }, - "422": { - "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "example": { - "application/problem+json": { - "problemDetails": { - "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", - "title": "Too many targets", - "status": "422", - "detail": "The target area for the request is considered too large", - "instance": "/meAppClient.example.com/77777/msgs/abc" - } - } - } + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this notification." }, - "429": { - "description": "Too Many Requests : used when a rate limiter has triggered.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } + "SubscriptionType": { + "title": "SubscriptionType", + "enum": [ + "AppInstanceStateChange", + "AppLcmOpOccStateChange" + ], + "type": "string", + "examples": [ + "AppInstanceStateChange" + ] } } - } + }, + "security": [ + {} + ] } \ No newline at end of file diff --git a/MEC010-2_AppPkgMgmt.json b/MEC010-2_AppPkgMgmt.json index cafe616..ac04e79 100644 --- a/MEC010-2_AppPkgMgmt.json +++ b/MEC010-2_AppPkgMgmt.json @@ -1,7 +1,7 @@ { + "openapi": "3.1.0", "info": { "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management", - "version": "2.1.1", "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.", "license": { "name": "BSD-3-Clause", @@ -9,20 +9,16 @@ }, "contact": { "name": "ETSI Forge", - "email": "cti_support@etsi.org", - "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api" - } + "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api", + "email": "cti_support@etsi.org" + }, + "version": "2.1.1" }, + "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "externalDocs": { "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1", "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf" }, - "servers": [ - { - "url": "https://localhost/app_pkgm/v1" - } - ], - "openapi": "3.0.0", "tags": [ { "name": "app-pkgm", @@ -33,6 +29,12 @@ "description": "App Package management notifications" } ], + "servers": [ + { + "url": "https://localhost/app_pkgm/v1", + "variables": {} + } + ], "paths": { "/app_packages": { "post": { @@ -42,152 +44,252 @@ "summary": "Create a resource for on-boarding an application package to a MEO", "description": "Create a resource for on-boarding an application package to a MEO", "operationId": "app_packagesPOST", + "parameters": [], "requestBody": { "description": "Resource to be created", - "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppPkg" } } - } + }, + "required": true }, "responses": { "201": { "description": "Successful response for resource creation", + "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppPkgInfo" - } + }, + "description": "", + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "get": { "tags": [ "app-pkgm" ], - "summary": "Queries information relating to on-boarded application packages in the MEO", + "summary": "Queries information relating to on-boarded application packages in the MEO'", "description": "queries information relating to on-boarded application packages in the MEO", "operationId": "app_packagesGET", "parameters": [ { - "in": "query", "name": "filter", + "in": "query", + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + } }, { - "in": "query", "name": "all_fields", + "in": "query", + "description": "Include all complex attributes in the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Include all complex attributes in the response." + } }, { - "in": "query", "name": "fields", + "in": "query", + "description": "Complex attributes of AppPkgInfo to be included into the response", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be included into the response" + } }, { - "in": "query", "name": "exclude_fields", + "in": "query", + "description": "Complex attributes of AppPkgInfo to be excluded from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be excluded from the response." + } }, { - "in": "query", "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } } ], "responses": { "200": { "description": "Contains a representation of the application package resource", + "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppPkgInfo" - } + }, + "description": "", + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_packages/{appPkgId}": { - "parameters": [ - { - "in": "path", - "name": "appPkgId", - "schema": { - "type": "string" - }, - "required": true, - "description": "Identifier of an individual application package resource" - } - ], "get": { "tags": [ "app-pkgm" @@ -195,9 +297,22 @@ "summary": "Queries the information related to individual application package resources", "description": "Queries the information related to individual application package resources", "operationId": "app_packageGET", + "parameters": [ + { + "name": "appPkgId", + "in": "path", + "description": "Identifier of an individual application package resource", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Contains a representation of the application package resource", + "headers": {}, "content": { "application/json": { "schema": { @@ -207,24 +322,73 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "delete": { "tags": [ @@ -233,29 +397,92 @@ "summary": "Deletes an individual application package resources", "description": "Deletes an individual application package resources", "operationId": "app_packageDELETE", + "parameters": [ + { + "name": "appPkgId", + "in": "path", + "description": "Identifier of an individual application package resource", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "patch": { "tags": [ @@ -264,20 +491,33 @@ "summary": "Updates the operational state of an individual application package resource", "description": "Updates the operational state of an individual application package resources", "operationId": "app_packagePATCH", + "parameters": [ + { + "name": "appPkgId", + "in": "path", + "description": "Identifier of an individual application package resource", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "requestBody": { "description": "Operational state to be set", - "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppPkgInfoModifications" } } - } + }, + "required": true }, "responses": { "200": { "description": "Shows that the operation has been completed successfully", + "headers": {}, "content": { "application/json": { "schema": { @@ -287,29 +527,87 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" - } - } - } - }, + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [] + }, "/subscriptions": { "post": { "tags": [ @@ -318,20 +616,22 @@ "summary": "Subscribe to notifications about on-boarding an application package", "description": "Subscribe to notifications about on-boarding an application package", "operationId": "subscriptionsPOST", + "parameters": [], "requestBody": { "description": "The input parameters of subscribe operation to notifications", - "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppPkgSubscription" } } - } + }, + "required": true }, "responses": { "201": { "description": "Successful response for created subscription", + "headers": {}, "content": { "application/json": { "schema": { @@ -341,22 +641,97 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "callbacks": { + "notification": { + "{$request.body#/subscription.href}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": " The notification is triggered when a new application package is onboarded", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPkgNotification" + } + } + } + }, + "responses": { + "204": { + "description": "No content" + } + } + } + } } } }, @@ -367,9 +742,11 @@ "summary": "used to retrieve the information of subscriptions to individual application package resource in MEO", "description": "used to retrieve the information of subscriptions to individual application package resource in MEO package", "operationId": "subscriptionsGET", + "parameters": [], "responses": { "200": { "description": "List of zero or more subscriptions", + "headers": {}, "content": { "application/json": { "schema": { @@ -379,38 +756,77 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/subscriptions/{subscriptionId}": { - "parameters": [ - { - "in": "path", - "name": "subscriptionId", - "schema": { - "type": "string" - }, - "description": "Identifier of an individual subscription to notifications about application package changes", - "required": true - } - ], "get": { "tags": [ "app-pkgm" @@ -418,9 +834,22 @@ "summary": "Used to represent an individual subscription to notifications about application package changes.", "description": "Used to represent an individual subscription to notifications about application package changes.", "operationId": "individualSubscriptionGET", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Identifier of an individual subscription to notifications about application package changes", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Representation of the resource.", + "headers": {}, "content": { "application/json": { "schema": { @@ -430,24 +859,73 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "delete": { "tags": [ @@ -456,75 +934,74 @@ "summary": "Deletes the individual subscription to notifications about application package changes in MEO.", "description": "Deletes the individual subscription to notifications about application package changes in MEO.", "operationId": "individualSubscriptionDELETE", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Identifier of an individual subscription to notifications about application package changes", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/user_defined_notification": { - "post": { - "tags": [ - "app-pkgm-notifications" - ], - "summary": "Registers a notification endpoint to notify application package operations", - "description": "Registers a notification endpoint to notify application package operations", - "operationId": "app_pkg_notificationPOST", - "requestBody": { - "description": "Notification endpoint to be created", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPkgNotification" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } } } } }, - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - } + "deprecated": false + }, + "parameters": [] }, "/app_packages/{appPkgId}/appd": { - "parameters": [ - { - "in": "path", - "name": "appPkgId", - "schema": { - "type": "string" - }, - "description": "Identifier of an on-boarded individual application package", - "required": true - } - ], "get": { "tags": [ "app-pkgm" @@ -534,100 +1011,151 @@ "operationId": "appPkgIdGET", "parameters": [ { - "in": "query", - "name": "filter", + "name": "appPkgId", + "in": "path", + "description": "Identifier of an on-boarded individual application package", + "required": true, + "style": "simple", "schema": { "type": "string" - }, - "required": false, - "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + } }, { + "name": "filter", "in": "query", - "name": "all_fields", + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Include all complex attributes in the response." + } }, { + "name": "all_fields", "in": "query", - "name": "fields", + "description": "Include all complex attributes in the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be included into the response" + } }, { + "name": "fields", "in": "query", - "name": "exclude_fields", + "description": "Complex attributes of AppPkgInfo to be included into the response", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be excluded from the response." + } }, { + "name": "exclude_fields", "in": "query", + "description": "Complex attributes of AppPkgInfo to be excluded from the response.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } } ], "responses": { "200": { "description": "Content of the AppD is returned.", + "headers": {}, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppD" } }, - "application/zip": { + "application/zip": {} + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/AppD" + "$ref": "#/components/schemas/ProblemDetails" } } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" - }, + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/onboarded_app_packages/{appDId}/appd": { - "parameters": [ - { - "in": "path", - "name": "appDId", - "schema": { - "type": "string" - }, - "description": "Identifier of an application descriptor", - "required": true - } - ], "get": { "tags": [ "app-pkgm" @@ -637,100 +1165,151 @@ "operationId": "appDGET", "parameters": [ { - "in": "query", - "name": "filter", + "name": "appDId", + "in": "path", + "description": "Identifier of an application descriptor", + "required": true, + "style": "simple", "schema": { "type": "string" - }, - "required": false, - "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + } }, { + "name": "filter", "in": "query", - "name": "all_fields", + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Include all complex attributes in the response." + } }, { + "name": "all_fields", "in": "query", - "name": "fields", + "description": "Include all complex attributes in the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be included into the response" + } }, { + "name": "fields", "in": "query", - "name": "exclude_fields", + "description": "Complex attributes of AppPkgInfo to be included into the response", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Complex attributes of AppPkgInfo to be excluded from the response." + } }, { + "name": "exclude_fields", "in": "query", + "description": "Complex attributes of AppPkgInfo to be excluded from the response.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.", + "style": "form", + "explode": true, "schema": { "type": "string" - }, - "required": false, - "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } } ], "responses": { "200": { "description": "Content of the AppD is returned.", + "headers": {}, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppD" } }, - "application/zip": { + "application/zip": {} + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/AppD" + "$ref": "#/components/schemas/ProblemDetails" } } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/app_packages/{appPkgId}/package_content": { - "parameters": [ - { - "in": "path", - "name": "appPkgId", - "schema": { - "type": "string" - }, - "description": "Identifier of an on-boarded individual application package", - "required": true - } - ], "get": { "tags": [ "app-pkgm" @@ -738,35 +1317,106 @@ "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.", "description": "Fetch the onboarded application package content identified by appPkgId or appDId.", "operationId": "appPkgGET", + "parameters": [ + { + "name": "appPkgId", + "in": "path", + "description": "Identifier of an on-boarded individual application package", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "$ref": "#/components/responses/AppPkgContent.200" + "description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.", + "headers": {}, + "content": { + "application/zip": {} + } }, "206": { - "$ref": "#/components/responses/206" + "description": "Partial content", + "headers": {}, + "content": { + "application/zip": {} + } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" - }, - "416": { - "$ref": "#/components/responses/416" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "416": { + "description": "Range Not Satisfiable .", + "headers": {}, + "content": {} }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "put": { "tags": [ @@ -775,56 +1425,114 @@ "summary": "Uploads the content of application package.", "description": "Uploads the content of application package.", "operationId": "appPkgPUT", - "requestBody": { - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } + "parameters": [ + { + "name": "appPkgId", + "in": "path", + "description": "Identifier of an on-boarded individual application package", + "required": true, + "style": "simple", + "schema": { + "type": "string" } } + ], + "requestBody": { + "description": "", + "content": { + "application/zip": {} + }, + "required": false }, "responses": { "202": { - "description": "The application package has been accepted for uploading, but the processing has not been completed." + "description": "The application package has been accepted for uploading, but the processing has not been completed.", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/onboarded_app_packages/{appDId}/package_content": { - "parameters": [ - { - "in": "path", - "name": "appDId", - "description": "Identifier of an application descriptor", - "schema": { - "type": "string" - }, - "required": true - } - ], "get": { "tags": [ "app-pkgm" @@ -832,332 +1540,470 @@ "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.", "description": "Fetch the onboarded application package content identified by appPkgId or appDId.", "operationId": "appDIdGET", + "parameters": [ + { + "name": "appDId", + "in": "path", + "description": "Identifier of an application descriptor", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "$ref": "#/components/responses/AppPkgContent.200" + "description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.", + "headers": {}, + "content": {} }, "206": { - "$ref": "#/components/responses/206" + "description": "Partial content", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" - }, - "416": { - "$ref": "#/components/responses/416" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "416": { + "description": "Range Not Satisfiable .", + "headers": {}, + "content": {} }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "put": { "tags": [ "app-pkgm" ], - "summary": "Uploads the content of application package.", + "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.", "description": "Uploads the content of application package.", "operationId": "appDIdPUT", - "requestBody": { - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } + "parameters": [ + { + "name": "appDId", + "in": "path", + "description": "Identifier of an application descriptor", + "required": true, + "style": "simple", + "schema": { + "type": "string" } } + ], + "requestBody": { + "description": "", + "content": { + "application/zip": {} + }, + "required": false }, "responses": { "202": { - "description": "The application package has been accepted for uploading, but the processing has not been completed." + "description": "The application package has been accepted for uploading, but the processing has not been completed.", + "headers": {}, + "content": {} }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "409": { - "$ref": "#/components/responses/409" + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] + }, + "/user_defined_notification": { + "post": { + "tags": [ + "app-pkgm-notifications" + ], + "summary": "Registers a notification endpoint to notify application package operations", + "description": "Registers a notification endpoint to notify application package operations", + "operationId": "app_pkg_notificationPOST", + "parameters": [], + "requestBody": { + "description": "Notification endpoint to be created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPkgNotification" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", + "headers": {}, + "content": {} + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [] } }, "components": { "schemas": { - "Algorithm": { - "description": " Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.", - "type": "string" - }, "AppD": { + "title": "AppD", + "required": [ + "appDId", + "appDVersion", + "appDescription", + "appName", + "appProvider", + "appSoftVersion", + "mecVersion", + "swImageDescriptor", + "virtualComputeDescriptor" + ], + "type": "object", "properties": { "appDId": { - "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1." }, "appDNSRule": { - "description": "Describes DNS rules the MEC application requires.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/DNSRuleDescriptor" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "DNSRuleDescriptor" + "description": "Describes DNS rules the MEC application requires." }, "appDVersion": { - "description": "Identifies the version of the application descriptor.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifies the version of the application descriptor." }, "appDescription": { - "description": "Human readable description of the MEC application.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Human readable description of the MEC application." }, "appExtCpd": { - "description": "Describes external interface(s) exposed by this MEC application.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/AppExternalCpd" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "AppExternalCpd" + "description": "Describes external interface(s) exposed by this MEC application." }, "appFeatureOptional": { - "description": "Describes features a MEC application may use if available.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/FeatureDependency" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "FeatureDependency" + "description": "Describes features a MEC application may use if available." }, "appFeatureRequired": { - "description": "Describes features a MEC application requires to run.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/FeatureDependency" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "FeatureDependency" + "description": "Describes features a MEC application requires to run." }, "appInfoName": { - "description": "Human readable name for the MEC application.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Human readable name for the MEC application." }, "appLatency": { "$ref": "#/components/schemas/LatencyDescriptor" }, "appName": { - "description": "Name to identify the MEC application.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Name to identify the MEC application." }, "appProvider": { - "description": "Provider of the application and of the AppD.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Provider of the application and of the AppD." }, "appServiceOptional": { - "description": "Describes services a MEC application may use if available.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/ServiceDependency" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "ServiceDependency" + "description": "Describes services a MEC application may use if available." }, "appServiceProduced": { - "description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/ServiceDescriptor" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "ServiceDescriptor" + "description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps." }, "appServiceRequired": { - "description": "Describes services a MEC application requires to run.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/ServiceDependency" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "ServiceDependency" + "description": "Describes services a MEC application requires to run." }, "appSoftVersion": { - "description": "Identifies the version of software of the MEC application.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifies the version of software of the MEC application." }, "appTrafficRule": { - "description": "Describes traffic rules the MEC application requires.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/TrafficRuleDescriptor" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "TrafficRuleDescriptor" + "description": "Describes traffic rules the MEC application requires." }, "changeAppInstanceStateOpConfig": { - "$ref": "#/components/schemas/ChangeAppInstanceStateOpConfig" + "type": "string", + "description": "NFV" }, "mecVersion": { - "description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD.", + "minItems": 1, + "type": "array", "items": { "type": "string" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" + "description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD." }, "swImageDescriptor": { - "$ref": "#/components/schemas/SwImageDescriptor" + "type": "string", + "description": "Ref NFV" }, "terminateAppInstanceOpConfig": { - "$ref": "#/components/schemas/TerminateAppInstanceOpConfig" + "type": "string", + "description": "NFV" }, "transportDependencies": { - "description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/TransportDependency" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "TransportDependency" + "description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2." }, "virtualComputeDescriptor": { - "$ref": "#/components/schemas/VirtualComputeDescription" + "type": "string", + "description": "Ref NFV" }, "virtualStorageDescriptor": { - "description": "Defines descriptors of virtual storage resources to be used by the MEC application.", - "items": { - "$ref": "#/components/schemas/VirtualStorageDescriptor" - }, "minItems": 0, "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "VirtualStorageDescriptor" + "items": { + "type": "string" + }, + "description": "Defines descriptors of virtual storage resources to be used by the MEC application." } - }, + } + }, + "AppExternalCpd": { + "title": "AppExternalCpd", "required": [ - "appDId", - "appName", - "appProvider", - "appSoftVersion", - "appDVersion", - "mecVersion", - "appDescription", - "virtualComputeDescriptor", - "swImageDescriptor" + "inherited_attributes" ], "type": "object", - "x-etsi-notes": "NOTE 1:\tThe appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2:\tThis attribute indicates groups of transport bindings which a service-producing MEC application requires to be supported by the platform in order to be able to produce its services. At least one of the indicated groups needs to be supported to fulfil the requirements.", - "x-etsi-ref": "6.2.1.2" - }, - "AppExternalCpd": { "properties": { "inherited_attributes": { - "description": "All attributes inherited from Cpd.", "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "inherited_attributes" + "description": "All attributes inherited from Cpd." }, "virtualNetworkInterfaceRequirements": { - "description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD.", - "items": { - "$ref": "#/components/schemas/VirtualNetworkInterfaceRequirements" - }, "minItems": 0, "type": "array", - "x-etsi-mec-cardinality": "0..N" + "items": { + "type": "string" + }, + "description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD." } - }, - "required": [ - "inherited_attributes" - ], - "type": "object", - "x-etsi-ref": "6.2.1.6" - }, - "CallbackUri": { - "description": "The URI of the endpoint for the notification to be sent to.", - "type": "string", - "format": "uri" - }, - "AppDId": { - "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.", - "type": "string" - }, - "AppProvider": { - "description": "Provider of the application and of the AppD.", - "type": "string" - }, - "AppName": { - "description": "Name to identify the MEC application.", - "type": "string" - }, - "AppDVersion": { - "description": "Identifies the version of the application descriptor.", - "type": "string" - }, - "AppPkgId": { - "description": "Identifier of the onboarded application package.", - "type": "string" - }, - "SubscriptionId": { - "description": "Identifier of the subscription related to this notification.", - "type": "string" - }, - "AppPkgArtifactInfo": { - "description": "Additional information of application package artifacts that are not application software images. Type is TBD" + } }, "AppPkgInfo": { - "description": "'The data type AppPkgInfo represents the parameters for an application package resource'", - "type": "object", + "title": "AppPkgInfo", "required": [ "id", "appDId", @@ -1171,33 +2017,42 @@ "usageState", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppPkgId" + "type": "string", + "description": "Identifier of the onboarded application package." }, "appDId": { - "$ref": "#/components/schemas/AppDId" + "type": "string", + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique." }, "appProvider": { - "$ref": "#/components/schemas/AppProvider" + "type": "string", + "description": "Provider of the application and of the AppD." }, "appName": { - "$ref": "#/components/schemas/AppName" + "type": "string", + "description": "Name to identify the MEC application." }, "appSoftwareVersion": { - "$ref": "#/components/schemas/AppSoftwareVersion" + "type": "string", + "description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package." }, "appDVersion": { - "$ref": "#/components/schemas/AppDVersion" + "type": "string", + "description": "Identifies the version of the application descriptor." }, "checksum": { "$ref": "#/components/schemas/Checksum" }, "softwareImages": { - "$ref": "#/components/schemas/AppPkgSWImageInfo" + "type": "object", + "description": "Information of application software image in application package. Type is TBD" }, "additionalArtifacts": { - "$ref": "#/components/schemas/AppPkgArtifactInfo" + "type": "object", + "description": "Additional information of application package artifacts that are not application software images. Type is TBD" }, "onboardingState": { "$ref": "#/components/schemas/OnboardingState" @@ -1209,74 +2064,74 @@ "$ref": "#/components/schemas/UsageState" }, "userDefinedData": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" }, "_links": { "$ref": "#/components/schemas/AppPkgInfo.links" } - } + }, + "description": "'The data type AppPkgInfo represents the parameters for an application package resource'" }, "AppPkgInfoModifications": { - "description": "'The data type represents the operational state for an application package resource'", - "type": "object", + "title": "AppPkgInfoModifications", "required": [ "operationState" ], + "type": "object", "properties": { "operationState": { - "type": "string", - "enum": [ - "DISABLED", - "ENABLED" - ] + "$ref": "#/components/schemas/OperationState" } - } - }, - "AppSoftwareVersion": { - "description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package.", - "type": "string" + }, + "description": "'The data type represents the operational state for an application package resource'" }, "AppPkg.OperationalState": { - "description": "Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.", - "type": "string", + "title": "AppPkg.OperationalState", "enum": [ "ENABLED", "DISABLED" + ], + "type": "string", + "description": "Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.", + "examples": [ + "ENABLED" ] }, "OnboardingState": { - "description": "Onboarding state of application package", - "type": "string", - "format": "enum", + "title": "OnboardingState", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED" + ], + "type": "string", + "description": "Onboarding state of application package", + "examples": [ + "CREATED" ] }, "UsageState": { - "description": "Usage state of the onboarded instance of the application package", - "type": "string", - "format": "enum", + "title": "UsageState", "enum": [ "IN_USE", "NOT_IN_USE" + ], + "type": "string", + "description": "Usage state of the onboarded instance of the application package", + "examples": [ + "IN_USE" ] }, - "KeyValuePairs": { - "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'", - "type": "object", - "additionalProperties": true - }, "AppPkgInfo.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppPkgInfo.links", "required": [ "self", "appD", "appPkgContent" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" @@ -1287,11 +2142,11 @@ "appPkgContent": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "AppPkgNotification": { - "description": "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'", - "type": "object", + "title": "AppPkgNotification", "required": [ "id", "notificationType", @@ -1302,133 +2157,138 @@ "operationalState", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppPkgNotification.Id" + "type": "string", + "description": "''" }, "notificationType": { "$ref": "#/components/schemas/AppPkg.NotificationType" }, "subscriptionId": { - "$ref": "#/components/schemas/SubscriptionId" + "type": "string", + "description": "Identifier of the subscription related to this notification." }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" }, "appPkgId": { - "$ref": "#/components/schemas/AppPkgId" + "type": "string", + "description": "Identifier of the onboarded application package." }, "appDId": { - "$ref": "#/components/schemas/AppDId" + "type": "string", + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique." }, "operationalState": { - "type": "string", - "enum": [ - "DISABLED", - "ENABLED" - ] + "$ref": "#/components/schemas/OperationalState" }, "_links": { "$ref": "#/components/schemas/AppPkgNotification.links" } - } - }, - "AppPkgNotification.Id": { - "description": "''", - "type": "string" + }, + "description": "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'" }, "AppPkg.NotificationType": { - "description": "Discriminator for the different notification types", - "type": "string", + "title": "AppPkg.NotificationType", "enum": [ "AppPackageOnBoarded", "AppPacakgeEnabled", "AppPacakgeDisabled", "AppPackageDeleted" + ], + "type": "string", + "description": "Discriminator for the different notification types", + "examples": [ + "AppPackageOnBoarded" ] }, "AppPkgNotification.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppPkgNotification.links", "required": [ "subscription" ], + "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/LinkType" } - } - }, - "AppPkgSWImageInfo": { - "description": "Information of application software image in application package. Type is TBD" + }, + "description": "Links to resources related to this resource." }, "AppPkgSubscriptionInfo": { - "description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'", - "type": "object", + "title": "AppPkgSubscriptionInfo", "required": [ "id", "subscriptionType", "callbackUri", "_links" ], + "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/AppPkgSubscriptionInfo.Id" + "type": "string", + "description": "''" }, "subscriptionType": { "$ref": "#/components/schemas/AppPkg.SubscriptionType" }, "callbackUri": { - "$ref": "#/components/schemas/CallbackUri" + "type": "string", + "description": "The URI of the endpoint for the notification to be sent to." }, "_links": { "$ref": "#/components/schemas/AppPkgSubscriptionInfo.links" } - } - }, - "AppPkgSubscriptionInfo.Id": { - "description": "''", - "type": "string" + }, + "description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'" }, "AppPkg.SubscriptionType": { - "description": "Subscribed notification type.", - "type": "string", + "title": "AppPkg.SubscriptionType", "enum": [ "AppPackageOnBoarding", "AppPacakgeOperationChange", "AppPackageDeletion" + ], + "type": "string", + "description": "Subscribed notification type.", + "examples": [ + "AppPackageOnBoarding" ] }, "AppPkgSubscriptionInfo.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppPkgSubscriptionInfo.links", "required": [ "self" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" } - } + }, + "description": "Links to resources related to this resource." }, "AppPkgSubscriptionLinkList": { - "description": "'The data type represents a subscription link list of notification on application package management'", - "type": "object", + "title": "AppPkgSubscriptionLinkList", "required": [ "_links" ], + "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AppPkgSubscriptionLinkList.links" } - } + }, + "description": "'The data type represents a subscription link list of notification on application package management'" }, "AppPkgSubscriptionLinkList.links": { - "description": "Links to resources related to this resource.", - "type": "object", + "title": "AppPkgSubscriptionLinkList.links", "required": [ "self" ], + "type": "object", "properties": { "self": { "$ref": "#/components/schemas/LinkType" @@ -1437,41 +2297,41 @@ "type": "array", "items": { "$ref": "#/components/schemas/Subscriptions.AppPkgSubscription" - } + }, + "description": "" } - } + }, + "description": "Links to resources related to this resource." }, "Subscriptions.AppPkgSubscription": { - "description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'", - "type": "object", + "title": "Subscriptions.AppPkgSubscription", "required": [ "href", "subsctiptionType" ], + "type": "object", "properties": { "href": { - "$ref": "#/components/schemas/Href" + "type": "string", + "description": "The URI referring to the subscription." }, "subsctiptionType": { "$ref": "#/components/schemas/SubsctiptionType.AppPkg" } - } - }, - "Href": { - "description": "The URI referring to the subscription.", - "type": "string", - "format": "uri" + }, + "description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" }, "AppPkgSubscription": { - "description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'", - "type": "object", + "title": "AppPkgSubscription", "required": [ "callbackUri", "subsctiptionType" ], + "type": "object", "properties": { "callbackUri": { - "$ref": "#/components/schemas/CallbackUri" + "type": "string", + "description": "The URI of the endpoint for the notification to be sent to." }, "subsctiptionType": { "$ref": "#/components/schemas/SubsctiptionType.AppPkg" @@ -1479,582 +2339,484 @@ "appPkgFilter": { "type": "array", "items": { - "$ref": "#/components/schemas/AppPkgFilter" - } + "type": "string" + }, + "description": "" } - } + }, + "description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'" }, "SubsctiptionType.AppPkg": { - "description": "'Subscribed notification type'", - "type": "string", + "title": "SubsctiptionType.AppPkg", "enum": [ "AppPackageOnBoarding", "AppPacakgeOperationChange", "AppPackageDeletion" - ] - }, - "AppPkgFilter": { + ], "type": "string", - "description": "The attribute-based filter is to filter application packages on which the query applies." - }, - "ChangeAppInstanceStateOpConfig": { - "description": "NFV", - "type": "string" + "description": "'Subscribed notification type'", + "examples": [ + "AppPackageOnBoarding" + ] }, "Checksum": { - "description": "", + "title": "Checksum", + "required": [ + "algorithm", + "hash" + ], + "type": "object", "properties": { "algorithm": { - "$ref": "#/components/schemas/Algorithm" + "type": "string", + "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512." }, "hash": { - "$ref": "#/components/schemas/Hash" + "type": "string", + "description": "'String 1 The hexadecimal value of the checksum'" } - }, - "required": [ - "algorithm", - "hash" - ], - "type": "object" + } }, "CreateAppPkg": { + "title": "CreateAppPkg", + "required": [ + "appPkgName", + "appPkgPath", + "appPkgVersion", + "checksum" + ], + "type": "object", "properties": { "appPkgName": { - "description": "Name of the application package to be onboarded.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Name of the application package to be onboarded." }, "appPkgPath": { - "$ref": "#/components/schemas/URI" + "type": "string" }, "appPkgVersion": { - "description": "Version of the application package to be onboarded.\nThe appPkgName with appPkgVersion can be used to uniquely identify the application package.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Version of the application package to be onboarded.\nThe appPkgName with appPkgVersion can be used to uniquely identify the application package." }, "appProvider": { - "description": "The provider's name of the application package to be onboarded.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The provider's name of the application package to be onboarded." }, "checksum": { "$ref": "#/components/schemas/Checksum" }, "userDefinedData": { - "$ref": "#/components/schemas/KeyValuePairs" + "type": "object", + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'" } - }, + } + }, + "DNSRuleDescriptor": { + "title": "DNSRuleDescriptor", "required": [ - "appPkgName", - "appPkgVersion", - "checksum", - "appPkgPath" + "dnsRuleId", + "domainName", + "ipAddress", + "ipAddressType" ], "type": "object", - "x-etsi-notes": "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].", - "x-etsi-ref": "6.2.3.2" - }, - "DNSRuleDescriptor": { "properties": { "dnsRuleId": { - "description": "Identifies the DNS Rule", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifies the DNS Rule" }, "domainName": { - "description": "FQDN of the DNS rule", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "FQDN of the DNS rule" }, "ipAddress": { - "description": "IP address given by the DNS rule", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "IP address given by the DNS rule" }, "ipAddressType": { "$ref": "#/components/schemas/IpAddressType" }, "ttl": { - "description": "Time-to-live value", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Int" + "description": "Time-to-live value", + "contentEncoding": "int32" } - }, - "required": [ - "dnsRuleId", - "domainName", - "ipAddressType", - "ipAddress" - ], - "type": "object", - "x-etsi-ref": "6.2.1.13" + } }, "IpAddressType": { - "description": "Specifies the IP address type", - "type": "string", + "title": "IpAddressType", "enum": [ "IP_V6", "IP_V4" + ], + "type": "string", + "description": "Specifies the IP address type", + "examples": [ + "IP_V6" ] }, "FeatureDependency": { + "title": "FeatureDependency", + "required": [ + "featureName", + "version" + ], + "type": "object", "properties": { "featureName": { - "description": "The name of the feature, for example, UserApps, UEIdentity, etc.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The name of the feature, for example, UserApps, UEIdentity, etc." }, "version": { - "description": "The version of the feature.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The version of the feature." } - }, + } + }, + "InterfaceDescriptor": { + "title": "InterfaceDescriptor", "required": [ - "featureName", - "version" + "interfaceType" ], "type": "object", - "x-etsi-ref": "6.2.1.8" - }, - "Hash": { - "description": "'String 1 The hexadecimal value of the checksum'", - "type": "string" - }, - "InterfaceDescriptor": { "properties": { "dstIPAddress": { - "description": "If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface." }, "dstMACAddress": { - "description": "If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface." }, "interfaceType": { "$ref": "#/components/schemas/InterfaceType" }, "srcMACAddress": { - "description": "If the interface type is MAC, the source address identifies the MAC address of the interface.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "If the interface type is MAC, the source address identifies the MAC address of the interface." }, "tunnelInfo": { "$ref": "#/components/schemas/TunnelInfo" } - }, - "required": [ - "interfaceType" - ], - "type": "object", - "x-etsi-ref": "6.2.1.11" + } }, "InterfaceType": { - "description": "Type of interface.", - "type": "string", + "title": "InterfaceType", "enum": [ "TUNNEL", "MAC", "IP" + ], + "type": "string", + "description": "Type of interface.", + "examples": [ + "TUNNEL" ] }, "LatencyDescriptor": { + "title": "LatencyDescriptor", + "required": [ + "maxLatency" + ], + "type": "object", "properties": { "maxLatency": { - "description": "The value of the maximum latency in nano seconds tolerated by the MEC application. See note.", - "format": "Uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The value of the maximum latency in nano seconds tolerated by the MEC application. See note.", + "contentEncoding": "int32" } - }, + } + }, + "LinkType": { + "title": "LinkType", "required": [ - "maxLatency" + "href" ], "type": "object", - "x-etsi-notes": "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance).", - "x-etsi-ref": "6.2.1.14" - }, - "LinkType": { "properties": { "href": { - "description": "URI referring to a resource", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" + "description": "URI referring to a resource" } - }, - "required": [ - "href" - ], - "type": "object", - "x-etsi-ref": "6.5.2" + } }, "ProblemDetails": { + "title": "ProblemDetails", + "type": "object", "properties": { "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "A human-readable explanation specific to this occurrence of the problem" }, "instance": { - "description": "A URI reference that identifies the specific occurrence of the problem", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" + "description": "A URI reference that identifies the specific occurrence of the problem" }, "status": { - "description": "The HTTP status code for this occurrence of the problem", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The HTTP status code for this occurrence of the problem", + "contentEncoding": "int32" }, "title": { - "description": "A short, human-readable summary of the problem type", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "A short, human-readable summary of the problem type" }, "type": { - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", - "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" } - }, - "type": "object" - }, - "SerializerTypes": { - "type": "string" + } }, "ServiceDependency": { + "title": "ServiceDependency", + "required": [ + "serName", + "version" + ], + "type": "object", "properties": { "requestedPermissions": { - "description": "Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4].\nThe format of this attribute is left for the data model design stage.", - "items": { - "$ref": "#/components/schemas/Not_specified" - }, "minItems": 0, "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Not_specified" + "items": { + "type": "string" + }, + "description": "Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4].\nThe format of this attribute is left for the data model design stage." }, "serCategory": { - "$ref": "#/components/schemas/CategoryRef" + "type": "object", + "description": "See MEC011" }, "serName": { - "description": "The name of the service, for example, RNIS, LocationService, etc.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The name of the service, for example, RNIS, LocationService, etc." }, "serTransportDependencies": { - "description": "Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/TransportDependency" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "TransportDependency" + "description": "Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note." }, "version": { - "description": "The version of the service.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The version of the service." } - }, - "required": [ - "serName", - "version" - ], - "type": "object", - "x-etsi-notes": "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application.", - "x-etsi-ref": "6.2.1.17" + } }, "ServiceDescriptor": { - "description": "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'", - "type": "object", + "title": "ServiceDescriptor", "required": [ "serName", "version" ], + "type": "object", "properties": { "serName": { - "$ref": "#/components/schemas/SerName" + "type": "string", + "description": "The name of the service, for example, RNIS, LocationService, etc." }, "serCategory": { - "$ref": "#/components/schemas/CategoryRef" + "type": "object", + "description": "See MEC011" }, "version": { - "$ref": "#/components/schemas/SerVersion" + "type": "string", + "description": "The version of the service." }, "transportsSupported": { "$ref": "#/components/schemas/TransportsSupported" } - } - }, - "SerName": { - "description": "The name of the service, for example, RNIS, LocationService, etc.", - "type": "string" - }, - "SerVersion": { - "description": "The version of the service.", - "type": "string" + }, + "description": "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'" }, "TransportsSupported": { - "description": "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'", + "title": "TransportsSupported", "type": "object", - "required": [ - "featureName", - "version" - ], "properties": { "transport": { "$ref": "#/components/schemas/TransportDescriptor" }, "serializers": { - "$ref": "#/components/schemas/Serializers" + "minItems": 1, + "type": "array", + "items": { + "type": "string" + }, + "description": "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '" } - } - }, - "Serializers": { - "description": "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '", - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/SerializerTypes" - } - }, - "SwImageDescriptor": { - "description": "Ref NFV", - "type": "string" - }, - "TerminateAppInstanceOpConfig": { - "description": "NFV", - "type": "string", - "x-etsi-ref": "6.2.2.9" + }, + "description": "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'" }, "TimeStamp": { + "title": "TimeStamp", + "required": [ + "nanoSeconds", + "seconds" + ], + "type": "object", "properties": { "nanoSeconds": { - "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "format": "Uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" }, "seconds": { - "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "format": "Uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" } - }, - "required": [ - "seconds", - "nanoSeconds" - ], - "type": "object", - "x-etsi-ref": "6.2.5.4" + } }, "TrafficFilter": { + "title": "TrafficFilter", + "type": "object", "properties": { "dSCP": { - "description": "Used to match all IPv4 packets that have the same DSCP.", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Int" + "description": "Used to match all IPv4 packets that have the same DSCP.", + "contentEncoding": "int32" }, "dstAddress": { - "description": "A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes." }, "dstPort": { - "description": "A port or a range of ports.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "A port or a range of ports." }, "dstTunnelPort": { - "description": "Used for GTP tunnel based traffic rule.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Used for GTP tunnel based traffic rule." }, "protocol": { - "description": "Specify the protocol of the traffic filter.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Specify the protocol of the traffic filter." }, "qCI": { - "description": "Used to match all packets that have the same QCI.", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Int" + "description": "Used to match all packets that have the same QCI.", + "contentEncoding": "int32" }, "srcAddress": { - "description": "An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes." }, "srcPort": { - "description": "A port or a range of ports.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "A port or a range of ports." }, "srcTunnelAddress": { - "description": "Used for GTP tunnel based traffic rule.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Used for GTP tunnel based traffic rule." }, "srcTunnelPort": { - "description": "Used for GTP tunnel based traffic rule.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Used for GTP tunnel based traffic rule." }, "tC": { - "description": "Used to match all IPv6 packets that have the same TC.", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Int" + "description": "Used to match all IPv6 packets that have the same TC.", + "contentEncoding": "int32" }, "tag": { - "description": "Used for tag based traffic rule.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Used for tag based traffic rule." }, "tgtTunnelAddress": { - "description": "Used for GTP tunnel based traffic rule.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Used for GTP tunnel based traffic rule." } - }, - "type": "object", - "x-etsi-ref": "6.2.1.10" + } }, "TrafficRuleDescriptor": { + "title": "TrafficRuleDescriptor", + "required": [ + "action", + "filterType", + "priority", + "trafficFilter", + "trafficRuleId" + ], + "type": "object", "properties": { "action": { "$ref": "#/components/schemas/Action" }, "dstInterface": { - "type": "array", - "minItems": 0, "maxItems": 2, + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/InterfaceDescriptor" - } + }, + "description": "" }, "filterType": { "$ref": "#/components/schemas/FilterType" }, "priority": { - "description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence.", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Int" + "description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence.", + "contentEncoding": "int32" }, "trafficFilter": { - "description": "The filter used to identify specific flow/packets that need to be handled by the MEC host.", + "minItems": 1, + "type": "array", "items": { "$ref": "#/components/schemas/TrafficFilter" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "TrafficFilter" + "description": "The filter used to identify specific flow/packets that need to be handled by the MEC host." }, "trafficRuleId": { - "description": "Identifies the traffic rule.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Identifies the traffic rule." } - }, - "required": [ - "trafficRuleId", - "filterType", - "priority", - "trafficFilter", - "action" - ], - "type": "object", - "x-etsi-ref": "6.2.1.9" + } }, "Action": { - "description": "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'", - "type": "string", + "title": "Action", "enum": [ "DROP", "FORWARD_DECAPSULATED", @@ -2062,278 +2824,144 @@ "PASSTHROUGH", "DUPLICATED_DECAPSULATED", "DUPLICATE_AS_IS" + ], + "type": "string", + "description": "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'", + "examples": [ + "DROP" ] }, "FilterType": { - "description": "Definition of filter type: per FLOW or PACKET", - "type": "string", + "title": "FilterType", "enum": [ "FLOW", "PACKET" + ], + "type": "string", + "description": "Definition of filter type: per FLOW or PACKET", + "examples": [ + "FLOW" ] }, "TransportDependency": { + "title": "TransportDependency", + "required": [ + "labels", + "serializers", + "transport" + ], + "type": "object", "properties": { "labels": { - "description": "Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table.", + "minItems": 1, + "type": "array", "items": { "type": "string" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" + "description": "Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table." }, "serializers": { - "description": "Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport.", - "items": { - "$ref": "#/components/schemas/SerializerTypes" - }, "minItems": 1, "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "SerializerTypes" + "items": { + "type": "string" + }, + "description": "Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport." }, "transport": { "$ref": "#/components/schemas/TransportDescriptor" } - }, + } + }, + "TransportDescriptor": { + "title": "TransportDescriptor", "required": [ - "transport", - "serializers", - "labels" + "protocol", + "security", + "type", + "version" ], "type": "object", - "x-etsi-ref": "6.2.1.18" - }, - "TransportDescriptor": { "properties": { "protocol": { - "description": "The name of the protocol used. Shall be set to HTTP for a REST API.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The name of the protocol used. Shall be set to HTTP for a REST API." }, "security": { - "$ref": "#/components/schemas/SecurityInfo" + "type": "object", + "description": "See MEC011" }, "type": { - "$ref": "#/components/schemas/TransportTypes" + "type": "string" }, "version": { - "description": "The version of the protocol used.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "The version of the protocol used." } - }, + } + }, + "TunnelInfo": { + "title": "TunnelInfo", "required": [ - "type", - "protocol", - "version", - "security" + "tunnelDstAddress", + "tunnelSrcAddress", + "tunnelType" ], "type": "object", - "x-etsi-ref": "6.2.1.19" - }, - "TransportTypes": { - "type": "string" - }, - "TunnelInfo": { "properties": { "tunnelDstAddress": { - "description": "Destination address of the tunnel.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Destination address of the tunnel." }, "tunnelSpecificData": { - "$ref": "#/components/schemas/Not_specified" + "type": "string" }, "tunnelSrcAddress": { - "description": "Source address of the tunnel.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Source address of the tunnel." }, "tunnelType": { "$ref": "#/components/schemas/TunnelType" } - }, - "required": [ - "tunnelType", - "tunnelDstAddress", - "tunnelSrcAddress" - ], - "type": "object", - "x-etsi-ref": "6.2.1.12" + } }, "TunnelType": { - "description": "Type of tunnel.", - "type": "string", + "title": "TunnelType", "enum": [ "GTP-U", "GRE" + ], + "type": "string", + "description": "Type of tunnel.", + "examples": [ + "GTP-U" ] }, - "VirtualComputeDescription": { - "description": "Ref NFV", - "type": "string" - }, - "VirtualNetworkInterfaceRequirements": { - "type": "string" - }, - "VirtualStorageDescriptor": { - "description": "Ref NFV", - "type": "string" - }, - "SecurityInfo": { - "description": "See MEC011" - }, - "CategoryRef": { - "description": "See MEC011" - }, - "URI": { - "type": "string" - }, - "Not_specified": { - "type": "string" - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "206": { - "description": "Partial content" - }, - "400": { - "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized : used when the client did not submit credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden : operation is not allowed given the current status of the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "406": { - "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "412": { - "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "414": { - "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "415": { - "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "416": { - "description": "Range Not Satisfiable ." - }, - "422": { - "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "example": { - "application/problem+json": { - "problemDetails": { - "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", - "title": "Too many targets", - "status": "422", - "detail": "The target area for the request is considered too large", - "instance": "/meAppClient.example.com/77777/msgs/abc" - } - } - } - } - } - }, - "429": { - "description": "Too Many Requests : used when a rate limiter has triggered.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } + "OperationalState": { + "title": "OperationalState", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string", + "examples": [ + "DISABLED" + ] }, - "AppPkgContent.200": { - "description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD." + "OperationState": { + "title": "OperationState", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string", + "examples": [ + "DISABLED" + ] } } - } + }, + "security": [ + {} + ] } \ No newline at end of file -- GitLab