Tech-invite   3GPPspecs   Glossaries   IETFRFCs   Groups   SIP   ABNFs   Ti+   Search in Tech-invite

Top   in Index   Prev   Next

TS 29.501 (CT4)
5GS — Principles and Guidelines
for Services Definition

3GPP‑Page   ETSI‑search   full‑ToC    
use "3GPP‑Page" to get the Word version
use "ETSI‑search" to get the PDF version
for a better overview, the Table of Contents (ToC) is reproduced
V16.0.0 (Wzip)2019/06  69 p.
V15.4.0 (PDF)2019/06  72 p.


Rapporteur:  Mr. Wiehe, Ulrich

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 [4] 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.0.0

 

Here   Top

 

 

1  Scope [R15]Word-p. 7
2  References [R15]
3  Definitions and abbreviations [R15]Word-p. 8
4  Design Principles for 5GC SBI APIs [R15]
4.1  General Principles
4.2  API Design Style and REST Implementation LevelsWord-p. 9
4.3  Version ControlWord-p. 10
4.4  URI StructureUp
4.5  Resource Representation and Content Format Negotiation
4.6  Use of HTTP MethodsWord-p. 16
4.7  HATEOAS
4.8  Error ResponsesWord-p. 31
4.9  Transferring multiple resources to a NF Service ConsumerWord-p. 32
5  Documenting 5GC SBI APIs [R15]
5.1  Naming Conventions
5.2  API Definition
5.3  OpenAPI specification files
6  Requirements for secure API design [R15]
A  TS Skeleton Template [R15]Word-p. 61
B  Backward Incompatible Changes [R15]
C  Resource modelling [R15]Word-p. 62
D  Example of an OpenAPI specification file for Patch [R15]
E  Change historyWord-p. 67

Up   Top