Merge branch '2.5.1-dev' (64f6fb64) · Commits · Miguel Angel Reina Ortega / SOL005

src/SOL005/APIVersion/APIVersion.yaml

0 → 100644

+50 −0

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

		info:
		version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		title: "SOL005 - API version interface"
		description: >
		SOL005 - API version Interface
		IMPORTANT: Please note that this file might be not aligned to the current
		version of the ETSI Group Specification it refers to and has not been
		approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
		Group Specification takes precedence.
		Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
		license:
		name: "ETSI Forge copyright notice"
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		contact:
		name: "NFV-SOL WG"

		externalDocs:
		description: ETSI GS NFV-SOL 005 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

		schemes:
		- http
		- https

		consumes:
		- application/json

		produces:
		- application/json

		paths:
		###############################################################################
		# API Versions #
		###############################################################################
		'/nsd/api-versions':
		$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

		'/nsfm/api-versions':
		$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

		'/nslcm/api-versions':
		$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

		'/nspm/api-versions':
		$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

		'/vnfpkgm/api-versions':
		$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
		No newline at end of file

src/SOL005/NSDManagement/NSDManagement.yaml

+1105 −1587

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml

+506 −879

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL005/NSDManagement/definitions/SOL005_def.yaml

deleted100644 → 0

+0 −104

Original line number	Diff line number	Diff line
		# Copyright (c) ETSI 2017.
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt
		definitions:
		Identifier:
		description: >
		An identifier with the intention of being globally unique.
		type: string
		KeyValuePairs:
		description: >
		This type represents a list of key-value pairs. The order of the pairs in the list is not significant.
		In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions
		defined in clause 4 of IETF RFC 7159.
		type: object
		String:
		description: >
		This type represents stack of string values
		type: string

		Version:
		description: >
		A Version.
		type: string

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

		Link:
		description: >
		This type represents a link to a resource.
		type: object
		required:
		- href
		properties:
		href:
		description: >
		URI of the referenced resource.
		type: string
		format: url

		DateTime:
		description: >
		Date-time stamp.
		Representation: String formatted according to IETF RFC 3339.
		type: string
		format: "date-time"
		ProblemDetails:
		#SOL005 location: 4.3.5.3-1
		description: >
		The definition of the general "ProblemDetails" data structure from
		IETF RFC 7807 [19] is reproduced in this 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:
		- statussss
		- 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
		No newline at end of file

src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml

deleted100644 → 0

+0 −292

Original line number	Diff line number	Diff line
		responses:
		202-with-Location:
		description: >
		Accepted

		The request was accepted for processing, but the processing has not
		been completed. The response body shall be empty.
		The HTTP response shall include a "Location" HTTP
		header that contains the URI of the newly-created
		"NS lifecycle 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 NS 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/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
		202-with-Location-empty:
		description: >
		Accepted

		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
		"NS Descriptor operation occurrence" resource corresponding to the
		operation.
		The response body shall be empty.
		headers:
		Location:
		description: The resource URI of the created NS 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
		409:
		description: >
		Conflict

		Error: The operation cannot be executed currently,
		due to a conflict with the state of the resource.
		Typically, this is due to the fact the NS descriptor
		resource is in the enabled operational state (i.e.
		operationalState = ENABLED) or there are running
		NS instances using the concerned individual NS
		descriptor resource (i.e. usageState = IN_USE).
		The response body shall contain a ProblemDetails
		structure, in which the "detail" attribute shall 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-another-nsd-operation-ongoing:
		description: >
		Conflict

		The operation cannot be executed currently, due to a conflict with the
		state of the NS instance resource.
		Typically, this is due to the fact that another Descriptor 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-inconsistent-state:
		description: >
		Conflict

		Another request is in progress that prohibits the fulfillment 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-state-conflict-INSTANTIATED:
		description: >
		Conflict

		The operation cannot be executed currently, due to a conflict with the
		state of the NS instance resource.
		Typically, this is due to the fact that the NS 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/SOL005_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 NS instance resource.
		Typically, this is due to the fact that the NS 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-state-conflict-NOT-INSTANTIATED:
		description: >
		Conflict

		The operation cannot be executed currently, due to a conflict with the
		state of the NS instance resource.
		Typically, this is due to the fact that the NS 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-nsd-onboarding-state-NOT-ONBOARDED:
		description: >
		Conflict

		Error: The operation cannot be executed currently,
		due to a conflict with the state of the resource.
		Typically, this is due to the fact "nsdOnboardingState"
		has a value different from ONBOARDED.
		The response body shall contain a ProblemDetails
		structure, in which the "detail" attribute shall 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-pnfd-onboarding-state-NOT-ONBOARDED:
		description: >
		Conflict

		Error: The operation cannot be executed currently,
		due to a conflict with the state of the resource.
		Typically, this is due to the fact pnfdOnboardingState
		has a value different from ONBOARDED.
		The response body shall contain a ProblemDetails
		structure, in which the "detail" attribute shall 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/SOL005_def.yaml#/definitions/ProblemDetails"
		409-pnfd-onboarding-state-NOT-CREATED:
		description: >
		Conflict.

		Error: The operation cannot be executed currently,
		due to a conflict with the state of the resource.
		Typically, this is due to the fact that the
		PnfdOnboardingState has a value other than CREATED.
		The response body shall contain a ProblemDetails
		structure, in which the "detail" attribute shall 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/SOL005_def.yaml#/definitions/ProblemDetails"
		No newline at end of file