|
TECHNICAL SPECIFICATION
5G;
5G System;
Principles and Guidelines for Services Definition;
Stage 3
(3GPP TS 29.501 version 15.1.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 1 ETSI TS 129 501 V15.1.0 (2018-10)
Reference
RTS/TSGC-0429501vf10
Keywords
5G
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2018.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 2 ETSI TS 129 501 V15.1.0 (2018-10)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or
GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables.
The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under
.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 3 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 3 ETSI TS 129 501 V15.1.0 (2018-10)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
Foreword . 6
1 Scope . 7
2 References . 7
3 Definitions and abbreviations . 8
3.1 Definitions . 8
3.2 Abbreviations . 8
4 Design Principles for 5GC SBI APIs . 8
4.1 General Principles . 8
4.2 API Design Style and REST Implementation Levels . 9
4.2.1 General . 9
4.2.2 API Design Principles for Query Operation . 9
4.2.3 API Design Principles for Delete Operation . 9
4.3 Version Control . 10
4.3.1 Structure of API version numbers . 10
4.3.1.1 API version number format . 10
4.3.1.2 Rules for incrementing field values. 10
4.3.1.3 Visibility of the API version number fields . 10
4.3.1.4 Relation to the Technical Specification version number . 11
4.3.1.5 Discovery of the supported versions . 11
4.4 URI Structure . 11
4.4.1 Resource URI structure . 11
4.4.2 Custom operations URI structure . 12
4.4.3 Callback URI structure . 12
4.5 Resource Representation and Content Format Negotiation . 12
4.5.1 Resource Representation . 12
4.5.2 Content Format Negotiation . 12
4.6 Use of HTTP Methods . 12
4.6.1 Use of Request/Response Communication . 13
4.6.1.1 CRUD . 13
4.6.1.1.1 Creating a Resource . 13
4.6.1.1.1.1 General . 13
4.6.1.1.1.2 Creating a Resource using POST . 13
4.6.1.1.1.3 Creating a Resource using PUT . 14
4.6.1.1.2 Reading a Resource . 14
4.6.1.1.2.1 Reading a Single Resource . 14
4.6.1.1.2.2 Querying a Set of Resources . 15
4.6.1.1.3 Updating a Resource . 16
4.6.1.1.3.1 Usage of HTTP PUT . 16
4.6.1.1.3.2 Usage of HTTP PATCH . 16
4.6.1.1.4 Deleting a Resource . 17
4.6.1.1.5 Query Parameters . 18
4.6.1.2 Custom Operations . 18
4.6.1.3 Use of Asynchronous Operations . 18
4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer. 18
4.6.2 Use of Subscribe/Notify Communication . 19
4.6.2.1 General . 19
4.6.2.2 Management of Subscriptions . 19
4.6.2.2.1 General . 19
4.6.2.2.2 Creation of a Subscription . 19
4.6.2.2.3 Modify a subscription . 20
4.6.2.2.3.1 Modification of a Subscription Using HTTP PUT. 20
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 4 ETSI TS 129 501 V15.1.0 (2018-10)
4.6.2.2.3.2 Modification of a Subscription Using HTTP PATCH . 20
4.6.2.2.4 Delete a subscription . 21
4.6.2.3 Notifications . 21
4.6.2.4 Special provisions to support the seamless change of AMF as NF service consumer . 22
4.7 HATEOAS . 22
4.7.1 General . 22
4.7.2 3GPP hypermedia format . 22
4.7.3 Advertising legitimate application state transitions . 23
4.7.4 Inferring link relation semantic . 23
4.7.5 Common Relation Types . 24
4.7.5.1 Introduction . 24
4.7.5.2 Registered relation types . 24
4.7.5.3 Extension relation types . 24
4.7.6 Negotiating the support of optional HATEOAS features . 24
4.8 Error Responses . 25
4.9 Transferring multiple resources to a NF Service Consumer . 26
4.9.1 General . 26
4.9.2 Direct Delivery . 26
4.9.3 Direct Delivery with Iterations . 26
4.9.4 Indirect Delivery . 27
4.9.5 Indirect Delivery with HTTP/2 Server Push . 27
4.9.6 Criteria for choosing the transfer method . 29
5 Documenting 5GC SBI APIs . . 29
5.1 Naming Conventions . 29
5.1.1 Case Conventions . 29
5.1.2 API Naming Conventions . 31
5.1.3 Conventions for URI Parts . 31
5.1.3.1 Introduction . 31
5.1.3.2 URI Path Segment Naming Conventions . 31
5.1.3.3 URI Query Naming Conventions . 32
5.1.4 Conventions for Names in Data Structures . 32
5.2 API Definition . 32
5.2.1 Resource Structure . 32
5.2.2 Resources and HTTP Methods . 33
5.2.3 Representing RPC as Custom Operations on Resources . 35
5.2.4 Data Models . 37
5.2.4.1 General . 37
5.2.4.2 Structured data types . 37
5.2.4.3 Simple data types and enumerations . 38
5.2.4.4 Binary Data . 39
5.2.4.5 Data types describing alternative data types or combinations of data types . 39
5.2.5 Relation types . 40
5.3 Open API specification files . 40
5.3.1 General . 40
5.3.2 Formatting of OpenAPI files . 40
5.3.3 Info. 41
5.3.4 externalDocs . 41
5.3.5 Servers . 41
5.3.6 References to other 3GPP-defined Open API specification files . 41
5.3.7 Server-initiated communication . 42
5.3.8 Describing the body of HTTP PATCH requests . 42
5.3.8.1 General . 42
5.3.8.2 JSON Merge Patch . 42
5.3.8.3 JSON PATCH . 43
5.3.9 Structured data types . 43
5.3.10 Data types describing alternative data types or combinations of data types . 45
5.3.11 Error Responses . 46
5.3.12 Enumerations . 47
5.3.13 Formatting of structured data types in query parameters . 48
6 Requirements for secure API design . 48
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 5 ETSI TS 129 501 V15.1.0 (2018-10)
6.1 Introduction . 48
6.2 General . 49
6.3 SBA-specific requirements . 49
Annex A (informative): TS Skeleton Template . 50
Annex B (informative): Backward Incompatible Changes . 51
Annex C (Informative): Resource modelling . 52
C.1 Document . 52
C.2 Collection . 52
C.3 Store . 52
C.4 Custom operation . 53
Annex D (informative): Open API example file for Patch . 54
Annex E (informative): Change history . 56
History . 58
ETSI
---------------------- Page: 6 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 6 ETSI TS 129 501 V15.1.0 (2018-10)
Foreword
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
The contents of the present document are subject to continuing work within the TSG and may change following formal
TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an
identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x the first digit:
1 presented to TSG for information;
2 presented to TSG for approval;
3 or greater indicates TSG approved document under change control.
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 7 ETSI TS 129 501 V15.1.0 (2018-10)
1 Scope
The present document defines design principles and documentation guidelines for 5GC SBI APIs. These principles and
guidelines should be followed when drafting the 5G System SBI Stage 3 specifications.
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present
document.
- References are either specific (identified by date of publication, edition number, version number, etc.) or
non-specific.
- For a specific reference, subsequent revisions do not apply.
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including
a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same
Release as the present document.
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
[3] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
[4] OpenAPI: "OpenAPI 3.0.0 Specification", https://github.com/OAI/OpenAPI-
Specification/blob/master/versions/3.0.0.md.
[5] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3".
[6] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"
[7] IETF RFC 7396: "JSON Merge Patch".
[8] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch".
[9] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax"
[10] IETF RFC 5789: "PATCH Method for HTTP"
[11] IETF RFC 8288: "Web Linking".
[12] IANA: "HTTP Status Code Registry at IANA", http://www.iana.org/assignments/http-status-codes
[13] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)"
[14] Fielding, Roy Thomas. Architectural Styles and the Design of Network-based Software
Architectures. Doctoral dissertation, University of California, Irvine, 2000.
[15] Erik Wilde, Cesare Pautasso, REST: From Research to Practice, Springer
[16] YAML 1.2: "YAML Ain't Markup Language", http://yaml.org.
[17] Semantic Versioning Specification: https://semver.org
[18] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
[19] IETF RFC 7807: "Problem Details for HTTP APIs".
[20] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3".
[21] 3GPP TS 29.509: "Authentication Server Services; Stage 3".
[22] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
ETSI
---------------------- Page: 8 ----------------------
3GPP TS 29.501 version 15.1.0 Release 15 8 ETSI TS 129 501 V15.1.0 (2018-10)
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following
apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP
TR 21.905 [1].
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An
abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in
3GPP TR 21.905 [1].
5GC 5G Core Network
HAL Hypertext Application Language
HATEOAS Hypermedia as the Engine of Application State
SBI Service Based Interface
YAML YAML Ain't Markup Language
4 Design Principles for 5GC SBI APIs
4.1 General Principles
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, see IETF RFC 8259 [3]);
- Request body schema(s) (where applicable);
- Response body schema(s) (where applicable);
- Supported response status codes;
- Relation types supported if HAT
...