Upload New File

openapi: 3.0.0

info:

  title: 3gpp-network-parameter-configuration

  version: "1.0.0"

externalDocs:

  description: 3GPP TS 29.122 V15.3.0 T8 reference point for Northbound APIs

  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security:

  - {}

  - oAuth2ClientCredentials: []

servers:

  - url: '{apiRoot}/3gpp-network-parameter-configuration/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in subclause of 3GPP TS 29.122.

paths:

  /{scsAsId}/configurations:

    get:

      summary: read all of the active configurations for the SCS/AS

      tags:

        - NpConfiguration API SCS/AS level GET Operation

      parameters:

        - name: scsAsId

          in: path

          description: Identifier of the SCS/AS

          required: true

          schema:

            type: string

      responses:

        '200':

          description: OK (Successful get all of the active NpConfigurations for the SCS/AS)

          content:

            application/json:

              schema:

                type: array

                items:

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

                minItems: 0

                description: Network Parameter configurations

        '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'

        '406':

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

        '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'

    post:

      summary: Creates a new configuration resource for network parameter configuration

      tags:

        - NpConfiguration API Configuration level POST Operation

      parameters:

        - name: scsAsId

          in: path

          description: Identifier of the SCS/AS

          required: true

          schema:

            type: string

      requestBody:

        description: new configuration creation

        required: true

        content:

          application/json:

            schema:

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

      callbacks:

        notificationDestination:

          '{request.body#/notificationDestination}':

            post:

              requestBody:  # contents of the callback message

                required: true

                content:

                  application/json:

                    schema:

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

              responses:

                '204':

                  description: No Content (successful notification)

                '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'

      responses:

        '201':

          description: Created (Successful creation of configuration)

          content:

            application/json:

              schema:

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

          headers:

            Location:

              description: 'Contains the URI of the newly created resource'

              required: true

              schema:

                type: string

        '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'

  /{scsAsId}/configurations/{configurationId}:

    get:

      summary: read an active configuration for the SCS/AS and the configuration Id

      tags:

        - NpConfiguration API Configuration level GET Operation

      parameters:

        - name: scsAsId

          in: path

          description: Identifier of the SCS/AS

          required: true

          schema:

            type: string

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      responses:

        '200':

          description: OK (Successful get the active configuration)

          content:

            application/json:

              schema:

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

        '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'

        '406':

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

        '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'

    put:

      summary: Updates/replaces an existing configuration resource

      tags:

        - NpConfiguration API Configuration level PUT Operation

      parameters:

        - name: scsAsId

          in: path

          description: Identifier of the SCS/AS

          required: true

          schema:

            type: string

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      requestBody:

        description: Parameters to update/replace the existing configuration

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (Successful deletion of the existing configuration)

          content:

            application/json:

              schema:

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

        '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'

    patch:

      summary: Updates/replaces an existing configuration resource

      tags:

        - NpConfiguration API Configuration level PATCH Operation

      parameters:

        - name: scsAsId

          in: path

          description: Identifier of the SCS/AS

          required: true

          schema:

            type: string

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      requestBody:

        required: true

        content:

          application/merge-patch+json:

            schema:

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

      responses:

        '200':

          description: OK. The configuration was modified successfully.

          content:

            application/json:

              schema:

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

        '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'

    delete:

      summary: Deletes an already existing configuration

      tags:

        - NpConfiguration API Configuration level DELETE Operation

      parameters:

        - name: scsAsId

          in: path

          description: Identifier of the SCS/AS

          required: true

          schema:

            type: string

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      responses:

        '204':

          description: No Content (Successful deletion of the existing configuration)

        '200':

          description: OK. (Successful deletion of the existing configuration)

          content:

            application/json:

              schema:

                type: array

                items:

                  $ref: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult'

                minItems: 1

                description: The configuration was terminated successfully, the configuration failure information for group members shall be included if received.

        '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'

        '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: 

    NpConfiguration:

      type: object

      properties:

        self:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        supportedFeatures:

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

        externalId:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'

        msisdn:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn'

        externalGroupId:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'

        maximumLatency:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

        maximumResponseTime:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

        suggestedNumberOfDlPackets:

          type: integer

          minimum: 0

          description: This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable.

        groupReportingGuardTime:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

        notificationDestination:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        requestTestNotification:

          type: boolean

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

        websockNotifConfig:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

      oneOf:

        - required: [externalId]

        - required: [msisdn]

        - required: [externalGroupId]

    NpConfigurationPatch:

      type: object

      properties:

        maximumLatency:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'

        maximumResponseTime:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'

        suggestedNumberOfDlPackets:

          type: integer

          minimum: 0

          description: This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable.

          nullable: true

        groupReportGuardTime:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'

    ConfigurationNotification:

      type: object

      properties:

        configuration:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        configResults:

          type: array

          items:

            $ref: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult'

          minItems: 1

          description: The grouping configuration result notification provided by the SCEF.

      required:

        - configuration