MEC010-2_AppLcm.yaml 66.3 KB
Newer Older
openapi: 3.1.0
Elian Kraja's avatar
Elian Kraja committed
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'
Elian Kraja's avatar
Elian Kraja committed
  contact:
Elian Kraja's avatar
Elian Kraja committed
    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
Elian Kraja's avatar
Elian Kraja committed
servers:
- url: https://localhost/app_lcm/v1
  variables: {}
Elian Kraja's avatar
Elian Kraja committed
paths:
  /app_instances:
Elian Kraja's avatar
Elian Kraja committed
    post:
      tags:
      - 'app-lcm'
      summary:  'Create an application instance resource'
      description: Create an application instance resource
Elian Kraja's avatar
Elian Kraja committed
      operationId: appInstancePOST
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAppInstanceRequest'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '201':
          description: An application instance identifier and the related resource has been created successfully.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
Elian Kraja's avatar
Elian Kraja committed
              schema:
                $ref: '#/components/schemas/AppInstanceInfo'
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
    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
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Array the representations of zero or more application instances
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppInstanceInfo'
                description: ''
                contentMediaType: application/json
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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}:
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appInstanceIdGET
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Contains a representation of the read resource.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          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'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
    delete:
      tags:
      - 'app-lcm'
      summary: 'Deletes an  individual application instance resource.'
      description: Deletes an  individual application instance resource.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appInstanceIdDELETE
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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:
Elian Kraja's avatar
Elian Kraja committed
    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
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmSubscriptionsPOST
      parameters:
      - name: subscriptionType
        in: query
        description: >-
          "Query parameter to filter on a specific subscription type. Permitted values:
            • "AppInstanceStateChange"
            • "AppLcmOpOccStateChange"
          "
Elian Kraja's avatar
Elian Kraja committed
        required: true
        style: form
        explode: true
        schema:
          oneOf:
          - $ref: '#/components/schemas/AppInst.SubscriptionType'
          - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType'
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/AppInstSubscriptionRequest'
              - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest'
              contentMediaType: application/json
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '201':
          description: a representation of the created SubscriptionInfo.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AppInstSubscriptionInfo'
                - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo'
                contentMediaType: application/json
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmSubscriptionsGET
      parameters:
      - name: subscriptionType
        in: query
        description: 'Permitted values: AppInstanceStateChange or  AppLcmOpOccStateChange'
        style: form
        explode: true
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: List of all subscriptions is returned.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionLinkList'
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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}:
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Representation of the resource.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AppInstSubscriptionInfo'
                - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo'
                contentMediaType: application/json
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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:
Elian Kraja's avatar
Elian Kraja committed
      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.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appInstNotificationPOST
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/AppInstNotification'
              - $ref: '#/components/schemas/AppLcmOpOccNotification'
              contentMediaType: application/json
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
  /app_instances/{appInstanceId}/instantiate:
    post:
      tags:
      - 'app-lcm'
      summary: 'Deletes the individual subscription to notifications about application package changes in MEO.'
      description: task of instantiating an application instance.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmInstanciatePOST
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
Elian Kraja's avatar
Elian Kraja committed
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstantiateAppRequest'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '202':
          description: accepted for processing, but the processing has not yet been completed.
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
  /app_instances/{appInstanceId}/terminate:
    post:
      tags:
      - 'app-lcm'
      summary: 'terminate an application instance.'
      description: terminate an application instance.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmTerminatePOST
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
Elian Kraja's avatar
Elian Kraja committed
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TerminateAppRequest'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '202':
          description: accepted for processing, but the processing has not yet been completed.
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
  /app_instances/{appInstanceId}/operate:
    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
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmOperatePOST
      parameters:
      - name: appInstanceId
        in: path
        description: Identifier of an individual application instance
Elian Kraja's avatar
Elian Kraja committed
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperateAppRequest'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '202':
          description: accepted for processing, but the processing has not yet been completed.
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
  /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
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Status information for zero or more application instance lifecycle management operation occurrences was queried successfully
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppInstanceLcmOpOcc'
                description: ''
                contentMediaType: application/json
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
  /app_lcm_op_occs/{appLcmOpOccId}:
    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
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmOpOccsbyIdGET
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Information about an application LCM operation occurrence was read successfully
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          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'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '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'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
components:
  schemas:
    AppInstanceLcmOpOcc:
      title: AppInstanceLcmOpOcc
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - operationState
      - stateEnteredTime
      - startTime
      - lcmOperation
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: "'Identifier of the subscription to application LCM operation occurrence notification'"
Elian Kraja's avatar
Elian Kraja committed
        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'"
