MEC010-2_AppPkgMgmt.yaml 78.1 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
        '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: []
Elian Kraja's avatar
Elian Kraja committed
  /app_packages/{appPkgId}/appd:
    get:
      tags:
      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.
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Content of the AppD is returned.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AppD'
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
  /onboarded_app_packages/{appDId}/appd:
    get:
      tags:
      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.
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Content of the AppD is returned.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AppD'
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_packages/{appPkgId}/package_content:
    get:
      tags:
      summary:  'Fetch the onboarded application package content identified by appPkgId or appDId.'
      description: Fetch the onboarded application package content identified by appPkgId or appDId.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appPkgGET
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an on-boarded individual application package
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      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: {}
Elian Kraja's avatar
Elian Kraja committed
        '206':
          description: On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.
          headers: {}
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
        '416':
          description: Range Not Satisfiable .
          headers: {}
          content: {}
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
    put:
      tags:
      summary:  'Uploads the content of application package.'
      description: Uploads the content of application package.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appPkgPUT
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an on-boarded individual application package
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: ''
Elian Kraja's avatar
Elian Kraja committed
        content:
        required: false
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '202':
          description: The application package has been accepted for uploading, but the processing has not 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
  /onboarded_app_packages/{appDId}/package_content:
    get:
      tags:
      summary:  'Fetch the onboarded application package content identified by appPkgId or appDId.'
      description: Fetch the onboarded application package content identified by appPkgId or appDId.
Elian Kraja's avatar
Elian Kraja committed
      operationId: appDIdGET
      parameters:
      - name: appDId
        in: path
        description: Identifier of an application descriptor
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      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: {}
Elian Kraja's avatar
Elian Kraja committed
        '206':
          description: On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.
          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'
        '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:  'Fetch the onboarded application package content identified by appPkgId or appDId.'
      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:
        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'
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'
        '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: []
###############################################################################
# Notification endpoint AppPkgNotification                                    #
###############################################################################
  /user_defined_notification:
    post:
Elian Kraja's avatar
Elian Kraja committed
      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: []
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: Notification endpoint to be created
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
Elian Kraja's avatar
Elian Kraja committed
            schema:
              $ref: '#/components/schemas/AppPkgNotification'
        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
        '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:
    AppD:
      title: AppD
      required:
      - appDId
      - appDVersion
      - appDescription
      - appName
      - appProvider
      - appSoftVersion
      - mecVersion
      - swImageDescriptor
      - virtualComputeDescriptor
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appDId:
          type: string
          description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.
Elian Kraja's avatar
Elian Kraja committed
        appDNSRule:
          type: array
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/DNSRuleDescriptor'
          description: Describes DNS rules the MEC application requires.
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
        appDescription:
          type: string
          description: Human readable description of the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appExtCpd:
          type: array
Elian Kraja's avatar
Elian Kraja committed
          items:
            $ref: '#/components/schemas/AppExternalCpd'
          description: Describes external interface(s) exposed by this MEC application.
        appFeatureOptional:
Elian Kraja's avatar
Elian Kraja committed
          type: array
          items:
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency'
          description: Describes features a MEC application may use if available.
        appFeatureRequired:
Elian Kraja's avatar
Elian Kraja committed
          type: array
          items:
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency'
          description: Describes features a MEC application requires to run.
Elian Kraja's avatar
Elian Kraja committed
        appInfoName:
          type: string
          description: Human readable name for the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appLatency:
          $ref: './MEC010p2_v221_definitions.yaml#/definitions/LatencyDescriptor'
Elian Kraja's avatar
Elian Kraja committed
        appName:
          type: string
          description: Name to identify the MEC application.
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
        appServiceOptional:
          type: array
Elian Kraja's avatar
Elian Kraja committed
          items:
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency'
          description: Describes services a MEC application may use if available.
        appServiceProduced:
