Everett Toews 536142c8ea 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 Zaqar 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: Ib5f348764329864ea3f312a8c19c4cd322631909

2014-10-31 15:19:52 -05:00

2.7 KiB

Raw Blame History

The title of your blueprint

Include the URL of your launchpad blueprint:

https://blueprints.launchpad.net/zaqar/+spec/example

Introduction paragraph -- why are we doing anything?

Problem description

A detailed description of the problem.

Proposed change

Here is where you cover the change you propose to make in detail. How do you propose to solve this problem?

If this is one part of a larger effort make it clear where this piece ends. In other words, what's the scope of this effort?

If your specification proposes any changes to the Zaqar 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/zaqar-specs+message:apiimpact,n,z

Alternatives

This is an optional section, where it does apply we'd just like a demonstration that some thought has been put into why the proposed approach is the best one.

Implementation

Assignee(s)

Who is leading the writing of the code? Or is this a blueprint where you're throwing it out there to see who picks it up?

If more than one person is working on the implementation, please designate the primary author and contact.

Primary assignee:: <launchpad-id or None>

Can list additional ids if they intend on doing substantial implementation work on this blueprint.

Milestones

Target Milestone for completion:: Juno-2

Work Items

Work items or tasks -- break the feature up into the things that need to be done to implement it. Those parts might end up being done by different people, but we're mostly trying to understand the timeline for implementation.

Dependencies

Include specific references to specs and/or blueprints in zaqar, or in other projects, that this one either depends on or is related to.

Note

This work is licensed under a Creative Commons Attribution 3.0 Unported License. http://creativecommons.org/licenses/by/3.0/legalcode

2.7 KiB Raw Blame History