SOL005_17: ApiVersionInformation data type added to SOL005 common def file (d054bf35) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/definitions/SOL005_def.yaml

+44 −1

Original line number	Diff line number	Diff line
		@@ -212,3 +212,46 @@ definitions:
		of the VIM or the resource provider and can be used as information that
		complements the ResourceHandle.
		type: string

		ApiVersionInformation:
		description: >
		This type represents API version information.
		type: object
		required:
		- uriPrefix
		- apiVersions
		properties:
		uriPrefix:
		description: >
		Specifies the URI prefix for the API, in the following form
		{apiRoot}/{apiName}/{apiMajorVersion}/.
		type: string
		apiVersions:
		description: >
		Version(s) supported for the API signalled by the uriPrefix attribute.
		type: array
		items:
		type: object
		properties:
		version:
		description: >
		Identifies a supported version. The value of the version attribute shall
		be a version identifier as specified in clause 4.6.1.
		type: string
		required: true
		isDeprecated:
		description: >
		If such information is available, this attribute indicates whether use of the
		version signaled by the version attribute is deprecated (true) or not (false).
		A deprecated version is still supported by the API producer but is recommended
		not to be used any longer. When a version is no longer supported, it does not
		appear in the response body.
		$ref: "#/definitions/Boolean"
		required: false
		retirementDate:
		description: >
		The date and time after which the API version will no longer be supported.
		This attribute may be included if the value of the isDeprecated attribute
		is set to true and shall be absent otherwise.
		$ref: "#/definitions/DateTime"
		required: false
		No newline at end of file