...
- all release assets are available
- there were not too many changes wrt the previous version
- it is expected to not have any changes in the next 2 meta-releases
- the TSC approves it
M3:
...
The servers object should look like this (API Guidelines section 11.1):
servers:
- url: '{apiRoot}/yourapiname/v0.yrc1' (for initial release or v1rc1 in case of stable release)
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
...
yaml info object: How to add reference to commonalities and remove 'termsOfService' and 'contact' fields ?
In your API yaml file, in the info object, under the version field, please make sure to add: x-camara-commonalities: 0.4.0
NOTE: the fields `termsOfService` and `contact` are optional and can be removed. They are put in italics below.
example:
info:
title: One Time Password SMS
...
x-camara-commonalities: 0.4.0
termsOfService: http://example.com/terms/
contact:
name: API Support
url: http://www.example.com/support
email: support@example.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
M3: yaml servers object: How to put the API version in the URL ?
The servers object should look like this (API Guidelines section 11.1):
servers:
- url: '{apiRoot}/yourapiname/v0.yrc1' (for initial release or v1rc1 in case of stable release)
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`