API specifications: Difference between revisions
(Update the API conventions section and replace the OpenAPIs section with a pointer to a dedicated page.) |
No edit summary |
||
| Line 80: | Line 80: | ||
|} | |} | ||
Note that [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/013/ ETSI GS NFV-SOL 013] and [https://www.etsi.org/deliver/etsi_gs/NFV-SEC/001_099/022/ ETSI GS NFV-SEC 022] complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively. | Note that [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/013/ ETSI GS NFV-SOL 013] and [https://www.etsi.org/deliver/etsi_gs/NFV-SEC/001_099/022/ ETSI GS NFV-SEC 022] complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively. | ||
== OpenAPIs == | |||
For each of the APIs specified in the aforementionned documents, an [[SOL OpenAPI Main Page|OpenAPI representation]]<nowiki/>is made available on the ETSI Forge Server. These representations, along with developement guidelines, can be found [[SOL OpenAPI Main Page|here]]. | |||
== Tutorials == | == Tutorials == | ||
| Line 87: | Line 90: | ||
*[https://www.brighttalk.com/webcast/6985/263719/common-api-for-nfv-interop Webinar on APIs for interoperability] | *[https://www.brighttalk.com/webcast/6985/263719/common-api-for-nfv-interop Webinar on APIs for interoperability] | ||
*[https://play.webvideocore.net/popplayer.php?it=6dq6y2ugg9c8&c1=%23c8c8c8&c2=%23a6a6a6&w=720&h=505&p=0&title=123LIVE%21+%3A+Common+API+for+NFV+%7C+Bruno+Chatras+%7C+Orange Tutorial at SDN NFV World Congress, Nov 2017] | *[https://play.webvideocore.net/popplayer.php?it=6dq6y2ugg9c8&c1=%23c8c8c8&c2=%23a6a6a6&w=720&h=505&p=0&title=123LIVE%21+%3A+Common+API+for+NFV+%7C+Bruno+Chatras+%7C+Orange Tutorial at SDN NFV World Congress, Nov 2017] | ||
== Link == | == Link == | ||
Revision as of 12:54, 30 August 2019
API conventions
ETSI GS NFV-SOL 015 (draft) defines patterns and conventions for RESTful NFV-MANO API specifications, gives recommendations on API versioning and provides an API specification template. This GS defines provisions to be followed by the ETSI NFV Industry Specification Group (ISG) when creating RESTful NFV-MANO API specifications. The provisions do not apply to implementations.
API specifications
| APIs | Published Versions | Latest Drafts | Bug Tracker | Draft OpenAPI | |
|---|---|---|---|---|---|
| NFV-SOL 002
(Ve-Vnfm) |
VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF) VNF Performance Management interface (as produced by the VNFM towards the EM) VNF Fault Management interface (as produced by the VNFM towards the EM) VNF Indicator interface (as produced by the EM/VNF towards the VNFM) VNF Configuration interface (as produced by the VNF towards the VNFM) This specification fulfills the requirements specified in ETSI GS NFV-IFA 008 |
Published specifications | Draft | Issue Tracker | Git repository |
| NFV-SOL 003
(Or-Vnfm) |
VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO). VNF Performance Management interface (as produced by the VNFM towards the NFVO). VNF Fault Management interface (as produced by the VNFM towards the NFVO). VNF Indicator interface (as produced by the VNFM towards the NFVO). VNF Lifecycle Operation Granting interface (as produced by the NFVO towards the VNFM). VNF Package Management interface (as produced by the NFVO towards the VNFM). Virtualised Resources Quota Available Notification interface (as produced by the NFVO towards the VNFM). This specification fulfills the requirements specified in ETSI GS NFV-IFA 007 |
Published specifications | Draft | Issue Tracker | Git repository |
| NFV-SOL 005
(Os-Ma-Nfvo) |
NSD Management interface (as produced by the NFVO towards the OSS/BSS) NS Lifecycle Management interface (as produced by the NFVO towards the OSS/BSS) NS Performance Management interface (as produced by the NFVO towards the OSS/BSS) NS Fault Management interface (as produced by the NFVO towards the OSS/BSS) VNF Package Management interface (as produced by the NFVO towards the OSS/BSS) This specification fulfills the requirements specified in ETSI GS NFV-IFA 013 |
Published specifications | Draft | Issue Tracker | Git repository |
Note that ETSI GS NFV-SOL 013 and ETSI GS NFV-SEC 022 complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively.
OpenAPIs
For each of the APIs specified in the aforementionned documents, an OpenAPI representationis made available on the ETSI Forge Server. These representations, along with developement guidelines, can be found here.
Tutorials
Links to tutorials and webinars