Elian Kraja's avatar
Elian Kraja committed
    OperationParams:
      title: OperationParams
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
    AppInstanceLcmOpOcc.links:
      title: AppInstanceLcmOpOcc.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      - appInstance
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        appInstance:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    SubscriptionLinkList:
      title: SubscriptionLinkList
Elian Kraja's avatar
Elian Kraja committed
      required:
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        _links:
          $ref: '#/components/schemas/SubscriptionLinkList.links'
      description: "'The data type represents a subscription link list of notification on application lifecycle management. '"
Elian Kraja's avatar
Elian Kraja committed
    SubscriptionLinkList.links:
      title: SubscriptionLinkList.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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.
Elian Kraja's avatar
Elian Kraja committed
    SubscriptionLinkList.links.subscriptions:
      title: SubscriptionLinkList.links.subscriptions
Elian Kraja's avatar
Elian Kraja committed
      required:
      - href
      - subscriptionType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
Elian Kraja's avatar
Elian Kraja committed
          type: string
        subscriptionType:
          $ref: '#/components/schemas/SubscriptionType'
      description: A link list to the subscriptions
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccSubscriptionInfo:
      title: AppLcmOpOccSubscriptionInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - subscriptionType
      - callbackUri
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: "''"
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          const: AppLcmOpOccStateChange
          type: string
          description: Shall be set to AppLcmOpOccStateChange.
          examples:
          - AppLcmOpOccStateChange
Elian Kraja's avatar
Elian Kraja committed
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
Elian Kraja's avatar
Elian Kraja committed
        _links:
          $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links'
      description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'"
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOcc.SubscriptionType:
      title: AppLcmOpOcc.SubscriptionType
      const: AppLcmOpOccStateChange
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Shall be set to AppLcmOpOccStateChange.
      examples:
      - AppLcmOpOccStateChange
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccSubscriptionInfo.links:
      title: AppLcmOpOccSubscriptionInfo.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    AppInstSubscriptionInfo:
      title: AppInstSubscriptionInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - subscriptionType
      - notificationType
      - callbackUri
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: "'Identifier of the subscription to application instance operational state change notification.'"
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          const: AppInstanceStateChange
          type: string
          description: Shall be set to AppInstanceStateChange.
          examples:
          - AppInstanceStateChange
Elian Kraja's avatar
Elian Kraja committed
        notificationType:
          $ref: '#/components/schemas/AppInst.NotificationType'
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
Elian Kraja's avatar
Elian Kraja committed
        _links:
          $ref: '#/components/schemas/AppInstSubscriptionInfo.links'
      description: "'The data type represents a subscription to notification of application instance operational state change.'"
Elian Kraja's avatar
Elian Kraja committed
    AppInst.SubscriptionType:
      title: AppInst.SubscriptionType
      const: AppInstanceStateChange
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Shall be set to AppInstanceStateChange.
      examples:
      - AppInstanceStateChange
Elian Kraja's avatar
Elian Kraja committed
    AppInst.NotificationType:
      title: AppInst.NotificationType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - NOT_INSTANTIATED
      - STARTED
      - STOPPED
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Subscribed notification
      examples:
      - NOT_INSTANTIATED
Elian Kraja's avatar
Elian Kraja committed
    AppInstSubscriptionInfo.links:
      title: AppInstSubscriptionInfo.links
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
    AppLcmOpOccSubscriptionRequest:
      title: AppLcmOpOccSubscriptionRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
      - callbackUri
      - subscriptionType
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        appLcmOpOccSubscriptionFilter:
          $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter'
        callbackUri:
          type: string
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          type: string
          description: Shall be set to "AppLcmOpOccStateChange".
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccSubscriptionFilter:
      title: AppLcmOpOccSubscriptionFilter
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Match particular notification types.
      examples:
      - AppLcmOperationOccurrenceNotification
Elian Kraja's avatar
Elian Kraja committed
    OperationStates:
      title: OperationStates
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'"
      examples:
      - STARTING
    OperationTypes:
      title: OperationTypes
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - INSTANTIATE
      - OPERATE
      - TERMINATE
      type: string
      description: "'Type of the LCM operation represented by this application instance LCM operation occurrence.'"
      examples:
      - INSTANTIATE
Elian Kraja's avatar
Elian Kraja committed
    CreateAppInstanceRequest:
      title: CreateAppInstanceRequest
      required:
      - appDId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceDescription:
          type: string
          description: Human-readable description of the application instance to be created.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceName:
          type: string
          description: Human-readable name of the application instance to be created.
Elian Kraja's avatar
Elian Kraja committed
    AppInstSubscriptionRequest:
      title: AppInstSubscriptionRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
      - subscriptionType
      - callbackUri
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        subscriptionType:
          const: AppInstanceStateChange
          type: string
          description: Shall be set to AppInstanceStateChange.
          examples:
          - AppInstanceStateChange
