Autogenerated openapi version v030101

            post:

              summary: Callback POST used to send a notification

              description: Subscription notification

              operationId: notificationPOST313135

              operationId: notificationPOST300116

              requestBody:

                description: Subscription notification

                required: true

        The API producer shall support receiving filtering parameters as part of the URI query string.

        All attribute names that appear in the AppLcmOpOcc and in data types referenced from it shall be supported in attribute-based filtering parameters. See clause 6.19 in ETSI GS MEC 009 [4] for details.'

      name: filter

      name: filter1

      in: query

      required: false

      x-exportParamName: Query.Filter1

        See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer should support this parameter.'

      name: fields

      name: fields1

      in: query

      required: false

      x-exportParamName: Query.Fields1

        See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer should support this parameter.'

      name: exclude_fields

      name: exclude_fields1

      in: query

      required: false

      x-exportParamName: Query.Exclude_fields1

        operationParams;

        _links.'

      name: exclude_default

      name: exclude_default1

      in: query

      required: false

      x-exportParamName: Query.Exclude_default1

servers:

- url: https://localhost/app_pkgm/v1

paths:

  /app_packages:

    post:

      summary: Create a new resource for onboarded application package.

      description: The POST method is used to create a resource for on-boarding an application package to a MEO/MEAO, which refers to the procedure of "onboarding operation" as described in clause 6.3.3.5. The POST method is also used to create a resource for on-boarding an application package from OSS through MEAO to NFVO as described in clause 5.6.2.

      operationId: OnboardedapppackagesPOST

      tags:

      - app-pkgm

      requestBody:

        description: The POST method is used to create a new resource for onboarding an application package onto a MEO/MEAO.

        required: true

        content:

          application/json:

            schema:

              type: object

              properties:

                CreateAppPkg:

                  $ref: '#/components/schemas/CreateAppPkg'

      responses:

        '201':

          description: "Indicates a successful request. The response message content shall contain a representation of the application package resource defined in clause\_6.2.\n\nThe HTTP response includes a \"Location\" HTTP header that contains the URI of the created resource."

          content:

            application/json:

              schema:

                type: object

                properties:

                  AppPkgInfo:

                    $ref: '#/components/schemas/AppPkgInfo'

        '400':

          $ref: '#/components/responses/400'

        '401':

          $ref: '#/components/responses/401'

        '403':

          $ref: '#/components/responses/403'

        '404':

          $ref: '#/components/responses/404'

        '406':

          $ref: '#/components/responses/406'

        '429':

          $ref: '#/components/responses/429'

      parameters: []

    get:

      summary: Query on-boarded application package information.

      description: This GET method queries information relating to on-boarded application packages in the MEO/MEAO matching the filtering criteria. It refers to the procedure of "query operation" of application package as described in clause 6.3.3.2. This GET method also queries information relating to on-boarded application packages in the NFVO matching the filtering criteria by the OSS through MEAO to NFVO.

      operationId: OnboardedapppackagesGET

      tags:

      - app-pkgm

      parameters:

      - $ref: '#/components/parameters/Query.Filter'

      - $ref: '#/components/parameters/Query.All_fields'

      - $ref: '#/components/parameters/Query.Fields'

      - $ref: '#/components/parameters/Query.Exclude_fields'

      - $ref: '#/components/parameters/Query.Exclude_default'

      responses:

        '200':

          description: Indicate the success of request. The response message content shall contain a list of representations of the "individual application package" resources that match the attribute filter.

          content:

            application/json:

              schema:

                type: array

                items:

                  $ref: '#/components/schemas/AppPkgInfo'

        '400':

          $ref: '#/components/responses/400'

        '401':

          $ref: '#/components/responses/401'

        '403':

          $ref: '#/components/responses/403'

        '404':

          $ref: '#/components/responses/404'

        '406':

          $ref: '#/components/responses/406'

        '429':

          $ref: '#/components/responses/429'

  /onboarded_app_packages:

    post:

      summary: Create a new resource for onboarded application package.

          $ref: '#/components/responses/406'

        '429':

          $ref: '#/components/responses/429'

  /app_packages/{appPkgId}:

    post:

      summary: Delivers a notification from the application lifecycle management resource to the subscriber.

      description: The POST method delivers a notification from the application package management resource in MEO or MEAO to the subscriber.

      operationId: UserdefinednotificationPOST

      tags:

      - notification

      requestBody:

        description: A notification of an application package for on-boarding or operational state change.

        required: true

        content:

          application/json:

            schema:

              type: object

              properties:

                AppPkgNotification:

                  $ref: '#/components/schemas/AppPkgNotification'

      responses:

        '204':

          description: 'The notification was delivered successfully.

            The response message content shall be empty.'

          content:

            application/json:

              schema:

                type: object

                properties: {}

        '401':

          $ref: '#/components/responses/401'

        '403':

          $ref: '#/components/responses/403'

        '404':

          $ref: '#/components/responses/404'

        '429':

          $ref: '#/components/responses/429'

      parameters:

      - name: appPkgId

        in: path

        required: true

        description: The unique identifier of the appPkgId.

        schema:

          type: string

  /onboarded_app_packages/{appDId}:

    get:

      summary: Read information of an individual on-boarded application package.

            post:

              summary: Callback POST used to send a notification

              description: Subscription notification

              operationId: notificationPOST290025

              operationId: notificationPOST856573

              requestBody:

                description: Subscription notification

                required: true

        '429':

          $ref: '#/components/responses/429'

      parameters: []

  /app_packages/{appPkgId}/appd:

    get:

      summary: Read application descriptor of an onboarded application package.

      description: This GET method reads the content of the AppD of on-boarded individual application package resources. The format of the AppD is left for future specification.

      operationId: OnboardedapppackagesAppdGETAppdid

      tags:

      - app-pkgm

      parameters:

      - $ref: '#/components/parameters/Query.Filter1'

      - $ref: '#/components/parameters/Query.All_fields1'

      - $ref: '#/components/parameters/Query.Fields1'

      - $ref: '#/components/parameters/Query.Exclude_fields1'

      - $ref: '#/components/parameters/Query.Exclude_default1'

      - name: appPkgId

        in: path

        required: true

        description: The unique identifier of the appPkgId.

        schema:

          type: string

      responses:

        '200':

          description: 'Indicates the success of request, and the content of the AppD is returned.

            The response message content shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.

            The "Content-Type" HTTP header shall be set according to the format of the returned file, which is selected according to "Accept" HTTP header options passed in the request.'

          content:

            application/json:

              schema:

                type: object

                properties:

                  AppD:

                    $ref: '#/components/schemas/AppD'

        '400':

          $ref: '#/components/responses/400'

        '401':

          $ref: '#/components/responses/401'

        '403':

          $ref: '#/components/responses/403'

        '404':

          $ref: '#/components/responses/404'

        '406':

          $ref: '#/components/responses/406'

        '429':

          $ref: '#/components/responses/429'

  /onboarded_app_packages/{appDId}/appd:

    get:

      summary: Read application descriptor of an onboarded application package.

          $ref: '#/components/responses/406'

        '429':

          $ref: '#/components/responses/429'

  /app_packages/{appPkgId}/package_content:

    get:

      summary: Fetch an on-boarded application package.

      description: The GET method is used to fetch the onboarded application package content identified by appPkgId or appDId. The client can use this resource to fetch the content of the application package.

      operationId: OnboardedapppackagesPackagecontentGETAppdid

      tags:

      - app-pkgm

      responses:

        '200':

          description: "On success, a copy of the on-boarded application package is returned in the response message content. \n\nThe \"Content-Type\" HTTP header shall be set according to the type of the file, i.e. to \"application/zip\" for an application package."

          content:

            application/json:

              schema:

                type: object

                properties: {}

        '400':

          $ref: '#/components/responses/400'

        '401':

          $ref: '#/components/responses/401'

        '403':

          $ref: '#/components/responses/403'

        '404':

          $ref: '#/components/responses/404'

        '406':

          $ref: '#/components/responses/406'

        '416':

          $ref: '#/components/responses/416'

        '429':

          $ref: '#/components/responses/429'

      parameters:

      - name: appPkgId

        in: path

        required: true

        description: The unique identifier of the appPkgId.

        schema:

          type: string

    put:

      summary: Upload an application package by providing the content of application package.

      description: This PUT method uploads the content of application package.

      operationId: OnboardedapppackagesPackagecontentPUTAppdid

      tags:

      - app-pkgm

      requestBody:

        description: 'The message content shall contain a ZIP file that represents the application package.

          The "Content-Type" HTTP header shall be set to "application/zip".'

        content:

          application/json: {}

        required: false

      responses:

        '202':

          description: 'The application package has been accepted for uploading, but the processing has not been completed. It is expected to take some time for processing.

            The response message content shall be empty.'

          content:

            application/json:

              schema:

                type: object

                properties: {}

        '400':

          $ref: '#/components/responses/400'

        '401':

          $ref: '#/components/responses/401'

        '403':

          $ref: '#/components/responses/403'

        '404':

          $ref: '#/components/responses/404'

        '406':

          $ref: '#/components/responses/406'

        '429':

          $ref: '#/components/responses/429'

      parameters:

      - name: appPkgId

        in: path

        required: true

        description: The unique identifier of the appPkgId.

        schema:

          type: string

  /onboarded_app_packages/{appDId}/package_content:

    get:

      summary: Fetch an on-boarded application package.

        The API producer shall support receiving filtering parameters as part of the URI query string.

        All attribute names that appear in the AppD and in data types referenced from it shall be supported in attribute-based filtering parameters. See clause 6.19 in ETSI GS MEC 009 [4] for detail.'

      name: filter

      name: filter1

      in: query

      required: false

      x-exportParamName: Query.Filter1

        type: string

    Query.All_fields1:

      description: "Include all complex attributes in the response. See clause 6.18 in ETSI GS\_MEC 009 [4] for details. The API producer shall support this parameter."

      name: all_fields

      name: all_fields1

      in: query

      required: false

      x-exportParamName: Query.All_fields1

      description: 'Complex attributes of AppD to be included into the response.

        See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer should support this parameter.'

      name: fields

      name: fields1

      in: query

      required: false

      x-exportParamName: Query.Fields1

      description: 'Complex attributes of AppD to be excluded from the response.

        See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer should support this parameter.'

      name: exclude_fields

      name: exclude_fields1

      in: query

      required: false

      x-exportParamName: Query.Exclude_fields1

        terminateAppInstanceOpConfig;

        changeAppInstanceStateOpConfig.'

      name: exclude_default

      name: exclude_default1

      in: query

      required: false

      x-exportParamName: Query.Exclude_default1