Elian Kraja's avatar
Elian Kraja committed
          type: array
          items:
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/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:
Elian Kraja's avatar
Elian Kraja committed
          type: array
          items:
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency'
          description: Describes services a MEC application requires to run.
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
        appTrafficRule:
          type: array
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/TrafficRuleDescriptor'
          description: Describes traffic rules the MEC application requires.
Elian Kraja's avatar
Elian Kraja committed
        changeAppInstanceStateOpConfig:
          type: string
          description: NFV
Elian Kraja's avatar
Elian Kraja committed
        mecVersion:
          type: array
          items:
            type: string
          description: Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. The value shall be formatted as comma-separated list of strings. Each entry shall have the format <x>.<y>.<z> where <x>, <y> and <z> are decimal numbers representing the version of the present document. Whitespace between list entries shall be trimmed before validation.
Elian Kraja's avatar
Elian Kraja committed
        swImageDescriptor:
          type: string
          description: Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application.
Elian Kraja's avatar
Elian Kraja committed
        terminateAppInstanceOpConfig:
          type: string
          description: NFV
Elian Kraja's avatar
Elian Kraja committed
        transportDependencies:
          type: array
            $ref: './MEC010p2_v221_definitions.yaml#/definitions/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.
Elian Kraja's avatar
Elian Kraja committed
        virtualComputeDescriptor:
          description: Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisation container used to realize this MEC application.
          type: object

Elian Kraja's avatar
Elian Kraja committed
        virtualStorageDescriptor:
          type: array
          items:
            type: string
          description: Defines descriptors of virtual storage resources to be used by the MEC application.
        userContextTransferCapability:
          $ref: './MEC010p2_v221_definitions.yaml#/definitions/UserContextTransferCapability'
        appNetworkPolicy:
          $ref: './MEC010p2_v221_definitions.yaml#/definitions/AppNetworkPolicy'
    
    AppExternalCpd:
      title: AppExternalCpd
Elian Kraja's avatar
Elian Kraja committed
      required:
      - inherited_attributes
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        inherited_attributes:
          type: object
          description: All attributes inherited from Cpd.
Elian Kraja's avatar
Elian Kraja committed
        virtualNetworkInterfaceRequirements:
          type: array
          items:
            type: string
          description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD.
Elian Kraja's avatar
Elian Kraja committed
    AppPkgInfo:
      title: AppPkgInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - appDId
      - appName
      - appSoftwareVersion
      - appDVersion
      - checksum
      - softwareImages
      - onboardingState
      - operationalState
      - usageState
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: Identifier of the onboarded application package.
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
        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.
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
        checksum:
          $ref: '#/components/schemas/Checksum'
        signingCertificate:
          type: string
          description: The singleton signing certificate if it is included as a file in the AppD archive.
Elian Kraja's avatar
Elian Kraja committed
        softwareImages:
          type: object
          description: Information of application software image in application package. Type is TBD
Elian Kraja's avatar
Elian Kraja committed
        additionalArtifacts:
          type: object
          description: Additional information of application package artifacts that are not application software images. Type is TBD
Elian Kraja's avatar
Elian Kraja committed
        onboardingState:
          $ref: '#/components/schemas/OnboardingState'
        operationalState:
          $ref: '#/components/schemas/AppPkg.OperationalState'
        usageState:
          $ref: '#/components/schemas/UsageState'
        mecInfo:
          type: array
          description: The MEC version that compatible with this application. This information is copied from the AppD.
          items:
            type: string
        onBoardingFailureDetails: 
          description: Failure details of current onboarding procedure
          $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        userDefinedData:
          $ref: '#/components/schemas/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'"
Elian Kraja's avatar
Elian Kraja committed
        _links:
          $ref: '#/components/schemas/AppPkgInfo.links'
      description: "'The data type AppPkgInfo represents the parameters for an application package resource'"
Elian Kraja's avatar
Elian Kraja committed
    AppPkgInfoModifications:
      title: AppPkgInfoModifications
      required:
      - operationState
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        operationState:
          $ref: '#/components/schemas/OperationState'
      description: "'The data type represents the operational state for an application package resource'"
