addressed comments from SOL WG (efddef62) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

+126 −14

Original line number	Diff line number	Diff line
		@@ -131,7 +131,7 @@ paths:
		409:
		$ref: '#/components/responses/IndividualAlarm.Patch.409'
		412:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
		$ref: '#/components/responses/IndividualAlarm.Patch.412'
		422:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		500:
		@@ -160,18 +160,7 @@ paths:
		201:
		$ref: '#/components/responses/Subscriptions.Post.200'
		303:
		# description: \|
		# 303 SEE OTHER
		#
		# Shall be returned when a subscription with the
		# same callback URI and the same filter already exists
		# and the policy of the VNFM is to not create
		# redundant subscriptions.
		# The HTTP response shall include a "Location"
		# HTTP header that contains the resource URI of the
		# existing "Individual subscription" resource.
		# The response body shall be empty.
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
		$ref: '#/components/responses/Subscriptions.Post.303'
		400:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
		401:
		@@ -185,7 +174,7 @@ paths:
		406:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		422:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		$ref: '#/components/responses/Subscriptions.Post.422'
		500:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
		503:
		@@ -485,6 +474,41 @@ components:
		schema:
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

		IndividualAlarm.Patch.412:
		description: \|
		412 Precondition Failed

		Shall be returned upon the following error: A
		precondition given in an HTTP request header is not
		fulfilled.
		Typically, this is due to an ETag mismatch, indicating
		that the resource was modified by another entity.
		The response body should contain a ProblemDetails
		structure, in which the "detail" attribute should convey
		more information about the error.
		headers:
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string

		Subscriptions.Get.200:
		description: \|
		200 OK
		@@ -573,6 +597,94 @@ components:
		schema:
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"

		Subscriptions.Post.303:
		description: \|
		303 See Other

		Shall be returned when a subscription with the
		same callback URI and the same filter already
		exists and the policy of the VNFM is to not create
		redundant subscriptions.
		The HTTP response shall include a "Location"
		HTTP header that contains the resource URI of
		the existing "Individual subscription" resource.
		The response body shall be empty.
		headers:
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Content-Type:
		description: The MIME type of the body of the response.
		style: simple
		explode: false
		schema:
		type: string
		Location:
		description: \|
		The resource URI of the created subscription resource.
		style: simple
		explode: false
		schema:
		type: string
		format: url

		Subscriptions.Post.422:
		description: \|
		422 Unprocessable Entity

		Shall be returned upon the following error: The
		content type of the payload body is supported
		and the payload body of a request contains
		syntactically correct data but the data cannot be
		processed.
		The general cause for this error and its handling
		is specified in clause 6.4 of ETSI
		GS NFV-SOL 013 [8], including rules for the
		presence of the response body.
		Specifically in case of this resource, the response
		code 422 shall also be returned if the VNFM has
		tested the Notification endpoint as described in
		clause 7.4.6.3.2 and the test has failed.
		In this case, the "detail" attribute in the
		"ProblemDetails" structure shall convey more
		information about the error
		headers:
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Content-Type:
		description: The MIME type of the body of the response.
		style: simple
		explode: false
		schema:
		type: string
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

		IndividualSubscription.Get.200:
		description: \|
		200 OK

src/SOL003/VNFIndicator/VNFIndicator.yaml

+78 −14

Original line number	Diff line number	Diff line
		@@ -171,18 +171,7 @@ paths:
		201:
		$ref: '#/components/responses/Subscriptions.Post.201'
		303:
		# description: \|
		# 303 SEE OTHER
		#
		# Shall be returned when a subscription with the
		# same callback URI and the same filter already
		# exists and the policy of the VNFM is to not create
		# redundant subscriptions.
		# The HTTP response shall include a "Location"
		# HTTP header that contains the resource URI of
		# the existing "Individual subscription" resource.
		# The response body shall be empty.
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
		$ref: '#/components/responses/Subscriptions.Post.303'
		400:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
		401:
		@@ -196,7 +185,7 @@ paths:
		406:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		422:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		$ref: '#/components/responses/Subscriptions.Post.422'
		500:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
		503:
		@@ -502,6 +491,81 @@ components:
		items:
		$ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription

		Subscriptions.Post.303:
		description: \|
		303 See Other

		Shall be returned when a subscription with
		the same callback URI and the same filter
		already exists and the policy of the VNFM
		is to not create redundant subscriptions.
		The HTTP response shall include a
		"Location" HTTP header that contains the
		resource URI of the existing "Individual
		subscription" resource.
		The response body shall be empty
		headers:
		Location:
		description: \|
		The resource URI of the created subscription resource.
		style: simple
		explode: false
		schema:
		type: string
		format: url
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string

		Subscriptions.Post.422:
		description: \|
		422 Unprocessable Entity

		Shall be returned when a subscription with
		the same callback URI and the same filter
		already exists and the policy of the VNFM
		is to not create redundant subscriptions.
		The HTTP response shall include a
		"Location" HTTP header that contains the
		resource URI of the existing "Individual
		subscription" resource.
		The response body shall be empty
		headers:
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		Content-Type:
		description: The MIME type of the body of the response.
		schema:
		type: string
		maximum: 1
		minimum: 1
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
		Subscriptions.Get.200:
		description: \|
		200 OK

