CT#103

openapi: 3.0.0

info:

  title: SS_NetworkSliceAdaptation

  description: |

    API for SEAL Network Slice Adaptation.  

    © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  

    All rights reserved.

  version: "1.1.0-alpha.1"

externalDocs:

  description: >

    3GPP TS 29.549 V18.0.0 Service Enabler Architecture Layer for Verticals (SEAL);

    Application Programming Interface (API) specification; Stage 3.

  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/

security:

  - {}

  - oAuth2ClientCredentials: []

servers:

  - url: '{apiRoot}/ss-nsa/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549

paths:

  /request:

    post:

      summary: request the network slice adaptation.

      operationId: RequestNetworkSliceAdaptation

      tags:

        - Network Slice Adaptation Request

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '204':

          description: No Content. The requested network slice adaptation is successfully processed.

        '307':

          $ref: 'TS29122_CommonData.yaml#/components/responses/307'

        '308':

          $ref: 'TS29122_CommonData.yaml#/components/responses/308'

        '400':

          $ref: 'TS29122_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29122_CommonData.yaml#/components/responses/401'

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

          $ref: 'TS29122_CommonData.yaml#/components/responses/404'

        '411':

          $ref: 'TS29122_CommonData.yaml#/components/responses/411'

        '413':

          $ref: 'TS29122_CommonData.yaml#/components/responses/413'

        '415':

          $ref: 'TS29122_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:

  securitySchemes:

    oAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}

  schemas:

    NwSliceAdptInfo:

      description: >

        Represents the information associated with requested network slice adaptation

        with the underlying network.

      type: object

      properties:

        valServiceId:

          type: string

        valTgtUeIds:

          type: array

          items:

            type: string

        snssai:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

        dnn:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

        suppFeat:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

      required:

        - valServiceId

        - valTgtUeIds