Add requirement for APIImpact flag

Adds a requirement for an APIImpact flag in
the commit message for a proposed spec if it proposes
changes to the Barbican REST API. This will make it
much easier for people such as the API WG who want to
review API changes across OpenStack to find and
review proposed API changes.

Change-Id: I73734fa775b3bf25c6eb64311d7940f5db9d5f22
This commit is contained in:
Chris Yeoh 2014-10-29 11:09:53 +10:30
parent b38ef62a1c
commit 45d4989322
1 changed files with 10 additions and 1 deletions

View File

@ -40,6 +40,15 @@ Some notes about using this template:
having to look at additional files which can not be viewed in gerrit. It
will also allow inline feedback on the diagram itself.
* If your specification proposes any changes to the Barbican REST API such
as changing parameters which can be returned or accepted, or even
the semantics of what happens when a client calls into the API, then
you should add the APIImpact flag to the commit message. Specifications with
the APIImpact flag can be found with the following query::
https://review.openstack.org/#/q/status:open+project:openstack/barbican-specs+message:apiimpact,n,z
Problem Description
===================
@ -320,4 +329,4 @@ references are unavailable. Examples of what you could include are:
* Related specifications as appropriate (e.g. if it's an EC2 thing, link the
EC2 docs)
* Anything else you feel it is worthwhile to refer to
* Anything else you feel it is worthwhile to refer to