apfId and service-apis
Method: Post
Description: Publish a new API.
Parameters:
- name: apfId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/apfId'
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceAPIDescription'
Responses:
'201' Service API published successfully The URI of the created resource shall be returned in the "Location" HTTP header.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceAPIDescription'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}'
Required/Optional: true
Schema:
Type: string
'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'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'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'
get:
Description: Retrieve all published APIs.
Parameters:
- name: apfId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/apfId'
Responses:
'200' Definition of all service API(s) published by the API publishing function.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceAPIDescription'
'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'
'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'
# Individual APF published API