MEC010-2_AppPkgMgmt.yaml 78.1 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.2.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
  description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.2.1'
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.02.01_60/gs_MEC01002v020201p.pdf'
tags:
- name: app-pkgm
  description: App Package management
- name: app-pkgm-notifications
  description: App Package management notifications
Elian Kraja's avatar
Elian Kraja committed
servers:
- url: https://localhost/app_pkgm/v1
  variables: {}
Elian Kraja's avatar
Elian Kraja committed
paths:
  /app_packages:
    post:
      tags:
      - app-pkgm
      summary:  'Create a resource for on-boarding an application package to a MEO/MEAO'
      description: Create a resource for on-boarding an application package to a MEO/MEAO
Elian Kraja's avatar
Elian Kraja committed
      operationId: app_packagesPOST
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: Resource to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAppPkg'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '201':
          description: Successful response for resource creation
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfo'
                description: The response body shall contain a representation of the application package resource
                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
    get:
      tags:
      - app-pkgm
      summary: Queries information relating to on-boarded application packages in the MEO/MEAO'
      description: queries information relating to on-boarded application packages in the MEO/MEAO
Elian Kraja's avatar
Elian Kraja committed
      operationId: app_packagesGET
      parameters:
      - name: filter
        in: query
        description: Attribute-based filtering parameters according to ETSI GS MEC 009
        style: form
        explode: true
        schema:
          type: string
      - name: all_fields
        in: query
        description: Include all complex attributes in the response.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: Complex attributes of AppPkgInfo to be included into the response
        style: form
        explode: true
        schema:
          type: string
      - name: exclude_fields
        in: query
        description: Complex attributes of AppPkgInfo to be excluded from the response.
        style: form
        explode: true
        schema:
          type: string
      - name: exclude_default
        in: query
        description: Indicates to exclude the following complex attributes of AppPkgInfo from the response.
        style: form
        explode: true
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Contains a representation of the application package resource
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppPkgInfo'
                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: []
  
  /onboarded_app_packages:
      post:
        tags:
        - app-pkgm
        summary:  'Create a resource for on-boarding an application package to a MEO/MEAO'
        description: Create a resource for on-boarding an application package to a MEO/MEAO
        operationId: onboarded_app_packagesPOST
        parameters: []
        requestBody:
          description: Resource to be created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAppPkg'
          required: true
        responses:
          '201':
            description: Successful response for resource creation
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/AppPkgInfo'
                  description: The response body shall contain a representation of the application package resource
                  contentMediaType: application/json
          '400':
            description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '401':
            description: 'Unauthorized :  used when the client did not submit credentials.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '403':
            description: 'Forbidden :  operation is not allowed given the current status of the resource.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '404':
            description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '406':
            description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '429':
            description: 'Too Many Requests : used when a rate limiter has triggered.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
        deprecated: false
      get:
        tags:
        - app-pkgm
        summary: Queries information relating to on-boarded application packages in the MEO/MEAO'
        description: queries information relating to on-boarded application packages in the MEO/MEAO
        operationId: onboarded_app_packagesGET
        parameters:
        - name: filter
          in: query
          description: Attribute-based filtering parameters according to ETSI GS MEC 009
          style: form
          explode: true
          schema:
            type: string
        - name: all_fields
          in: query
          description: Include all complex attributes in the response.
          style: form
          explode: true
          schema:
            type: string
        - name: fields
          in: query
          description: Complex attributes of AppPkgInfo to be included into the response
          style: form
          explode: true
          schema:
            type: string
        - name: exclude_fields
          in: query
          description: Complex attributes of AppPkgInfo to be excluded from the response.
          style: form
          explode: true
          schema:
            type: string
        - name: exclude_default
          in: query
          description: Indicates to exclude the following complex attributes of AppPkgInfo from the response.
          style: form
          explode: true
          schema:
            type: string
        responses:
          '200':
            description: Contains a representation of the application package resource
            headers: {}
            content:
              application/json:
                schema:
                  type: array
                  items:
                    $ref: '#/components/schemas/AppPkgInfo'
                  description: ''
                  contentMediaType: application/json
          '400':
            description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '401':
            description: 'Unauthorized :  used when the client did not submit credentials.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '403':
            description: 'Forbidden :  operation is not allowed given the current status of the resource.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '404':
            description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '406':
            description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
          '429':
            description: 'Too Many Requests : used when a rate limiter has triggered.'
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/ProblemDetails'
        deprecated: false
      parameters: []