Elian Kraja's avatar
Elian Kraja committed
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceState:
          $ref: '#/components/schemas/AppInstanceState'
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'
    AppInstanceSubscriptionFilter:
      title: AppInstanceSubscriptionFilter
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appInstSelectorType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appInstSelectorType:
          $ref: '#/components/schemas/AppInstSelectorType'
        appInstances:
          type: array
          items:
            type: string
          description: ''
Elian Kraja's avatar
Elian Kraja committed
        appsFromProviders:
          type: array
          items:
            $ref: '#/components/schemas/AppsFromProviders'
          description: ''
      description: "'This data type represents subscription filter criteria to match application instances. '"
Elian Kraja's avatar
Elian Kraja committed
    AppsFromProviders:
      title: AppsFromProviders
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appProvider
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appProvider:
          type: string
          description: Provider of the application and of the AppD.
Elian Kraja's avatar
Elian Kraja committed
        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.'"
Elian Kraja's avatar
Elian Kraja committed
    AppProducts:
      title: AppProducts
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appName
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appName:
          type: string
          description: Name to identify the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        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.'"
Elian Kraja's avatar
Elian Kraja committed
    AppProducts.Versions:
      title: AppProducts.Versions
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appSoftVersion
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appSoftVersion:
          type: string
          description: Identifies the version of software of the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        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.'"
Elian Kraja's avatar
Elian Kraja committed
    AppInstSelectorType:
      title: AppInstSelectorType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - VOID
      - APP_IDENTITY
      - APP_NAME
      - APP_D_ID
      - APP_FROM_PROVIDER
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: 0 = void
      examples:
      - VOID
    AppInstanceState:
      title: AppInstanceState
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
    AppInstNotification:
      title: AppInstNotification
      required:
      - _links
      - appDId
      - appInstanceId
      - appPkgId
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        _links:
          $ref: '#/components/schemas/Links'
Elian Kraja's avatar
Elian Kraja committed
        appDId:
          type: string
          description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceId:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        appPkgId:
          type: string
          description: Identifier of the onboarded application package.
Elian Kraja's avatar
Elian Kraja committed
        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.
Elian Kraja's avatar
Elian Kraja committed
        notificationType:
          $ref: '#/components/schemas/AppInst.NotificationType'
        subscriptionId:
          type: string
          description: Identifier of the subscription related to this notification.
Elian Kraja's avatar
Elian Kraja committed
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
    AppInstanceInfo:
      title: AppInstanceInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - appDId
      - appProvider
      - appName
      - appSoftVersion
      - appDVersion
      - appPkgId
      - instantiationState
Elian Kraja's avatar
Elian Kraja committed
      - _links
      type: object
      properties:
        id:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceName:
          type: string
          description: Name of the application instance.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceDescription:
          type: string
          description: Human-readable description of the application instance to be created.
Elian Kraja's avatar
Elian Kraja committed
        appDId:
          type: string
          description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
Elian Kraja's avatar
Elian Kraja committed
        appProvider:
          type: string
          description: Provider of the application and of the AppD.
Elian Kraja's avatar
Elian Kraja committed
        appName:
          type: string
          description: Name to identify the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appSoftVersion:
          type: string
          description: Identifies the version of software of the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appDVersion:
          type: string
          description: Identifies the version of the application descriptor.
Elian Kraja's avatar
Elian Kraja committed
        appPkgId:
          type: string
          description: Identifier of the onboarded application package.
Elian Kraja's avatar
Elian Kraja committed
        vimConnectionInfo:
          type: array
          items:
            $ref: '#/components/schemas/VimConnectionInfo'
          description: ''
Elian Kraja's avatar
Elian Kraja committed
        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.'"
Elian Kraja's avatar
Elian Kraja committed
    OperationState:
      title: OperationState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Operation state
      examples:
      - STARTING
Elian Kraja's avatar
Elian Kraja committed
    InstantiationState:
      title: InstantiationState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - NOT_INSTANTIATED
      - INSTANTIATED
      type: string
      description: Instantiation state of the application instance
      examples:
      - NOT_INSTANTIATED
Elian Kraja's avatar
Elian Kraja committed
    InstantiatedAppState:
      title: InstantiatedAppState
Elian Kraja's avatar
Elian Kraja committed
      required:
      - operationalState
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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.'"
Elian Kraja's avatar
Elian Kraja committed
    OperationalState:
      title: OperationalState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTED
      - STOPPED
      type: string
      description: Operational state is applicable in the instantiation state INSTANTIATED
      examples:
      - STARTED
Elian Kraja's avatar
Elian Kraja committed
    AppInstanceInfo.links:
      title: AppInstanceInfo.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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.
