|
GROUP SPECIFICATION
Multi-access Edge Computing (MEC);
General principles for MEC Service APIs
Disclaimer
The present document has been produced and approved by the Multi-access Edge Computing (MEC) ETSI Industry
Specification Group (ISG) and represents the views of those members who participated in this ISG.
It does not necessarily represent the views of the entire ETSI membership.
---------------------- Page: 1 ----------------------
2 ETSI GS MEC 009 V2.1.1 (2019-01)
Reference
RGS/MEC-0009v211ApiPrinciples
Keywords
API, MEC
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 prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
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 2019.
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 a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI GS MEC 009 V2.1.1 (2019-01)
Contents
Intellectual Property Rights . 6
Foreword . 6
Modal verbs terminology . 6
1 Scope . 7
2 References . 7
2.1 Normative references . 7
2.2 Informative references . 8
3 Definition of terms, symbols and abbreviations . 9
3.1 Terms . 9
3.2 Symbols . 9
3.3 Abbreviations . 10
4 Design principles for developing RESTful MEC service APIs . 10
4.1 REST implementation levels . 10
4.2 General principles. 10
4.3 Entry point of a RESTful MEC service API . 11
4.4 API security and privacy considerations . 11
5 Documenting RESTful MEC service APIs . 11
5.1 RESTful MEC service API template . 11
5.2 Conventions for names . 12
5.2.1 Case conventions . 12
5.2.2 Conventions for URI parts . 12
5.2.2.1 Introduction . 12
5.2.2.2 Path segment naming conventions . 13
5.2.2.3 Query naming conventions . 13
5.2.3 Conventions for names in data structures . 13
5.3 Provision of an OpenAPI definition . 14
6 Patterns of RESTful MEC service APIs . 14
6.1 Introduction . 14
6.2 void . 14
6.3 Pattern: Resource identification . 14
6.3.1 Description . 14
6.3.2 Resource definition(s) and HTTP methods . 14
6.4 Pattern: Resource representations and content format negotiation . 15
6.4.1 Description . 15
6.4.2 Resource definition(s) and HTTP methods . 15
6.4.3 Resource representation(s) . 15
6.4.4 HTTP headers . 15
6.4.5 Response codes and error handling . 16
6.5 Pattern: Creating a resource (POST) . 16
6.5.1 Description . 16
6.5.2 Resource definition(s) and HTTP methods . 16
6.5.3 Resource representation(s) . 17
6.5.4 HTTP headers . 17
6.5.5 Response codes and error handling . 17
6.5a Pattern: Creating a resource (PUT) . 17
6.5a.1 Description . 17
6.5a.2 Resource definition(s) and HTTP methods . 18
6.5a.3 Resource representation(s) . 18
6.5a.4 HTTP headers . 18
6.5a.5 Response codes and error handling . 18
6.6 Pattern: Reading a resource . 18
6.6.1 Description . 18
6.6.2 Resource definition(s) and HTTP methods . 19
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS MEC 009 V2.1.1 (2019-01)
6.6.3 Resource representation(s) . 19
6.6.4 HTTP headers . 19
6.6.5 Response codes and error handling . 19
6.7 Pattern: Queries on a resource . 19
6.7.1 Description . 19
6.7.2 Resource definition(s) and HTTP methods . 20
6.7.3 Resource representation(s) . 20
6.7.4 HTTP headers . 20
6.7.5 Response codes and error handling . 20
6.8 Pattern: Updating a resource (PUT) . 20
6.8.1 Description . 20
6.8.2 Resource definition(s) and HTTP methods . 21
6.8.3 Resource representation(s) . 21
6.8.4 HTTP headers . 21
6.8.5 Response codes and error handling . 22
6.9 Pattern: Updating a resource (PATCH) . 22
6.9.1 Description . 22
6.9.2 Resource definition(s) and HTTP methods . 23
6.9.3 Resource representation(s) . 23
6.9.4 HTTP headers . 24
6.9.5 Response codes and error handling . 24
6.10 Pattern: Deleting a resource. 24
6.10.1 Description . 24
6.10.2 Resource definition(s) and HTTP methods . 25
6.10.3 Resource representation(s) . 25
6.10.4 HTTP headers . 25
6.10.5 Response codes and error handling . 25
6.11 Pattern: Task resources . 26
6.11.1 Description . 26
6.11.2 Resource definition(s) and HTTP methods . 26
6.11.3 Resource representation(s) . 26
6.11.4 HTTP headers . 26
6.11.5 Response codes and error handling . 26
6.12 Pattern: REST-based subscribe/notify . 27
6.12.1 Description . 27
6.12.2 Resource definition(s) and HTTP methods . 28
6.12.3 Resource representation(s) . 29
6.12.4 HTTP headers . 29
6.12.5 Response codes and error handling . 29
6.13 Pattern: Asynchronous operations . 29
6.13.1 Description . 29
6.13.2 Resource definition(s) and HTTP methods . 31
6.13.3 Resource representation(s) . 31
6.13.4 HTTP headers . 32
6.13.5 Response codes and error handling . 32
6.14 Pattern: Links (HATEOAS) . 32
6.14.1 Description . 32
6.14.2 Resource definition(s) and HTTP methods . 32
6.14.3 Resource representation(s) . 32
6.14.4 HTTP headers . 34
6.14.5 Response codes and error handling . 34
6.15 Pattern: Error responses . 34
6.15.1 Description . 34
6.15.2 Resource definition(s) and HTTP methods . 34
6.15.3 Resource representation(s) . 34
6.15.4 HTTP headers . 35
6.15.5 Response codes and error handling . 35
6.16 Pattern: Authorization of access to a RESTful MEC service API using OAuth 2.0 . 35
6.16.1 Description . 35
6.16.2 Resource definition(s) and HTTP methods . 38
6.16.3 Resource representation(s) . 39
6.16.4 HTTP headers . 39
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS MEC 009 V2.1.1 (2019-01)
6.16.5 Response codes and error handling . 39
6.16.6 Discovery of the parameters needed for exchanges with the token endpoint . 39
6.16.7 Scope values . 39
6.17 Pattern: Representation of lists in JSON . 39
6.17.1 Description . 39
6.17.2 Representation as arrays . 39
6.17.3 Representation as maps . 40
6.18 Pattern: Attribute selectors . 40
6.18.1 Description . 40
6.18.2 Resource definition(s) and HTTP methods . 40
6.18.3 Resource representation(s) . 41
6.18.4 HTTP headers . 42
6.18.5 Response codes and error handling . 42
6.19 Pattern: Attribute-based filtering . 42
6.19.1 Description . 42
6.19.2 Resource definition(s) and HTTP methods . 43
6.19.3 Resource representation(s) . 44
6.19.4 HTTP headers . 44
6.19.5 Response codes and error handling . 45
7 Alternative transport mechanisms . 45
7.1 Description . 45
7.2 Relationship of topics, subscriptions and access rights . 46
7.3 Serializers . 47
7.4 Authorization of access to a service over alternative transports using TLS credentials . 48
Annex A (informative): REST methods. 51
Annex B (normative): HTTP response status codes . 52
Annex C (informative): Richardson maturity model of REST APIs . 54
Annex D (informative): RESTful MEC service API template. 55
History . 64
ETSI
---------------------- Page: 5 ----------------------
6 ETSI GS MEC 009 V2.1.1 (2019-01)
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 Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Multi-access Edge
Computing (MEC).
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: 6 ----------------------
7 ETSI GS MEC 009 V2.1.1 (2019-01)
1 Scope
The present document defines design principles for RESTful MEC service APIs, provides guidelines and templates for
the documentation of these, and defines patterns of how MEC service APIs use RESTful principles.
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content".
NOTE: Available at https://tools.ietf.org/html/rfc7231.
[2] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests".
NOTE: Available at https://tools.ietf.org/html/rfc7232.
[3] IETF RFC 5789: "PATCH Method for HTTP".
NOTE: Available at https://tools.ietf.org/html/rfc5789.
[4] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer".
NOTE: Available at https://tools.ietf.org/html/rfc6901.
[5] IETF RFC 7396: "JSON Merge Patch".
NOTE: Available at https://tools.ietf.org/html/rfc7396.
[6] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch".
NOTE: Available at https://tools.ietf.org/html/rfc6902.
[7] IETF RFC 5261: "An Extensible Markup Language (XML) Patch Operations Framework Utilizing
XML Path Language (XPath) Selectors".
NOTE: Available at https://tools.ietf.org/html/rfc5261.
[8] IETF RFC 6585: "Additional HTTP Status Codes".
NOTE: Available at https://tools.ietf.org/html/rfc6585.
[9] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
NOTE: Available at https://tools.ietf.org/html/rfc63986.
[10] IETF RFC 8259: "The JavaScript Object Notation (
...