API specifications: Difference between revisions

From NFVwiki
No edit summary
(Update the API conventions section and replace the OpenAPIs section with a pointer to a dedicated page.)
Line 1: Line 1:
== API conventions==
== API conventions==
 
[https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL015_-_RESTful_API_Patterns_and_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.  
*[https://nfvwiki.etsi.org/images/NFVSOL(18)000100r3_ETSI_NFV_SOL_REST_API_Conventions.pdf ETSI NFV SOL API Conventions]
*[https://nfvwiki.etsi.org/index.php?title=OpenAPIs_development_guidelines OpenAPI developement guidelines]


== API specifications ==
== API specifications ==


  {| class="wikitable alternance center"
  {| class="wikitable alternance center"
  |+ APIs exposed on MANO reference points
  |+ ETSI NFV Management and Orchestration (NFV-MANO) APIs - Release 2
  |-
  |-
  |
  |
Line 17: Line 15:


  |-
  |-
  ! scope="row" | Ve-Vnfm  <br> (NFV-SOL 002)
  ! scope="row" | NFV-SOL 002
(Ve-Vnfm)   <br>
  | align="left" |  
  | align="left" |  
VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF)
VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF)
Line 36: Line 35:
  | [https://forge.etsi.org/gitlab/nfv/SOL002-SOL003 Git repository]
  | [https://forge.etsi.org/gitlab/nfv/SOL002-SOL003 Git repository]
  |-
  |-
  ! scope="row" | Or-Vnfm  <br>    (NFV-SOL 003)
  ! scope="row" | NFV-SOL 003
(Or-Vnfm)
  | align="left" |  
  | align="left" |  
VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).
VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).
Line 59: Line 59:
  | [https://forge.etsi.org/gitlab/nfv/SOL002-SOL003 Git repository]
  | [https://forge.etsi.org/gitlab/nfv/SOL002-SOL003 Git repository]
  |-
  |-
  ! scope="row" | Os-Ma-Nfvo  <br>   (NFV-SOL 005)
  ! scope="row" | NFV-SOL 005
(Os-Ma-Nfvo)   <br>
  | align="left" |  
  | align="left" |  
NSD Management interface (as produced by the NFVO towards the OSS/BSS)
NSD Management interface (as produced by the NFVO towards the OSS/BSS)
Line 78: Line 79:


  |}
  |}
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.


== Tutorials ==
== Tutorials ==
Line 87: Line 89:


== OpenAPIs ==
== OpenAPIs ==
 
[[SOL OpenAPI Main Page|OpenAPI representations]] of NFV-MANO APIs are available on the ETSI Forge Server.  
<center>
<big>
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. <br />In case of discrepancies the published ETSI Group Specification takes precedence.
 
<span style="color:red">
If you found a discrepancy between the NFV Specifications and their OpenAPI description, please report it
[https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NFV here.]
</span>
</big>
</center>
 
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 [https://swagger.io/swagger-ui/ 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 [https://swagger.io/swagger-editor/ click here].
 
<big>
{| class="wikitable sortable center"
! Interface
! Ref Point
! Producer
! YAML
! JSON
! UI
! EDITOR
! PDF
|-
| style="text-align:left;" | SOL002-VNFConfiguration-API
| Ve-Vnfm
| VNF
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.pdf Link]
|-
| style="text-align:left;" | SOL002-VNFIndicator-API
| Ve-Vnfm
| VNF/EM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.pdf Link]
|-
| style="text-align:left;" | SOL002-VNFIndicatorNotification-API
| Ve-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.pdf Link]
|-
| style="text-align:left;" | SOL002-VNFFaultManagement-API
| Ve-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFFaultManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFFaultManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL002-VNFLifecycleManagement-API
| Ve-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFLifecycleManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFLifecycleManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL002-VNFPerformanceManagement-API
| Ve-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFPerformanceManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFPerformanceManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VirtualisedResourcesQuotaAvailableNotification-API
| Or-Vnfm
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFFaultManagement-API
| Or-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFFaultManagementNotification-API
| Or-Vnfm
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFIndicator-API
| Or-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFIndicatorNotification-API
| Or-Vnfm
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFLifecycleManagement-API
| Or-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFLifecycleOperationGranting-API
| Or-Vnfm
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFPackageManagement-API
| Or-Vnfm
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFPackageManagementNotification-API
| Or-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFPerformanceManagement-API
| Or-Vnfm
| VNFM
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL003-VNFPerformanceManagementNotification-API
| Or-Vnfm
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.pdf Link]
|-
| style="text-align:left;" | SOL005-NSDManagement-API
| Os-Ma
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSDManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSDManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSDManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSDManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSDManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL005-NSLifecycleManagement-API
| Os-Ma
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSLifecycleManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSLifecycleManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSLifecycleManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL005-NSFaultManagement-API
| Os-Ma
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSFaultManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSFaultManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSFaultManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL005-NSPerformanceManagement-API
| Os-Ma
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSPerformanceManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSPerformanceManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-NSPerformanceManagement-API.pdf Link]
|-
| style="text-align:left;" | SOL005-VNFPackageManagement-API
| Os-Ma
| NFVO
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-VNFPackageManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-VNFPackageManagement-API.json/*view*/ Link]
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-VNFPackageManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-VNFPackageManagement-API.yaml/*view*/ Link]
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build/SOL005-VNFPackageManagement-API.pdf Link]
|}
</big>
 
=== Report issues and feedback ===
 
===== How to report an issue =====
Instructions for the user:
* Log in at the Forge (at https://forge.etsi.org/index.php/users/login )
* Navigate to the <span style="color:red">[https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NFV new issue] </span>page.
* Fill in the information for the issue.
** Please choose the proper category for your issue.
* Click the “Submit Comment” button
 
===== More information on the issues =====
The current OpenAPI issue list is available [https://forge.etsi.org/bugzilla/describecomponents.cgi?product=NFV 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:
 
{| class="wikitable"
! '''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
 
{| class="wikitable"
! 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
| style="font-style: italic;" | 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
| style="font-style: italic;" | 5. Same as SOL00x project lead (at the
discretion of the SOL00x project lead)
|}
 
{| class="wikitable"
! 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
|}


== Link ==
== Link ==

Revision as of 12:39, 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

ETSI NFV Management and Orchestration (NFV-MANO) APIs - Release 2
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.

Tutorials

Links to tutorials and webinars

OpenAPIs

OpenAPI representations of NFV-MANO APIs are available on the ETSI Forge Server.

Link

Return to NFV Solutions page

Return to ETSI ISG NFV page

Retrieved from "https://nfvwiki.etsi.org/index.php?title=API_specifications&oldid=3541"