Upload New File for CAPIF_Open_Discover_Service_API Open API specification...

openapi: 3.0.0

info:

  title: CAPIF_Open_Discover_Service_API

  version: 1.0.0-alpha.1

  description: |

    API for Routing information.  

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

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.222 V19.4.0 Common API Framework for 3GPP Northbound APIs

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

servers:

  - url: '{apiRoot}/open-api-disc/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222.

paths:

  /service-apis:

    get:

      description: >

        Enables Open discovery of the currently registered at the CCF and satisfying 

        a number of filter criteria.

      parameters:

        - name: api-names

          in: query

          description: >

            Contains the name(s) of the target Service API(s).

          style: form

          explode: false

          schema:

            type: array

            items:

              type: string

            minItems: 1

        - name: api-versions

          in: query

          description: >

            Contains the major version(s) (e.g., v1) of the target Service API(s).

          schema:

            type: object

            additionalProperties:

              type: array

              items:

                type: string

              minItems: 1

            minProperties: 1

        - name: comm-type

          in: query

          description: >

            Contains the communication type supported by the target Service API(s).

          schema:

            $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/CommunicationType' 

        - name: protocols 

          in: query 

          description: >

            Contains the protocol(s) supported by the target Service API(s). 

          style: form

          explode: false

          schema:

            type: array

            items:

              $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol'

            minItems: 1

        - name: data-format

          in: query 

          description: >

            Contains data format(s) supported by the target Service API(s). 

          schema: 

            $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/DataFormat'

        - name: api-cats

          in: query

          description: >

            Contains the category(ies) of the target Service API(s).

          style: form

          explode: false

          schema:

            type: array

            items:

              type: string

            minItems: 1

        - name: preferred-aef-loc 

          in: query 

          description: >

            Contains the preferred location information for AEF(s) exposing the target 

            Service API(s).

            This query parameter is ignored by the CCF if there are no matching records at the CCF.

          content: 

            application/json: 

              schema: 

                $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/AefLocation'

        - name: api-prov-names

          in: query

          description: >

            Contains the name(s) of the provider(s) of the target Service API(s).

          style: form

          explode: false

          schema:

            type: array

            items:

              type: string

            minItems: 1

        - name: api-supported-features

          in: query

          description: >

            Contains the features supported by the discovered service API indicated by 

            api-name parameter. This may only be present if api-name query parameter is

            present.

          schema:

            type: object

            additionalProperties:

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

            minProperties: 1

        - name: api-ids

          in: query

          description: >

            Contains the identifier(s) of the targeted service APIs.

          required: false

          style: form

          explode: false

          schema:

            type: array

            items:

              type: string

            minItems: 1

        - name: service-kpis 

          in: query 

          description: > 

            Contains iInformation about service characteristics provided by the targeted 

            service API(s). 

          schema: 

            $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceKpis'

        - name: res-ops

          in: query

          description: >

            Contains the list of supported API resource(s) and service operation(s).

          style: form

          explode: false

          schema:

            type: array

            items:

              $ref: 'TS29222_CAPIF_Discover_Service_API.yaml#/components/schemas/ResOperInfo'

            minItems: 1

        - name: supported-features

          in: query

          description: >

            Contains a list of supported features among the ones defined in clause 8.1.6. This 

            attributed shall be present only when feature negotiation needs to take place.

          schema:

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

      responses:

        '200':

          description: >

            The response body contains the result of the search over the list of the registered

            APIs.

          content:

            application/json:

              schema:

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

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

        '414':

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

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

    OpenDiscoveryResp:

      type: object

      description: >

        Represents the Open Service API Discovery response..

      properties:

        discApis:

          type: array

          items:

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

          minItems: 0

        suppFeat:

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

      required:

        - discApis

    OpenAPIDetails:

      type: object

      description: >

        Represents the Service API details provided within an Open Service API Discovery

        response.

      properties:

        apiName:

          type: string

        apiId:

          type: string

        apiStatus:

          $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ApiStatus'

        description:

          type: string

        serviceAPICategory:

          type: string

        apiSuppFeats:

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

        apiProvName:

          type: string

        aefProfiles:

          type: array

          items:

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

          minItems: 1

      required:

        - apiName

    OpenAefProfile:

      type: object

      description: Represents the AEF Profile details provided within an Open Service API Discovery response.

      properties:

        aefId:

          type: string

        versions:

          type: array

          items:

            $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Version'

          minItems: 1

        protocol:

          $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol'

        dataFormat:

          $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/DataFormat'

        aefLocation:

          $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/AefLocation'

        serviceKpis:

          $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceKpis'