Upload New File for TS29175_Nimsas_ImsParameterProvision Service

openapi: 3.0.0

info:

  title: 'IMS AS ParameterProvision Service'

  version: 1.0.0-alpha.1

  description: |

    Nimsas_ImsParameterProvision Service.

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

    All rights reserved.

externalDocs:

  description: >

    3GPP TS 29.175 V19.2.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application

    Server (AS) Services; Stage 3

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

servers:

  - url: '{apiRoot}/nimsas-ipp/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501

security:

  - {}

  - oAuth2ClientCredentials:

      - nimsas-ipp

paths:

  //{imsUeId}/ims-pp-data-store/{afInstanceId}:

    put:

	  summary: Update the IMS parameter provisioning data for a specific IMS user.

      operationId: UpdateImsParameterProvisioningDataEntry

      tags:

        - Update IMS ParameterProvisioning Data Entry

      security:

        - {}

        - oAuth2ClientCredentials:

          - nimsas-ipp

      parameters:

        - name: imsUeId

          in: path

          description: IMS Identity

          required: true

          schema:

            $ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'

        - name: afInstanceId

          in: path

          description: AF instance Identity

          required: true

          schema:

            type: string

      requestBody:

        content:

          application/json:

            schema:

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

        required: true

      responses:

        '200':

          description: >

            Successful creation of the IMS ParameterProvisioning Data Entry per AF.

          content:

            application/json:

              schema:

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

        '204':

          description: No content

        '307':

          description: Temporary Redirect

          content:

            application/json:

              schema:

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

          headers:

            Location:

              description: The URI pointing to the resource located on the redirect target IMS AS.

              schema:

                type: string

        '308':

          description: Permanent Redirect

          content:

            application/json:

              schema:

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

          headers:

            Location:

              description: The URI pointing to the resource located on the redirect target IMS AS.

              schema:

                type: string

        '400':

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

        '401':

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

        '403':

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

        '404':

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

        '409':

          $ref: 'TS29571_CommonData.yaml#/components/responses/409'

        '411':

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

        '413':

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

        '415':

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

        '429':

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

        '500':

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

        '502':

          $ref: 'TS29571_CommonData.yaml#/components/responses/502'

        '503':

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

        default:

          description: Unexpected error

    delete:

      summary: delete the IMS parameter provisioning data for a specific IMS user.

      operationId: DeleteImsParameterProvisioningDataEntry

      tags:

        - Delete IMS parameter provisioning data entry

      security:

        - {}

        - oAuth2ClientCredentials:

          - nimsas-ipp

      parameters:

        - name: imsUeId

          in: path

          description: Individual IMS parameter provisioning data entry

          required: true

          schema:

            $ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'

        - name: afInstanceId

          in: path

          description: AF instance Identity

          required: true

          schema:

            type: string

      responses:

        '204':

          description: No content

        '307':

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

        '308':

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

        '400':

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

        '401':

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

        '403':

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

        '404':

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

        '429':

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

        '500':

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

        '502':

          $ref: 'TS29571_CommonData.yaml#/components/responses/502'

        '503':

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

        default:

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

components:

  securitySchemes:

    oAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{nrfApiRoot}/oauth2/token'

          scopes:

            nimsas-ipp: Access to the Nimsas_ImsParameterProvision API

  schemas:

# STRUCTURED DATA TYPES

    ImsPpDataEntry:

      description: The IMS parameter provision data entry per AF.

      type: object

      required:

      properties:

        rcdPropData:

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

# ENUMS