Elian Kraja's avatar
Elian Kraja committed
    AppPkg.OperationalState:
      title: AppPkg.OperationalState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - ENABLED
      - DISABLED
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Onboarding state of application package
      examples:
      - CREATED
    UsageState:
      title: UsageState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - IN_USE
      - NOT_IN_USE
      type: string
      description: Usage state of the onboarded instance of the application package
      examples:
      - IN_USE
Elian Kraja's avatar
Elian Kraja committed
    AppPkgInfo.links:
      title: AppPkgInfo.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      - appD
      - appPkgContent
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        appD:
          $ref: '#/components/schemas/LinkType'
        appPkgContent:
          $ref: '#/components/schemas/LinkType'
        vnfPkgInfo:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    AppPkgNotification:
      title: AppPkgNotification
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - appPkgId
      - appDId
      - operationalState
      - _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/AppPkg.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'
        appPkgId:
          type: string
          description: Identifier of the onboarded application package.
Elian Kraja's avatar
Elian Kraja committed
        appDId:
          type: string
          description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
        operationalState:
          $ref: '#/components/schemas/OperationalState'
Elian Kraja's avatar
Elian Kraja committed
        _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'"
Elian Kraja's avatar
Elian Kraja committed
    AppPkg.NotificationType:
      title: AppPkg.NotificationType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - AppPackageOnBoarded
      - AppPacakgeEnabled
      - AppPacakgeDisabled
      - AppPackageDeleted
      type: string
      description: Discriminator for the different notification types
      examples:
      - AppPackageOnBoarded
Elian Kraja's avatar
Elian Kraja committed
    AppPkgNotification.links:
      title: AppPkgNotification.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - subscription
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    AppPkgSubscriptionInfo:
      title: AppPkgSubscriptionInfo
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: Identifier of the subscription to application package notification.
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          description: Type of subscription.
          $ref: '#/components/schemas/AppPkgSubscriptionType'
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/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'"
    
    AppPkgSubscriptionType:
      title: AppPkgSubscriptionType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - AppPackageOnBoardingSubscription
      - AppPackageChangeSubscription
      - AppPackageDeletionSubscription
      type: string
      description: type of a subscription.
      - AppPackageOnBoardingSubscription
Elian Kraja's avatar
Elian Kraja committed
    AppPkgSubscriptionInfo.links:
      title: AppPkgSubscriptionInfo.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
    AppPkgSubscriptionLinkList:
      title: AppPkgSubscriptionLinkList
Elian Kraja's avatar
Elian Kraja committed
      required:
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        _links:
          $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links'
      description: "'The data type represents a subscription link list of notification on application package management'"
Elian Kraja's avatar
Elian Kraja committed
    AppPkgSubscriptionLinkList.links:
      title: AppPkgSubscriptionLinkList.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/Subscriptions.AppPkgSubscription'
          description: ''
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    Subscriptions.AppPkgSubscription:
      title: Subscriptions.AppPkgSubscription
Elian Kraja's avatar
Elian Kraja committed
      required:
      - subscriptionType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        href:
          type: string
          description: The URI referring to the subscription.
        subscriptionType:
          $ref: '#/components/schemas/AppPkgSubscriptionType'
      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.'"
Elian Kraja's avatar
Elian Kraja committed
    AppPkgSubscription:
      title: AppPkgSubscription
Elian Kraja's avatar
Elian Kraja committed
      required:
      - callbackUri
      - subscriptionType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
        subscriptionType:
          $ref: '#/components/schemas/AppPkgSubscriptionType'
Elian Kraja's avatar
Elian Kraja committed
        appPkgFilter:
          type: array
          items:
            $ref: '#/components/schemas/AppPkgFilter'
          description: The attribute-based filter is to filter application packages on which the query applies
      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.'"
    

    AppPkgFilter:
      title: AppPkgFilter
      type: object
      properties:
        appPkgInfoId:
          type: string
          description: Match the application package identifier which is allocated by the MEO. The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter.
        appDId:
          type: string
          description: Match the application descriptor identifier which is allocated by the application provider. The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter.