Ns LCM Interface and responses initial migration to OpenAPI 3.0.2 (d1fac1c4) · Commits · Miguel Angel Reina Ortega / SOL005

src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml

+1519 −2058

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL005/components/SOL005_params.yaml

0 → 100644

+118 −0

Original line number	Diff line number	Diff line
		components:
		parameters:
		Version:
		name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string

		Accept:
		name: Accept
		description: >
		Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
		in: header
		required: true
		schema:
		type: string

		Authorization:
		name: Authorization
		description: >
		The authorization token for the request. Reference: IETF RFC 7235.
		in: header
		required: false
		schema:
		type: string

		ContentType:
		name: Content-Type
		description: \|
		The MIME type of the body of the request. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string

		filter:
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI
		GS NFV-SOL 013. The NFV-MANO functional entity shall support
		receiving this parameter as part of the URI query string. The API
		consumer may supply this parameter. All attribute names that appear
		in the FmSubscription and in data types referenced from it shall be
		supported by the NFV-MANO functional entity in the filter
		expression.
		in: query
		required: false
		schema:
		type: string

		all_fields:
		name: all_fields
		description: >
		Include all complex attributes in the response. See clause
		5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity
		shall support this parameter.
		in: query
		required: false
		schema:
		type: string

		fields:
		name: fields
		description: >
		Complex attributes to be included into the response. See clause
		5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
		entity should support this parameter.
		in: query
		required: false
		schema:
		type: string

		exclude_fields:
		name: exclude_fields
		description: >
		Complex attributes to be excluded from the response. See clause
		5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
		entity should support this parameter.
		in: query
		required: false
		schema:
		type: string

		exclude_default:
		name: exclude_default
		in: query
		description: >-
		Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
		for details. The NFV-MANO functional entity shall support this parameter.
		The NFVO shall support this parameter.

		The following attributes shall be excluded from the NsInstance structure in the response body if this parameter
		is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
		- vnfInstances
		- pnfInfo
		- virtualLinkInfo
		- vnffgInfo
		- sapInfo
		- vnfSnapshotInfo
		- nsScaleStatus
		- additionalAffinityOrAntiAffinityRules
		required: false
		schema:
		type: string

		nextpage_opaque_marker:
		name: nextpage_opaque_marker
		description: >
		Marker to obtain the next page of a paged response. Shall be supported by
		the NFV-MANO functional entity if the entity supports alternative 2 (paging)
		according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
		in: query
		required: false
		schema:
		type: string
		No newline at end of file

src/SOL005/responses/SOL005_resp.yaml

+293 −205

Original line number	Diff line number	Diff line
		@@ -2,7 +2,6 @@
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt

		responses:

		202:
		description: >
		202 ACCEPTED
		@@ -40,12 +39,14 @@ responses:
		Content-Type:
		description: >
		The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		Content-Range:
		description: >
		The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -54,24 +55,29 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		303:
		description: >
		303 SEE OTHER
		303 See Other
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -80,12 +86,14 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -121,6 +129,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -129,15 +138,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -152,6 +165,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -160,15 +174,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -183,6 +201,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -191,15 +210,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -219,6 +242,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -227,15 +251,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -248,6 +276,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -256,15 +285,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -272,12 +305,13 @@ responses:
		description: >
		406 NOT ACCEPTABLE

		If the "Accept" header does not contain at least one name of a content type that is acceptable
		to the API producer, the API producer shall respond with this response code.
		The "ProblemDetails" structure may be omitted.
		If the "Accept" HTTP header does not contain at least one name of a content type
		that is acceptable to the API producer, the API producer shall respond with this
		response code. The "ProblemDetails" structure may be omitted.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -286,15 +320,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -304,6 +342,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -312,15 +351,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -335,6 +378,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -343,15 +387,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -365,6 +413,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -373,15 +422,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -395,6 +448,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -403,24 +457,29 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		416:
		description: >
		416 RANGE NOT SATISFIABLE
		416 Range Not Satisfiable
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -429,15 +488,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -454,6 +517,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -462,15 +526,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -489,6 +557,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -497,15 +566,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -520,6 +593,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -528,15 +602,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -551,6 +629,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -559,15 +638,19 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

		@@ -581,6 +664,7 @@ responses:
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		@@ -589,14 +673,18 @@ responses:
		Challenge if the corresponding HTTP request has not provided
		authorization, or error details if the corresponding HTTP
		request has provided an invalid authorization token.
		schema:
		type: string
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
		No newline at end of file