src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+813 −129

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml

+326 −42

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml

+269 −6

Original line number	Diff line number	Diff line
		@@ -66,7 +66,7 @@ paths:
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
		$ref: '#/components/responses/PmJobs.Post.422'
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
		503:
		@@ -165,9 +165,9 @@ paths:
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
		412:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
		$ref: '#/components/responses/IndividualPmJob.Patch.412'
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
		$ref: '#/components/responses/IndividualPmJob.Patch.422'
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
		503:
		@@ -273,7 +273,7 @@ paths:
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
		$ref: '#/components/responses/Thresholds.Post.422'
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
		503:
		@@ -368,9 +368,9 @@ paths:
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
		412:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
		$ref: '#/components/responses/IndividualThreshold.Patch.412'
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
		$ref: '#/components/responses/IndividualThreshold.Patch.422'
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
		503:
		@@ -502,6 +502,51 @@ components:
		schema:
		$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"

		PmJobs.Post.422:
		description: \|
		422 Unprocessable Entity

		Shall be returned upon the following error: The
		content type of the payload body is supported and
		the payload body of a request contains syntactically
		correct data but the data cannot be processed.
		The general cause for this error and its handling is
		specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
		including rules for the presence of the response
		body.
		Specifically in case of this resource, the response
		code 422 shall also be returned if the VNFM has
		tested the Notification endpoint as described in
		clause 6.4.9.3.2 and the test has failed.
		In this case, the "detail" attribute in the
		"ProblemDetails" structure sh
		headers:
		Location:
		description: The resource URI of the created PM Job
		style: simple
		explode: false
		schema:
		type: string
		format: url
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

		PmJobs.Get.200:
		description: \|
		200 OK
		@@ -619,6 +664,86 @@ components:
		schema:
		$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications"

		IndividualPmJob.Patch.412:
		description: \|
		412 Precondition Failed

		Shall be returned upon the following error: A
		precondition given in an HTTP request header is not
		fulfilled.
		Typically, this is due to an ETag mismatch, indicating
		that the resource was modified by another entity.
		The response body should contain a ProblemDetails
		structure, in which the "detail" attribute should convey
		more information about the error.
		headers:
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string

		IndividualPmJob.Patch.422:
		description: \|
		422 Unprocessable Entity

		Shall be returned upon the following error: The
		content type of the payload body is supported and the
		payload body of a request contains syntactically
		correct data but the data cannot be processed.
		The general cause for this error and its handling is
		specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
		including rules for the presence of the response body.
		Specifically in case of this resource, the response
		code 422 shall also be returned if the VNFM has
		tested the Notification endpoint as described in
		clause 6.4.9.3.2 and the test has failed.
		In this case, the "detail" attribute in the
		"ProblemDetails" structure shall convey more
		information about the error.
		headers:
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

		IndividualPmJob.Delete.200:
		description: \|
		204 NO CONTENT
		@@ -718,6 +843,60 @@ components:
		schema:
		$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"

		Thresholds.Post.422:
		description: \|
		422 Unprocessable Entity

		Shall be returned upon the following error: The
		content type of the payload body is supported and
		the payload body of a request contains
		syntactically correct data but the data cannot be
		processed.
		The general cause for this error and its handling is
		specified in clause 6.4 of ETSI
		GS NFV-SOL 013 [8], including rules for the
		presence of the response body.
		Specifically in case of this resource, the response
		code 422 shall also be returned if the VNFM has
		tested the Notification endpoint as described in
		clause 6.4.9.3.2 and the test has failed.
		In this case, the "detail" attribute in the
		"ProblemDetails" structure shall convey more
		information about the error
		headers:
		Location:
		description: TThe resource URI of the created VNF instance
		style: simple
		explode: false
		schema:
		type: string
		format: url
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

		Thresholds.Get.200:
		description: \|
		200 OK
		@@ -839,6 +1018,90 @@ components:
		schema:
		$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications"

		IndividualThreshold.Patch.412:
		description: \|
		412 Precondition Failed

		Shall be returned upon the following error: A
		precondition given in an HTTP request header is
		not fulfilled.
		Typically, this is due to an ETag mismatch,
		indicating that the resource was modified by
		another entity.
		The response body should contain a
		ProblemDetails structure, in which the "detail"
		attribute should convey more information about the
		error
		headers:
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string

		IndividualThreshold.Patch.422:
		description: \|
		422 Unprocessable entity

		Shall be returned upon the following error: The
		content type of the payload body is supported and
		the payload body of a request contains
		syntactically correct data but the data cannot be
		processed.
		The general cause for this error and its handling is
		specified in clause 6.4 of ETSI
		GS NFV-SOL 013 [8], including rules for the
		presence of the response body.
		Specifically in case of this resource, the response
		code 422 shall also be returned if the VNFM has
		tested the Notification endpoint as described in
		clause 6.4.9.3.2 and the test has failed.
		In this case, the "detail" attribute in the
		"ProblemDetails" structure shall convey more
		information about the error
		headers:
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		content:
		application/json:
		schema:
		$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

		IndividualThreshold.Delete.200:
		description: \|
		204 NO CONTENT

Admin message