Multi-access Edge Computing (MEC); General principles, patterns and common aspects of MEC Service APIs

RGS/MEC-0009v311ApiPrinciples

General Information

Status
Not Published
Current Stage
12 - Completion
Due Date
02-Jul-2021
Completion Date
24-Jun-2021
Ref Project

Buy Standard

Standard
ETSI GS MEC 009 V3.1.1 (2021-06) - Multi-access Edge Computing (MEC); General principles, patterns and common aspects of MEC Service APIs
English language
75 pages
sale 15% off
Preview
sale 15% off
Preview

Standards Content (Sample)

ETSI GS MEC 009 V3.1.1 (2021-06)






GROUP SPECIFICATION
Multi-access Edge Computing (MEC);
General principles, patterns and common aspects
of 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 V3.1.1 (2021-06)

Reference
RGS/MEC-0009v311ApiPrinciples
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 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
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
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.

Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
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 2021.
All rights reserved.

ETSI

---------------------- Page: 2 ----------------------
3 ETSI GS MEC 009 V3.1.1 (2021-06)
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 . 9
3 Definition of terms, symbols and abbreviations . 10
3.1 Terms . 10
3.2 Symbols . 10
3.3 Abbreviations . 10
4 Design principles for developing RESTful MEC service APIs . 11
4.1 REST implementation levels . 11
4.2 General principles. 11
4.3 Entry point of a RESTful MEC service API . 11
4.4 API security and privacy considerations . 12
5 Documenting RESTful MEC service APIs . 12
5.1 RESTful MEC service API template . 12
5.2 Conventions for names . 12
5.2.1 Case conventions . 12
5.2.2 Conventions for URI parts . 13
5.2.2.1 Introduction . 13
5.2.2.2 Path segment naming conventions . 13
5.2.2.3 Query naming conventions . 14
5.2.3 Conventions for names in data structures . 14
5.3 Provision of an OpenAPI definition . 14
5.4 Documentation of the API data model . 15
5.4.1 Overview . 15
5.4.2 Structured data types . 15
5.4.3 Simple data types . 16
5.4.4 Enumerations . 16
5.4.5 Serialization . 17
6 Patterns of RESTful MEC service APIs . 18
6.1 Introduction . 18
6.2 Void . 18
6.3 Pattern: Resource identification . 18
6.3.1 Description . 18
6.3.2 Resource definition(s) and HTTP methods . 18
6.4 Pattern: Resource representations and content format negotiation . 19
6.4.1 Description . 19
6.4.2 Resource definition(s) and HTTP methods . 19
6.4.3 Resource representation(s) . 19
6.4.4 HTTP headers . 19
6.4.5 Response codes and error handling . 19
6.5 Pattern: Creating a resource (POST) . 20
6.5.1 Description . 20
6.5.2 Resource definition(s) and HTTP methods . 20
6.5.3 Resource representation(s) . 20
6.5.4 HTTP headers . 20
6.5.5 Response codes and error handling . 21
6.5a Pattern: Creating a resource (PUT) . 21
6.5a.1 Description . 21
6.5a.2 Resource definition(s) and HTTP methods . 21
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS MEC 009 V3.1.1 (2021-06)
6.5a.3 Resource representation(s) . 22
6.5a.4 HTTP headers . 22
6.5a.5 Response codes and error handling . 22
6.6 Pattern: Reading a resource . 22
6.6.1 Description . 22
6.6.2 Resource definition(s) and HTTP methods . 22
6.6.3 Resource representation(s) . 23
6.6.4 HTTP headers . 23
6.6.5 Response codes and error handling . 23
6.7 Pattern: Queries on a resource . 23
6.7.1 Description . 23
6.7.2 Resource definition(s) and HTTP methods . 23
6.7.3 Resource representation(s) . 24
6.7.4 HTTP headers . 24
6.7.5 Response codes and error handling . 24
6.8 Pattern: Updating a resource (PUT) . 24
6.8.1 Description . 24
6.8.2 Resource definition(s) and HTTP methods . 25
6.8.3 Resource representation(s) . 25
6.8.4 HTTP headers . 25
6.8.5 Response codes and error handling . 26
6.9 Pattern: Updating a resource (PATCH) . 26
6.9.1 Description . 26
6.9.2 Resource definition(s) and HTTP methods . 27
6.9.3 Resource representation(s) . 27
6.9.4 HTTP headers . 28
6.9.5 Response codes and error handling . 28
6.10 Pattern: Deleting a resource. 28
6.10.1 Description . 28
6.10.2 Resource definition(s) and HTTP methods . 29
6.10.3 Resource representation(s) . 29
6.10.4 HTTP headers . 29
6.10.5 Response codes and error handling . 29
6.11 Pattern: Task resources . 30
6.11.1 Description . 30
6.11.2 Resource definition(s) and HTTP methods . 30
6.11.3 Resource representation(s) . 30
6.11.4 HTTP headers . 30
6.11.5 Response codes and error handling . 30
6.12 Pattern: REST-based subscribe/notify . 31
6.12.1 Description . 31
6.12.2 Resource definition(s) and HTTP methods . 32
6.12.3 Resource representation(s) . 33
6.12.4 HTTP headers . 33
6.12.5 Response codes and error handling . 33
6.12a Pattern: REST-based subscribe/notify with Websocket fallback . 33
6.12a.1 Description . 33
6.12a.2 Resource definition(s) and HTTP methods . 35
6.12a.3 Resource representation(s) . 36
6.12a.4 HTTP headers . 36
6.12a.5 Response codes and error handling . 36
6.13 Pattern: Asynchronous operations . 36
6.13.1 Description . 36
6.13.2 Resource definition(s) and HTTP methods . 38
6.13.3 Resource representation(s) . 38
6.13.4 HTTP headers . 39
6.13.5 Response codes and error handling . 39
6.14 Pattern: Links (HATEOAS) . 39
6.14.1 Description . 39
6.14.2 Resource definition(s) and HTTP methods . 39
6.14.3 Resource representation(s) . 39
6.14.4 HTTP headers . 41
ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS MEC 009 V3.1.1 (2021-06)
6.14.5 Response codes and error handling . 41
6.15 Pattern: Error responses . 41
6.15.1 Description . 41
6.15.2 Resource definition(s) and HTTP methods . 41
6.15.3 Resource representation(s) . 41
6.15.4 HTTP headers . 42
6.15.5 Response codes and error handling . 42
6.16 Pattern: Authorization of access to a RESTful MEC service API using OAuth 2.0 . 42
6.16.1 Description . 42
6.16.2 Resource definition(s) and HTTP methods . 45
6.16.3 Resource representation(s) . 46
6.16.4 HTTP headers . 46
6.16.5 Response codes and error handling . 46
6.16.6 Discovery of the parameters needed for exchanges with the token endpoint . 46
6.16.7 Scope values . 46
6.17 Pattern: Representation of lists in JSON . 46
6.17.1 Description . 46
6.17.2 Representation as arrays . 46
6.17.3 Representation as maps . 47
6.18 Pattern: Attribute selectors . 47
6.18.1 Description . 47
6.18.2 Resource definition(s) and HTTP methods . 47
6.18.3 Resource representation(s) . 48
6.18.4 HTTP headers . 49
6.18.5 Response codes and error handling . 49
6.19 Pattern: Attribute-based filtering . 49
6.19.1 Description . 49
6.19.2 Resource definition(s) and HTTP methods . 50
6.19.3 Resource representation(s) . 52
6.19.4 HTTP headers . 52
6.19.5 Response codes and error handling . 52
6.20 Pattern: Handling of too large responses . 52
6.20.1 Description . 52
6.20.2 Resource definition(s) and HTTP methods . 53
6.20.3 Resource representation(s) . 53
6.20.4 HTTP headers . 53
6.20.5 Response codes and error handling . 53
7 Alternative transport mechanisms . 53
7.1 Description . 53
7.2 Relationship of topics, subscriptions and access rights . 54
7.3 Serializers . 56
7.4 Authorization of access to a service over alternative transports using TLS credentials . 56
Annex A (informative): REST methods. 59
Annex B (normative): HTTP response status codes . 60
Annex C (informative): Richardson maturity model of REST APIs . 62
Annex D (informative): RESTful MEC service API template. 63
Annex E (normative): Error reporting . 71
E.1 Introduction . 71
E.2 General mechanism . 71
E.3 Common error situations .
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.