Elian Kraja's avatar
Elian Kraja committed
    LcmOperation:
      title: LcmOperation
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - INSTATIATE
      - OPERATE
      - TERMINATE
      type: string
      description: Type of the actual LCM operation represented by this application instance LCM operation occurrence
      examples:
      - INSTATIATE
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccNotification:
      title: AppLcmOpOccNotification
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - appLcmOpOccId
      - appInstanceId
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: "''"
Elian Kraja's avatar
Elian Kraja committed
        notificationType:
          $ref: '#/components/schemas/AppLcmOpOcc.NotificationType'
        subscriptionId:
          type: string
          description: Identifier of the subscription related to this notification.
Elian Kraja's avatar
Elian Kraja committed
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appLcmOpOccId:
          type: string
          description: Identifier of application lifecycle management operation occurrence.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceId:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        _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'"
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOcc.NotificationType:
      title: AppLcmOpOcc.NotificationType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Discriminator for the different notification types
      examples:
      - STARTING
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccNotification.links:
      title: AppLcmOpOccNotification.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appInstance
      - subscription
      - appLcmOpOcc
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appInstance:
          $ref: '#/components/schemas/LinkType'
        subscription:
          $ref: '#/components/schemas/LinkType'
        appLcmOpOcc:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    InstantiateAppRequest:
      title: InstantiateAppRequest
      required:
      - selectedMECHostInfo
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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:
Elian Kraja's avatar
Elian Kraja committed
          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.
Elian Kraja's avatar
Elian Kraja committed
        virtualComputeDescriptor:
          type: string
          description: Ref NFV
Elian Kraja's avatar
Elian Kraja committed
        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
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        href:
          type: string
          description: URI referring to a resource
Elian Kraja's avatar
Elian Kraja committed
    LocationConstraints:
      title: LocationConstraints
Elian Kraja's avatar
Elian Kraja committed
      required:
      - countryCode
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        countryCode:
          type: string
          description: The two-letter ISO 3166 country code in capital letters.
Elian Kraja's avatar
Elian Kraja committed
        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'"
Elian Kraja's avatar
Elian Kraja committed
    CivicAddressElement:
      title: CivicAddressElement
Elian Kraja's avatar
Elian Kraja committed
      required:
      - caType
      - caValue
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
        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.'"
Elian Kraja's avatar
Elian Kraja committed
    MECHostInformation:
      title: MECHostInformation
      required:
      - hostId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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'"
Elian Kraja's avatar
Elian Kraja committed
        hostName:
          type: string
          description: Human-readable name of MEC host.
    OperateAppRequest:
      title: OperateAppRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
      - changeStateTo
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
        stopType:
          $ref: '#/components/schemas/StopType'
    StopType:
      title: StopType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - FORCEFUL
      - GRACEFUL
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Signals forceful or graceful stop
      examples:
      - FORCEFUL
    ChangeStateTo:
      title: ChangeStateTo
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTED
      - STOPPED
      type: string
      description: The desired operational state
      examples:
      - STARTED
Elian Kraja's avatar
Elian Kraja committed
    ProblemDetails:
      title: ProblemDetails
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        title:
          type: string
          description: A short, human-readable summary of the problem type
Elian Kraja's avatar
Elian Kraja committed
        type:
          type: string
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
Elian Kraja's avatar
Elian Kraja committed
    TerminateAppRequest:
      title: TerminateAppRequest
      required:
      - terminationType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
        terminationType:
          $ref: '#/components/schemas/TerminationType'
    TimeStamp:
      title: TimeStamp
Elian Kraja's avatar
Elian Kraja committed
      required:
      - nanoSeconds
      - seconds
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
        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
Elian Kraja's avatar
Elian Kraja committed
    TerminationType:
      title: TerminationType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - FORCEFUL
      - GRACEFUL
      type: string
      description: "'Indicates whether forceful or graceful termination is requested.'"
      examples:
      - FORCEFUL
Elian Kraja's avatar
Elian Kraja committed
    VimConnectionInfo:
      title: VimConnectionInfo
      required:
      - id
      - vimType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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'"
Elian Kraja's avatar
Elian Kraja committed
        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'"
Elian Kraja's avatar
Elian Kraja committed
        id:
          type: string
          description: The identifier of the VIM Connection. This identifier is managed by the MEO.
Elian Kraja's avatar
Elian Kraja committed
        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'"
Elian Kraja's avatar
Elian Kraja committed
        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.
Elian Kraja's avatar
Elian Kraja committed
        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
Elian Kraja's avatar
Elian Kraja committed
      required:
      - subscription
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this notification.
    SubscriptionType:
      title: SubscriptionType
      enum:
      - AppInstanceStateChange
      - AppLcmOpOccStateChange
Elian Kraja's avatar
Elian Kraja committed
      type: string
      examples:
      - AppInstanceStateChange
security:
- {}