openstack/governance
Code Issues Proposed changes

Merge "Clarify the requirements for supports-api-interoperability"

Browse Source
This commit is contained in:
Zuul 2020-12-03 15:52:16 +00:00 committed by Gerrit Code Review
commit 8354c5e824
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
reference/tags/assert_supports-api-interoperability.rst
View File

@ -37,11 +37,11 @@ Requirements
Project teams can apply this tag to services that they produce to assert the
service will follow the following process for end-user-visibile API stability:
#. The project follows the `API interoperability guidelines`_ when making changes to the
REST API
#. The projects API uses a versioning scheme, like `microversions`_, to ensure
that any new features or other changes to the API are both explicit and
discoverable.
#. The project follows the `API interoperability guidelines`_ when making
changes to the REST API
#. The projects API uses a versioning scheme (like `microversions`_) or a
discoverablity mechanism to ensure that any new features or other changes
to the API are both explicit and discoverable.
#. There are branchless API tests run on every commit to ensure that the API
doesn't change between release boundaries.