tacker/api-ref/source/v1/parameters_vnflcm_versions.yaml
Hirofumi Noguchi f24afcf705 Add documents for multi-version API support
This patch provides Tacker documents for multi-version API support.
VNF LCM API Version 2 is added to API Reference and the page hierarchy
is changed for readability.
Also, the Show VNF LCM Versions command is added to Command-Line
Interface Reference.
Furthermore, a manual of the Userdata script is added to Tacker User
Guide.

Implements: blueprint multi-version-api
Implements: blueprint support-nfv-solv3-start-and-terminate-vnf
Implements: blueprint support-nfv-solv3-query-vnf-instances
Implements: blueprint support-nfv-solv3-query-operation-occurrences
Implements: blueprint support-nfv-solv3-subscriptions
Change-Id: I603e32090303af080b17e549a0caf7e862aa7e1e
2021-09-16 20:00:56 +09:00

45 lines
1011 B
YAML

# variables in header
api_Major_Version:
description: |
Indicates the major version of API.
in: path
required: true
type: string
# variables in body
api_Versions:
description: |
Version(s) supported for the API signalled by the uriPrefix attribute.
in: body
required: true
type: Structure (inlined)
isDeprecated:
description: |
This attribute indicates whether use of the version signalled
by the version attribute is deprecated (true) or not (false).
in: body
required: false
type: boolean
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.
in: body
required: false
type: datetime
uriPrefix:
description: |
URI prefix for the API.
in: body
required: true
type: string
version:
description: |
Supported version.
in: body
required: true
type: String