From 0eddf5a8dcb6976ddc739fe14da41d7eb8a0a4d3 Mon Sep 17 00:00:00 2001 From: Chris Yeoh Date: Wed, 29 Oct 2014 12:19:25 +1030 Subject: [PATCH] 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 Ceilometer 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: Ib10677b84fbfbf0758f404ec481ece5483722567 --- specs/template.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/specs/template.rst b/specs/template.rst index ce6c129..9dd60b8 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -44,6 +44,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 Ceilometer 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/ceilometer-specs+message:apiimpact,n,z + + Problem description ===================