8.4 API Versions

• VNFM supports the following dedicated URIs to enable API consumers to retrieve information about API versions supported.
• For the VNF lifecycle management interface version as specified in the present document, the MAJOR version field shall be 2, the MINOR version field shall be 2, and the PATCH version field shall be 0.
• API version identifiers shall consist of 3 numerical fields, following a MAJOR.MINOR.PATCH.

For Common API Version

Sample Request:

Query Common API Versions
URL: GET: https://<<VNFM HOST IP>>:8443/docs/vnfm/
Authorization : <Token generated after login>

Sample Response:

Response for Query Common API Versions
{
  "uriPrefix": "https://10.75.210.41:8443/vnflcm/api_versions",
  "apiVersions": [
    {
      "version": "2.2.0",
      "isDeprecated": false
    },
    {
      "version": "1.1.0",
      "isDeprecated": false
    }
  ]
}

For V1 API Version

Sample Request:

Response for Query V1 API Version
URL: GET: https://<<VNFM HOST IP>>:8443/docs/vnfm/v1/
Authorization : <Token generated after login>

Sample Response

Response for Query V1 API Version 
{  
  "uriPrefix":
    "https://10.75.210.41:8443/vnflcm/v1/api_versions",  
    "apiVersions": [  
      {  "version": "1.1.0",  "isDeprecated": false  
  }
 ]
}

For V2 API Version

Sample Request:

Query V2 API Version
URL: GET: https://<<VNFM HOST IP>>:8443/docs/vnfm/v2
Authorization : <Token generated after login>

Sample Response:

Response for Query V2 API Version
{
  "uriPrefix": "https://10.75.210.41:8443/vnflcm/v2/api_versions",
  "apiVersions": [
    {
      "version": "2.2.0",
      "isDeprecated": false
    }
  ]
}

Parameters and Definitions

Table 8-2 Parameters and Definitions

Parameters	Definitions
uriPrefix	Specifies the prefix of the resource URI of the "API versions" resource represented by this data structure. Depending on the resource URI, it shall be in one of the two following forms: {apiRoot}/{apiName}/{apiMajorVersion}/ or {apiRoot}/{apiName}/
apiVersions	Versions supported for the API signalled by the uriPrefix attribute.
version	Identifies a supported version.
isDeprecated	If such information is available, this attribute indicates whether use of the version signalled by the version attribute is deprecated (true) or not (false).