openapi: 3.2.0
info:
  title: 3gpp-slice-pp Slice Parameters Provisionings (Collection) API
  version: 1.0.0
  description: "API for Network Slice Parameters Provisioning.\n© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-slice-pp/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Slice Parameters Provisionings (Collection)
paths:
  /pp:
    get:
      summary: Request to retrieve all the active Slice Parameters Provisionings at the NEF.
      operationId: GetSliceParamProvisionings
      tags:
      - Slice Parameters Provisionings (Collection)
      responses:
        '200':
          description: 'OK. All the active Slice Parameters Provisioning resources managed by the  NEF are returned.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SlicePpData'
                minItems: 0
        '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
        '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: Request the creation of a new Slice Parameters Provisioning.
      tags:
      - Slice Parameters Provisionings (Collection)
      operationId: CreateSliceParamProvisioning
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SlicePpData'
      responses:
        '201':
          description: 'Created. Successful creation of a new Individual Slice Parameters Provisioning resource.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlicePpData'
          headers:
            Location:
              description: 'Contains the URI of the newly created resource, according to the structure {apiRoot}/3gpp-slice-pp/v1/pp/{ppId}

                '
              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
components:
  schemas:
    SlicePpData:
      description: Represents the Slice Parameters Provisioning data.
      type: object
      properties:
        afId:
          type: string
        mtcProviderId:
          $ref: TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation
        sliceUsgCtrlData:
          type: object
          additionalProperties:
            $ref: TS29571_CommonData.yaml#/components/schemas/SliceUsageControlInfo
          minProperties: 1
          description: 'Contains the Network Slice Usage Control information to be provisioned. The key of the map shall be the AF dedicated S-NSSAI (that is provided within the snssai attribute of the corresponding map value encoded via the SliceUsageControlInfo data structure) to which the Network Slice Usage Control information is related.

            '
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - afId
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V18.6.0; 5G System; Network Exposure Function Northbound APIs.

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