API specifications: Difference between revisions
| Line 32: | Line 32: | ||
| [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_NFV-SOL002v020501p.pdf Published specification] | | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_NFV-SOL002v020501p.pdf Published specification] | ||
| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ | | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ Draft] | ||
| [http://forge.etsi.org/mantis/set_project.php?project_id=153;217&make_default=no&ref=view_all_bug_page.php Issue Tracker] | | [http://forge.etsi.org/mantis/set_project.php?project_id=153;217&make_default=no&ref=view_all_bug_page.php Issue Tracker] | ||
| [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree/HEAD:/src/SOL002 Git repository] | | [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree/HEAD:/src/SOL002 Git repository] | ||
| Line 55: | Line 55: | ||
| [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf Published specification] | | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf Published specification] | ||
| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ | | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ Draft] | ||
| [http://forge.etsi.org/mantis/set_project.php?project_id=153;218&make_default=no&ref=view_all_bug_page.php Issue Tracker] | | [http://forge.etsi.org/mantis/set_project.php?project_id=153;218&make_default=no&ref=view_all_bug_page.php Issue Tracker] | ||
| [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree/HEAD:/src/SOL003 Git repository] | | [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree/HEAD:/src/SOL003 Git repository] | ||
| Line 73: | Line 73: | ||
This specification fulfills the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/013/02.05.01_60/gs_NFV-IFA013v020501p.pdf ETSI GS NFV-IFA 013] | This specification fulfills the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/013/02.05.01_60/gs_NFV-IFA013v020501p.pdf ETSI GS NFV-IFA 013] | ||
| [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_nfv-sol005v020501p.pdf Published specification] | | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_nfv-sol005v020501p.pdf Published specification] | ||
| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ | | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ Draft] | ||
| [http://forge.etsi.org/mantis/set_project.php?project_id=153;227&make_default=no&ref=view_all_bug_page.php Issue Tracker] | | [http://forge.etsi.org/mantis/set_project.php?project_id=153;227&make_default=no&ref=view_all_bug_page.php Issue Tracker] | ||
| [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL005.git/tree Git repository] | | [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL005.git/tree Git repository] | ||
Revision as of 07:25, 27 September 2018
API conventions
API specifications
| APIs | Latest Published Version v2.5.1 | Latest Drafts | Bug Tracker | Draft OpenAPI | |
|---|---|---|---|---|---|
| Ve-Vnfm (NFV-SOL 002) |
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 specification | Draft | Issue Tracker | Git repository |
| Or-Vnfm (NFV-SOL 003) |
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 specification | Draft | Issue Tracker | Git repository |
| Os-Ma-Nfvo (NFV-SOL 005) |
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 specification | Draft | Issue Tracker | Git repository |
Tutorials
Links to tutorials and webinars
OpenAPIs
IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
In case of discrepancies the published ETSI Group Specification takes precedence.
If you found a discrepancy between the NFV Specifications and their OpenAPI description, please report it here.
How to use the links:
- The PDF column contains links to the PDF export of the API definition.
- YAML and JSON columns contain links to the raw text files. They will open a page in the browser with a lot of non readable text and they are meant to be downloaded or used as input for other tools;
- The UI column contains links to the graphical view of the interface using the Swagger UI tool hosted at the Forge. If you want to know more about the Swagger UI tool click here.
- The EDITOR column contains links to a window with both the textual and the graphical views of the interface using the Swagger Editor tool hosted at the Forge. If you want to know more about the Swagger Editor tool click here.
| Interface | Ref Point | Producer | YAML | JSON | UI | EDITOR | |
|---|---|---|---|---|---|---|---|
| SOL002-VNFConfiguration-API | Ve-Vnfm | VNF | Link | Link | Link | Link | Link |
| SOL002-VNFIndicator-API | Ve-Vnfm | VNF/EM | Link | Link | Link | Link | Link |
| SOL002-VNFIndicatorNotification-API | Ve-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL002-VNFFaultManagement-API | Ve-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL002-VNFLifecycleManagement-API | Ve-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL002-VNFPerformanceManagement-API | Ve-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL003-VirtualisedResourcesQuotaAvailableNotification-API | Or-Vnfm | NFVO | Link | Link | Link | Link | Link |
| SOL003-VNFFaultManagement-API | Or-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL003-VNFFaultManagementNotification-API | Or-Vnfm | NFVO | Link | Link | Link | Link | Link |
| SOL003-VNFIndicator-API | Or-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL003-VNFIndicatorNotification-API | Or-Vnfm | NFVO | Link | Link | Link | Link | Link |
| SOL003-VNFLifecycleManagement-API | Or-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL003-VNFLifecycleOperationGranting-API | Or-Vnfm | NFVO | Link | Link | Link | Link | Link |
| SOL003-VNFPackageManagement-API | Or-Vnfm | NFVO | Link | Link | Link | Link | Link |
| SOL003-VNFPackageManagementNotification-API | Or-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL003-VNFPerformanceManagement-API | Or-Vnfm | VNFM | Link | Link | Link | Link | Link |
| SOL003-VNFPerformanceManagementNotification-API | Or-Vnfm | NFVO | Link | Link | Link | Link | Link |
| SOL005-NSDManagement-API | Os-Ma | NFVO | Link | Link | Link | Link | Link |
| SOL005-NSLifecycleManagement-API | Os-Ma | NFVO | Link | Link | Link | Link | Link |
| SOL005-NSFaultManagement-API | Os-Ma | NFVO | Link | Link | Link | Link | Link |
| SOL005-VNFPackageManagement-API | Os-Ma | NFVO | Link | Link | Link | Link | Link |
Report issues and feedback
Instructions for the user:
- Log in at the Forge (at https://forge.etsi.org/index.php/users/login )
- Note that non-ETSI members can also report a comment by registering on Forge to get an account
- Navigate to the link above in the center
- Fill in the information for the issue (summary and description)
- Click the “Submit Comment” button
The current OpenAPI comment list is available here.
The link to create a new comment is currently advertised in the following pages:
- https://nfvwiki.etsi.org/index.php?title=API_specifications#OpenAPIs
- https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree
- And at the beginning of each OpenAPI file.
Please file your reports in the Bugzilla. Use the following categories for your issues:
| Category | Short name | Description | OpenAPI Bug? |
|---|---|---|---|
| 1 | Functionality missing in the OpenAPI | Functionality bug representation compared to the base GS* (e.g., SOL003), Ex. Missing resource, missing attribute | yes |
| 2 | OpenAPI Error Compared to GS | Errors in the OpenAPI representation or textual description errors, Ex: “Integer” instead of “String”, cardinality incorrect or missing | yes |
| 3 | Suggested new functionality | Suggested functionality to be included in the OpenAPI,Ex. A new base GS* feature/capability is suggested | no |
| 4 | Extra Functionality in OpenAPI | The OpenAPI is designed beyond the scope of the base specifications, NFV-SOL 002, NFV-SOL 003, and NFV-SOL 005. | yes |
| 5 | Comment | General comments on the OpenAPI | no |
Note:
- Submitters of comments are required to assign a category for their comment
- After further evaluation of the comment, the project lead or delegate can re-categorize the comment in Bugzilla
Governance
OpenAPI governance is needed to ensure
- Comments on the OpenAPIs can be reported
- Categorization of the comments
- Timeliness for resolving OpenAPI comments
- Accountability (who is responsible for resolving)
- Provide added value for the consumers of ETSI NFV API specifications and foster adoption
| SOL00x Project Lead
Responsibilities |
SOL00x Project Delegate
Responsibilities |
|---|---|
| 1. Review OpenAPI comments | 1. Same as SOL00x project lead |
| 2. Ensure consistency between the Stage 3
ETSI-GS and the OpenAPI representation(s) |
2. Same as SOL00x project lead |
| 3. Propose resolution to the comments
sent to the SOL API mailing list within 3 business days to work towards achieving consensus |
3. Propose resolution to the comments in
concert with the SOL00x project lead |
| 4. Provide status/feedback to the
reporter of the comment |
4. Same as SOL00x project lead (at the
discretion of the SOL00x project lead) |
| 5. Update the OpenAPI for
Category 1, 2, and 4 comments |
5. Same as SOL00x project lead (at the
discretion of the SOL00x project lead) |
| SOL Document | OpenAPI,Project Lead | OpenAPI
Delegate |
|---|---|---|
| SOL002,V2.4.1 | Jong-Hwa Yi | Ernie Bayha |
| SOL003,v2.4.1 | Gergely Csatari | Uwe Rauschenbach |
| SOL005,V2.5.1 | Ernie
Bayha |
TBD |