OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
API for discovering service APIs.
OpenAPI Version: 3.0.0
Title: CAPIF_Discover_Service_API
Description: This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information.
Version: "1.0.0"
Description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs
URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
URL: '{apiRoot}/service-apis/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222.
get:
Description: Discover published service APIs and retrieve a collection of APIs according to certain filter criteria.
Parameters:
- name: api-invoker-id
In: query
Description: String identifying the API invoker assigned by the CAPIF core function.
Required/Optional: true
Schema:
Type: string
- name: api-name
In: query
Description: API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501 [18].
Schema:
Type: string
- name: api-version
In: query
Description: API major version the URI (e.g. v1).
Schema:
Type: string
- name: comm-type
In: query
Description: Communication type used by the API (e.g. REQUEST_RESPONSE).
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/CommunicationType'
- name: protocol
In: query
Description: Protocol used by the API.
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol'
- name: aef-id
In: query
Description: AEF identifer.
Schema:
Type: string
- name: data-format
In: query
Description: Data formats used by the API (e.g. serialization protocol JSON used).
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/DataFormat'
- name: supported-features
In: query
Description: To filter irrelevant responses related to unsupported features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200' The response body contains the result of the search over the list of registered APIs.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/DiscoveredAPIs'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'
'414': Reference 'TS29122_CommonData.yaml#/components/responses/414'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
Type: object
Properties:
serviceAPIDescriptions:
Type: array
Items:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceAPIDescription'
minItems: 1
Description: Description of the service API as published by the service. Each service API description shall include AEF profiles matching the filter criteria.