airship
/
airship-in-a-bottle
Code Issues Proposed changes

Merge "Versions API UCP requirement"

This commit is contained in:
Tin Lam 2017-10-04 00:46:19 -04:00 committed by Gerrit Code Review
parent 2f82a91bff 0c1207a51c
commit 1fb9e0c288
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/api-conventions.md
View File

@ -132,7 +132,7 @@ Success message example:
```
## Health Check API
Each UCP component shall expose an endpoint that allows other component
Each UCP component shall expose an endpoint that allows other components
to access and validate its health status. The response shall be received
within 30 seconds.
@ -197,3 +197,33 @@ Success message example:
"code": 200
}
```
## Versions API
Each UCP component shall expose an endpoint that allows other components to
discover its different API versions.
### GET /versions
Invokes a UCP component to return its list of API versions.
#### Versions output
Each UCP component shall return a list of its different API versions. The
response body shall be keyed with the name of each API version, with
accompanying information pertaining to the version's `path` and `status`. The
`status` field shall be an enum which accepts the values "stable" and "beta",
where "stable" implies a stable API and "beta" implies an under-development
API.
Success message example:
```
{
"v1.0": {
"path": "/api/v1.0",
"status": "stable"
},
"v1.1": {
"path": "/api/v1.1",
"status": "beta"
},
"code": 200
}
```