Elian Kraja's avatar
Elian Kraja committed
  /app_packages/{appPkgId}:
    get:
      tags:
      - app-pkgm
      summary: 'Queries the information related to individual application package resources'
      description: Queries the information related to individual application package resources
Elian Kraja's avatar
Elian Kraja committed
      operationId: app_packageGET
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Contains a representation of the application package resource
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfo'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
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-pkgm
      summary: 'Deletes an individual application package resources in MEO/MEAO'
      description: Deletes an individual application package resources in MEO/MEAO
Elian Kraja's avatar
Elian Kraja committed
      operationId: app_packageDELETE
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        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
        '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
    patch:
      tags:
      - app-pkgm
      summary: 'Updates the operational state of an individual application package resource'
      description: Updates the operational state of an individual application package resources
Elian Kraja's avatar
Elian Kraja committed
      operationId: app_packagePATCH
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: Parameters for application package information modification.
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppPkgInfoModifications'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Shows that the operation has been completed successfully
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfoModifications'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
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: []
  
  /onboarded_app_packages/{appPkgId}:
    get:
      tags:
      - app-pkgm
      summary: 'Queries the information related to individual application package resources'
      description: Queries the information related to individual application package resources
      operationId: onboarded_app_packageGET
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Contains a representation of the application package resource
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfo'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    delete:
      tags:
      - app-pkgm
      summary: 'Deletes an individual application package resources in MEO/MEAO'
      description: Deletes an individual application package resources in MEO/MEAO
      operationId: onboarded_app_packageDELETE
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    patch:
      tags:
      - app-pkgm
      summary: 'Updates the operational state of an individual application package resource'
      description: Updates the operational state of an individual application package resources
      operationId: onboarded_app_packagePATCH
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Parameters for application package information modification.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppPkgInfoModifications'
        required: true
      responses:
        '200':
          description: Shows that the operation has been completed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfoModifications'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []

Elian Kraja's avatar
Elian Kraja committed
  /subscriptions:
    post:
      tags:
      - app-pkgm
      summary: 'Subscribe to notifications about on-boarding an application package'
      description: Subscribe to notifications about on-boarding an application package
Elian Kraja's avatar
Elian Kraja committed
      operationId: subscriptionsPOST
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        description: The input parameters of subscribe operation to notifications
Elian Kraja's avatar
Elian Kraja committed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppPkgSubscription'
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '201':
          description: Successful response for created subscription
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgSubscriptionInfo'
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#/subscription.href}':
            post:
              summary: 'Callback POST used to send a notification'
              description: ' The notification is triggered when a new application package is onboarded'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                     $ref: '#/components/schemas/AppPkgNotification'
              responses:
                '204':
                 description: "No content"
Elian Kraja's avatar
Elian Kraja committed
    get:
      tags:
      - app-pkgm
      summary:  'used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO'
      description: used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO package
Elian Kraja's avatar
Elian Kraja committed
      operationId: subscriptionsGET
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: List of zero or more subscriptions
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgSubscriptionLinkList'
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-pkgm
      summary:  'Used to represent an individual subscription to notifications about application package changes.'
      description: Used to represent an individual subscription to notifications about application package changes.
Elian Kraja's avatar
Elian Kraja committed
      operationId: individualSubscriptionGET
      parameters:
      - name: subscriptionId
        in: path
        description: Identifier of an individual subscription to notifications about application package changes
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: a response body containing a representation of the resource shall be returned.
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgSubscriptionInfo'
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-pkgm
      summary:  'Deletes the individual subscription to notifications about application package changes in MEO or MEAO.'
      description: Deletes the individual subscription to notifications about application package changes in MEO or MEAO.
Elian Kraja's avatar
Elian Kraja committed
      operationId: individualSubscriptionDELETE
      parameters:
      - name: subscriptionId
        in: path
        description: Identifier of an individual subscription to notifications about application package changes
Elian Kraja's avatar
Elian Kraja committed
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses: