Difference between revisions of "OpenAPIs development guidelines"

From NFVwiki
Jump to: navigation, search
(List of repositories)
(List of repositories)
Line 31: Line 31:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Name !! Content !! Manager !! Link !! Review link  
+
! Name !! Content !! Leader !! Link !! Review link  
 
|-
 
|-
 
| NFV || Overall materials, examples, documentation || ETSI CTI || https://forge.etsi.org/rep/gitweb.cgi/NFV.git || https://forge.etsi.org/gerrit/#/q/project:nfv
 
| NFV || Overall materials, examples, documentation || ETSI CTI || https://forge.etsi.org/rep/gitweb.cgi/NFV.git || https://forge.etsi.org/gerrit/#/q/project:nfv

Revision as of 14:40, 20 September 2017

OpenAPI developement guidelines for ETSI NFV SOL working group. More general recommendations can be found at Forge OpenAPI Gudelines.

API development

General guidelines

Root API files

Since the specification requires the apiVersion be after apiName in the resource path, each interface will have a separate OpenAPI root file.

In details, paths are required to start with:

<apiRoot>/<apiName>/<apiVersion>

the only way to model this with OAS is using separate files for each interface. This will also help readability and clarity.

Repositories

Guidelines on the creation and usage of repositories will be available in this section.

Folder structure

Guidelines on the folder structure for each repository will be available in this section.

Links and contacts

List of repositories

Name Content Leader Link Review link
NFV Overall materials, examples, documentation ETSI CTI https://forge.etsi.org/rep/gitweb.cgi/NFV.git https://forge.etsi.org/gerrit/#/q/project:nfv
NFV-SOL.GS_002 API definitions for GS 002 ProceraNetworks TBD https://forge.etsi.org/gerrit/#/q/project:NFV-SOL.GS_002
NFV-SOL.GS_003 Overall materials, examples, documentation Nokia TBD TBD


If you are willing to contribute or if you want more information, contact ETSI CTI.