OpenAPIs development guidelines - Revision history

Carignani: /* Repositories */

2017-09-20T13:44:42Z

Repositories

← Older revision		Revision as of 14:44, 20 September 2017
Line 19:		Line 19:
	== Repositories ==		== Repositories ==

	~~Guidelines on~~ the ~~creation and usage~~ of ~~repositories will be available in this section~~.		* For each deliverable a separate repository is created.
			* The name of the repository should have:
			** Name of deliverable eg. NFV-SOL.GS_002 or
			** Name of the reference point specified, e.g. ve-vnfm

	== Folder structure ==		== Folder structure ==

Carignani: /* List of repositories */

2017-09-20T13:40:00Z

List of repositories

← Older revision		Revision as of 14:40, 20 September 2017
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

Carignani: /* List of repositories */

2017-09-20T12:42:08Z

List of repositories

← Older revision		Revision as of 13:42, 20 September 2017
Line 34:		Line 34:
	\|-		\|-
	\| 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
			\|-
	\| 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_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		\| NFV-SOL.GS_003 \|\| Overall materials, examples, documentation \|\| Nokia \|\| TBD \|\| TBD
	\|}		\|}

Carignani at 12:41, 20 September 2017

2017-09-20T12:41:43Z

← Older revision		Revision as of 13:41, 20 September 2017
Line 1:		Line 1:
	OpenAPI developement guidelines for ETSI NFV SOL working group.		OpenAPI developement guidelines for ETSI NFV SOL working group.
			More general recommendations can be found at [https://forge.etsi.org/wiki/index.php/OpenAPI_Guidelines Forge OpenAPI Gudelines].

	= API development =		= API development =
Line 32:		Line 33:
	! Name !! Content !! Manager !! Link !! Review link		! Name !! Content !! Manager !! 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
			\| 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 [mailto:cti_support@etsi.org?subject=SOL%20openapis%20development: ETSI CTI].		If you are willing to contribute or if you want more information, contact [mailto:cti_support@etsi.org?subject=SOL%20openapis%20development: ETSI CTI].

Carignani at 12:36, 20 September 2017

2017-09-20T12:36:59Z

← Older revision		Revision as of 13:36, 20 September 2017
Line 2:		Line 2:

	= API development =		= API development =

			== General guidelines ==

			=== Root API files ===

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

			In details, paths are required to start with:
			<pre>
			<apiRoot>/<apiName>/<apiVersion>
			</pre>

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

	== Repositories ==		== Repositories ==

Carignani at 09:51, 19 September 2017

2017-09-19T09:51:50Z

@@ Line 1: / Line 1: @@
 OpenAPI developement guidelines for ETSI NFV SOL working group.
 == Repositories ==
@@ Line 8: / Line 10: @@
 Guidelines on the folder structure for each repository will be available in this section.

Carignani: Created page with "OpenAPI developement guidelines for ETSI NFV SOL working group. == Repositories == Guidelines on the creation and usage of repositories will be available in this section. =..."

2017-09-19T09:41:29Z

Created page with "OpenAPI developement guidelines for ETSI NFV SOL working group. == Repositories == Guidelines on the creation and usage of repositories will be available in this section. =..."

New page

OpenAPI developement guidelines for ETSI NFV SOL working group.

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