WIP: VNF Lifecycle Management interface (46079d2d) · Commits · Miguel Angel Reina Ortega / SOL002-SOL003

src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml

0 → 100644

+1765 −0

File added.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml

0 → 100644

+1033 −0

File added.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml

0 → 100644

+175 −0

Original line number	Diff line number	Diff line
		responses:
		202-with-Location:
		description: >
		The request was accepted for processing, but the processing has not
		been completed. On success, the HTTP response shall include a
		"Location" HTTP header that contains the URI of the newly-created
		"VNF LCM operation occurrence" resource corresponding to the
		operation.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		type: string
		maximum: 1
		minimum: 1
		Location:
		description: The resource URI of the created VNF instance
		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.
		type: string
		maximum: 1
		minimum: 0
		schema:
		$ref: "../definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
		404-task-not-suported-VNF-LCM:
		description: >
		If the API producer did not find a current representation for the
		resource addressed by the URI passed in the request, or is not
		willing to disclose that one exists, it shall respond with this
		response code.
		Specifically in case of this task resource, the reason can also be that
		the task is not supported for the VNF LCM operation occurrence
		represented by the parent resource, and that the task resource
		consequently does not exist.
		The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a
		wrong resource URI variable.
		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"
		409-another-lcm-operation-ongoing:
		description: >
		The operation cannot be executed currently, due to a conflict with the
		state of the VNF instance resource.
		Typically, this is due to the fact that another LCM operation is
		ongoing.
		The response body shall 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.
		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"
		409-inconsistent-state:
		description: >
		Another request is in progress that prohibits the fulfilment of
		the current request, or the current resource state is inconsistent
		with the request.
		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"
		409-state-conflict-INSTANTIATED:
		description: >
		The operation cannot be executed currently, due to a conflict with the
		state of the VNF instance resource.
		Typically, this is due to the fact that the VNF instance resource is in
		INSTANTIATED state.
		The response body shall 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.
		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"
		409-state-conflict-not-FAILED_TEMP:
		description: >
		The operation cannot be executed currently, due to a conflict with the
		state of the VNF instance resource.
		Typically, this is due to the fact that the VNF instance resource is
		not in FAILED_TEMP state, or another error handling action is starting,
		such as rollback or fail.
		The response body shall 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.
		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"
		409-state-conflict-NOT-INSTANTIATED:
		description: >
		The operation cannot be executed currently, due to a conflict with the
		state of the VNF instance resource.
		Typically, this is due to the fact that the VNF instance resource is in
		NOT-INSTANTIATED state, or that another lifecycle management operation
		is ongoing.
		The response body shall 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.
		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"

src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml

0 → 100644

+1259 −0

File added.

Preview size limit exceeded, changes collapsed.

src/definitions/SOL002SOL003_def.yaml

0 → 100644

+94 −0

Original line number	Diff line number	Diff line
		# Copyright (c) ETSI 2017.
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt

		definitions:
		DateTime:
		description: >
		Date-time stamp.
		Representation: String formatted according to IETF RFC 3339.
		type: string

		Identifier:
		description: >
		An identifier with the intention of being globally unique.
		type: string

		IdentifierInVnf:
		description: >
		An identifier that is unique for the respective type within a VNF
		instance, but may not be globally unique.
		type: string

		IdentifierInVnfd:
		description: >
		An identifier that is unique within a VNF descriptor.
		type: string

		KeyValuePairs:
		description: >
		This type is represented in JSON as an extensible JSON object
		type: object

		ProblemDetails:
		#SOL003 location: 4.3.5.3
		description: >
		The definition of the general "ProblemDetails" data structure from
		IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
		general framework defined in IETF RFC 7807 [19], the "status" and
		"detail" attributes are mandated to be included by the present document,
		to ensure that the response contains additional textual information about
		an error. IETF RFC 7807 [19] foresees extensibility of the
		"ProblemDetails" type. It is possible that particular APIs in the present
		document, or particular implementations, define extensions to define
		additional attributes that provide more information about the error.
		The description column only provides some explanation of the meaning to
		Facilitate understanding of the design. For a full description, see
		IETF RFC 7807 [19].
		type: object
		required:
		- status
		- detail
		properties:
		type:
		description: >
		A URI reference according to IETF RFC 3986 [5] that identifies the
		problem type. It is encouraged that the URI provides human-readable
		documentation for the problem (e.g. using HTML) when dereferenced.
		When this member is not present, its value is assumed to be
		"about:blank".
		type: string
		format: URI
		title:
		description: >
		A short, human-readable summary of the problem type. It should not
		change from occurrence to occurrence of the problem, except for
		purposes of localization. If type is given and other than
		"about:blank", this attribute shall also be provided.
		A short, human-readable summary of the problem
		type. It SHOULD NOT change from occurrence to occurrence of the
		problem, except for purposes of localization (e.g., using
		proactive content negotiation; see [RFC7231], Section 3.4).
		type: string
		status:
		description: >
		The HTTP status code for this occurrence of the problem.
		The HTTP status code ([RFC7231], Section 6) generated by the origin
		server for this occurrence of the problem.
		type: integer
		detail:
		description: >
		A human-readable explanation specific to this occurrence of the
		problem.
		type: string
		instance:
		description: >
		A URI reference that identifies the specific occurrence of the
		problem. It may yield further information if dereferenced.
		type: string
		format: URI
		#TODO: How to express "any additional attributes"?

		Uri:
		description: >
		String formatted according to IETF RFC 3986.
		type: string