SOL003_191/SOL003_195: Grants methods updated (ad73b111) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml

+26 −42

Original line number	Diff line number	Diff line
		swagger: "2.0"

		info:
		version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		title: SOL003 - VNF Lifecycle Operation Granting interface
		description: >
		SOL003 - VNF Lifecycle Operation Granting interface
		@@ -25,8 +25,8 @@ info:
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

		externalDocs:
		description: ETSI GS NFV-SOL 003 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
		description: ETSI GS NFV-SOL 003 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf

		basePath: "/grant/v1"

		@@ -52,11 +52,15 @@ paths:
		#SOL003 location: 9.4.2
		post:
		description: >
		Grant Lifecycle Operation


		The POST method requests a grant for a particular VNF lifecycle
		operation.
		Grant Lifecycle Operation.
		The POST method requests a grant for a particular VNF lifecycle operation.
		This method shall follow the provisions specified in the tables 9.4.2.3.1-1 and 9.4.2.3.1-2
		for URI query parameters, request and response data structures, and response codes.
		As the result of successfully processing this request, a new "Individual grant" resource
		shall be created. In the synchronous case which is indicated by responding with "201 Created",
		that resource shall be created before the 200 OK response is returned. In the asynchronous
		case which is indicated by responding with "202 Accepted", this resource may be created
		after the response is returned.
		parameters:
		- name: GrantRequest
		in: body
		@@ -95,11 +99,10 @@ paths:
		description: >
		201 CREATED

		The grant was created successfully (synchronous mode).
		A representation of the created "Individual grant" resource shall
		be returned in the response body.
		The HTTP response shall include a "Location" HTTP header that
		indicates the URI of the "Individual grant" resource just created.
		Shall be returned when the grant has been created successfully (synchronous mode).
		A representation of the created "Individual grant" resource shall be returned in the response body.
		The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual grant"
		resource just created.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		@@ -130,13 +133,11 @@ paths:
		description: >
		202 ACCEPTED

		The request was accepted for processing, but the processing has
		not been completed. It is expected to take some time to create
		the grant (asynchronous mode).
		Shall be returned when the request has been accepted for processing
		and it is expected to take some time to create the grant (asynchronous mode).
		The response body shall be empty.
		The HTTP response shall include a "Location" HTTP header that
		indicates the URI of the "Individual grant" resource that will be
		created once the granting decision has been made.
		The HTTP response shall include a "Location" HTTP header that indicates the URI
		of the "Individual grant" resource that will be created once the granting decision has been made.
		headers:
		Location:
		description: The resource URI of the created VNF instance
		@@ -156,42 +157,25 @@ paths:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		description: >
		Forbidden
		403 FORBIDDEN

		The grant was rejected.
		A ProblemDetails structure shall be included in the response to
		provide more details about the rejection in the "details"
		attribute.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		type: string
		maximum: 1
		minimum: 1
		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.
		type: string
		maximum: 1
		minimum: 0
		schema:
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
		Shall be returned upon the following error: The grant has been rejected.
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		404:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		416:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		504:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

		###############################################################################
		# Resource: Individual grant #
		###############################################################################