Liu, Siying 61db61b4e5 CTS API 20230612 version.

Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>

2024-04-18 10:17:02 +00:00

15 KiB

Raw Blame History

Querying a Specific API Version

Function

This API is used to query a specified API version of CTS.

URI

GET /{version}

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
version	Yes	String	Version number.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
version	Object	Information of the version.

**Table 3** Version
Parameter	Type	Description
id	String	Specifies the version ID, for example, v1.
links	Array of LinksBody objects	Specifies the API URL.
version	String	If microversions are supported, set this parameter to the maximum microversion supported. Otherwise, leave this parameter empty.
status	String	Specifies the version status. CURRENT: widely used version. SUPPORTED: earlier version that is still supported. DEPRECATED: deprecated version which may be deleted later. Value: CURRENT SUPPORTED DEPRECATED
updated	String	The version release time in UTC. For example, the release time of v1 is 2014-06-28T12:20:21Z.
min_version	String	If microversions are supported, set this parameter to the minimum microversion supported. Otherwise, leave this parameter empty.

**Table 4** LinksBody
Parameter	Type	Description
href	String	Specifies the reference address of the current API version.
rel	String	Specifies the relationship between the current API version and the referenced address.

Example Request

None

Example Response

Status code: 200

The request is successful.

{
  "version" : {
    "id" : "v1.0",
    "links" : {
      "href" : "https://x.x.x.x/v1.0/",
      "rel" : "self"
    },
    "min_version" : "",
    "status" : "CURRENT",
    "updated" : "2018-09-30T00:00:00Z",
    "version" : ""
  }
}

Status Codes

Status Code	Description
200	The request is successful.
404	The server failed to find the requested resource.
500	The server encountered an unexpected condition which prevented it from fulfilling the request.

Error Codes

For details, see Error Codes.

Parent topic: API Version Management

15 KiB Raw Blame History