2019/12 73 p.
The present document defines design principles and documentation guidelines for 5GC Service Based Interface (SBI) APIs. These principles and guidelines should be followed when drafting the 5GS SBI Stage 3 specifications.
Each 5GC SBI API specification should include the following information for each specified service:
Purpose of the API;
URIs of resources;
Supported HTTP methods for a given resource;
Supported representations (e.g. JSON);
Request body schema(s) (where applicable);
Response body schema(s) (where applicable);
Supported response status codes;
Relation types supported if HATEOAS (Hypermedia as the Engine of Application State) is implemented by the API;
A reference in the resource description subclause to one of the archetypes defined in Annex C if the resource design matches one of them; and
A list defining identifiers of optional features (see subclause 6.6 of 3GPP TS 29.500 for related procedures).
For each specified service a subclause to a normative Annex should be provided containing the OpenAPI definitions
according to OpenAPI Specification  for the service. The specifications should state that content of this normative
annex takes precedence when being discrepant to other parts of the specification.
full Table of Contents for TS 29.501 Word version: 16.2.0