[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Chris Dent]

The following proposed API guidelines are available for broader
review by interested parties.

* https://review.openstack.org/#/c/281511/
  Delete multiple metadata items with a single request

* https://review.openstack.org/#/c/260292/
  Add unexpected attribute guideline

* https://review.openstack.org/#/c/286253
  Avoid redundancy in header values

* https://review.openstack.org/#/c/276709
  Added tags restrictions to the tagging guidelines

* https://review.openstack.org/#/c/243429
  Add version discover guideline for API microversions


--
Chris Dent   (�s°□°)�s�喋擤ォ�http://anticdent.org/
freenode: cdent tw: @anticdent__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Everett Toews]

Hi All,

The following API guideline is ready for final review. It will be merged on 
March 18, if there's no further feedback.

1. Header non-proliferation guideline
https://review.openstack.org/#/c/280381/

Cheers,
Everett
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Chris Dent]

There are a couple of API-WG proposed guidelines ready for review by
interested parties:

  Header non proliferation:
  https://review.openstack.org/#/c/280381/

  Client interaction guideline for microversions:
  https://review.openstack.org/#/c/243414/

Please have a look at leave your comments. If people agree the
guidelines are good we'll move on to step 4[1]. If not we'll refine
them until they are.

(There are a few other microversion-related guidelines in progress
as well, but the debate on them continues. Feel free to look at them
too:

* https://review.openstack.org/#/c/243041/
* https://review.openstack.org/#/c/243429/

)

Thanks.

[1] http://specs.openstack.org/openstack/api-wg/process.html#review-process

--
Chris Dent   (�s°□°)�s�喋擤ォ�http://anticdent.org/
freenode: cdent tw: @anticdent__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[michael mccune]

hi all,

The following API guideline is ready for cross project review. It will 
be merged on Feb. 9 if there is no further feedback.


1. Must not return server-side tracebacks
https://review.openstack.org/#/c/183599

regards,
mike

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[michael mccune]

hi all,

The following API guideline is ready for cross project review. It will 
be merged on Jan. 21 if there is no further feedback.


1. Add description of pagination parameters
https://review.openstack.org/#/c/190743

regards,
mike

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Thierry Carrez]

Everett Toews wrote:
> The following API guidelines are ready for cross project review. They will be 
> merged on Nov. 20 if there's no further feedback.
> [...]

I see you added this topic for the next cross-project meeting. Would you
mind chairing that meeting ? I'm traveling with limited availability and
Mike is on honeymoon.

If you agree, please see the meeting chair guide for details:

https://wiki.openstack.org/wiki/Meetings/CrossProjectMeeting#Meeting_chair_guide

NB: we are still discussing phasing out this meeting, but in the mean
time it sounds fair to hold the meeting if there is an agenda posted.

-- 
Thierry Carrez (ttx)

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Everett Toews]

Hi All,

The following API guidelines are ready for cross project review. They will be 
merged on Nov. 20 if there's no further feedback.

1. Add introduction for API micro version guideline
https://review.openstack.org/#/c/187112/

2. Add description of pagination parameters
https://review.openstack.org/#/c/190743/

3. A guideline for errors
https://review.openstack.org/#/c/167793/

Cheers,
Everett


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Ed Leafe]

On Nov 13, 2015, at 12:55 PM, Everett Toews  wrote:

>> Specifically this patch, or the ones dependent on it? Because this specific 
>> patch doesn't actually say anything.
> 
> Specifically this patch. Just looking to initially move forward in some small 
> way on this.

I can see this generating a lot of controversy! :)

-- Ed Leafe







signature.asc
Description: Message signed with OpenPGP using GPGMail
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Everett Toews]

> On Nov 13, 2015, at 12:01 PM, John Dickinson  wrote:
> 
> 
> 
> On 13 Nov 2015, at 9:42, Everett Toews wrote:
> 
>> Hi All,
>> 
>> The following API guidelines are ready for cross project review. They will 
>> be merged on Nov. 20 if there's no further feedback.
>> 
>> 1. Add introduction for API micro version guideline
>> https://review.openstack.org/#/c/187112/
> 
> Specifically this patch, or the ones dependent on it? Because this specific 
> patch doesn't actually say anything.

Specifically this patch. Just looking to initially move forward in some small 
way on this.

Everett


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[John Dickinson]

On 13 Nov 2015, at 9:42, Everett Toews wrote:

> Hi All,
>
> The following API guidelines are ready for cross project review. They will be 
> merged on Nov. 20 if there's no further feedback.
>
> 1. Add introduction for API micro version guideline
> https://review.openstack.org/#/c/187112/

Specifically this patch, or the ones dependent on it? Because this specific 
patch doesn't actually say anything.

>
> 2. Add description of pagination parameters
> https://review.openstack.org/#/c/190743/
>
> 3. A guideline for errors
> https://review.openstack.org/#/c/167793/
>
> Cheers,
> Everett
>
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev


signature.asc
Description: OpenPGP digital signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Everett Toews]

Hi All,

The following API guidelines are ready for cross project review. They will be 
merged on Oct. 16 if there's no further feedback.

1. Adds an API documentation guideline document
https://review.openstack.org/#/c/214817/

2. Add http400 for nonexistent resource
https://review.openstack.org/#/c/221163/

Cheers,
Everett
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Everett Toews]

On Aug 27, 2015, at 10:48 AM, Everett Toews  wrote:

> Hi All,
> 
> The following API guidelines are ready for cross project review. They will be 
> merged on Sept. 4 if there's no further feedback.
> 
> 1. Add description of pagination parameters
> https://review.openstack.org/#/c/190743/
> 
> 2. Require "OpenStack-" in headers
> https://review.openstack.org/#/c/215683/
> 
> 3. Add the condition for using a project term
> https://review.openstack.org/#/c/208264/
> 
> 4. Added note about caching of responses when using https
> https://review.openstack.org/#/c/185288/
> 
> 5. add section describing 501 common mistake
> https://review.openstack.org/#/c/183456/

API guidelines 2-5 above have been merged. Guideline 1 needs further work.

Thanks for you feedback,
Everett


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Everett Toews]

Hi All,

The following API guidelines are ready for cross project review. They will be 
merged on Sept. 4 if there's no further feedback.

1. Add description of pagination parameters
https://review.openstack.org/#/c/190743/

2. Require OpenStack- in headers
https://review.openstack.org/#/c/215683/

3. Add the condition for using a project term
https://review.openstack.org/#/c/208264/

4. Added note about caching of responses when using https
https://review.openstack.org/#/c/185288/

5. add section describing 501 common mistake
https://review.openstack.org/#/c/183456/

Cheers,
Everett


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines Ready for Cross Project Review

[Thierry Carrez]

Everett Toews wrote:
 The following API guidelines are ready for cross project review. They will be 
 merged on Sept. 4 if there's no further feedback.
 
 1. Add description of pagination parameters
 https://review.openstack.org/#/c/190743/
 
 2. Require OpenStack- in headers
 https://review.openstack.org/#/c/215683/
 
 3. Add the condition for using a project term
 https://review.openstack.org/#/c/208264/
 
 4. Added note about caching of responses when using https
 https://review.openstack.org/#/c/185288/
 
 5. add section describing 501 common mistake
 https://review.openstack.org/#/c/183456/

Added to cross-project meeting agenda at:

https://wiki.openstack.org/wiki/Meetings/CrossProjectMeeting

In the future, feel free to edit that directly :)

-- 
Thierry Carrez (ttx)

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines ready for cross project review

[michael mccune]

On 08/11/2015 10:28 AM, michael mccune wrote:

1. Add new guideline for HTTP Headers
https://review.openstack.org/#/c/186526/

2. Add advice on when to use POST or PUT in create
https://review.openstack.org/#/c/181912/

3. Clarify the return code when server have hard-code length limit
https://review.openstack.org/#/c/181784/

if the API Working Group hasn't received any further feedback, we'll
merge them on August 18.


these are slated for merge today, but each has a few comments 
surrounding minor nit-type improvements. should we merge these as is and 
create fix patches, or can we add the changes and merge?


i realize that according to our process[1], these are technically good 
to merge as there is not enough -1 consensus to stop them. i just wanted 
to ask the group before pushing ahead.


mike

[1]: http://specs.openstack.org/openstack/api-wg/process.html

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][api] New API Guidelines ready for cross project review

[michael mccune]

On 08/11/2015 10:28 AM, michael mccune wrote:

1. Add new guideline for HTTP Headers
https://review.openstack.org/#/c/186526/

2. Add advice on when to use POST or PUT in create
https://review.openstack.org/#/c/181912/

3. Clarify the return code when server have hard-code length limit
https://review.openstack.org/#/c/181784/


these guidelines have been merged as per the freeze process guidelines.

guidelines #1 and #2, generated comments that should be addressed in 
follow-up patches.


thanks,
mike


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines ready for cross project review

[michael mccune]

hi all,

we have 3 API Guidelines that are ready for final review.

1. Add new guideline for HTTP Headers
https://review.openstack.org/#/c/186526/

2. Add advice on when to use POST or PUT in create
https://review.openstack.org/#/c/181912/

3. Clarify the return code when server have hard-code length limit
https://review.openstack.org/#/c/181784/

if the API Working Group hasn't received any further feedback, we'll
merge them on August 18.

thanks,
mike

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines ready for cross project review

[Everett Toews]

Hi All,

We have 7 API Guidelines that are ready for a final review.

1. Add section clarifying PUT vs PATCH semantics
https://review.openstack.org/#/c/183945/

2. Adding 5xx guidance
https://review.openstack.org/#/c/183698/

3. Adds a small update to tagging guidance
https://review.openstack.org/#/c/187891/

4. Add the description of GET method
https://review.openstack.org/#/c/185180/

5. Adds clarification and example to 500 guidance
https://review.openstack.org/#/c/190064/

6. add subsection around caching behavior and http
https://review.openstack.org/#/c/183523/

7. add section describing method use in http
https://review.openstack.org/#/c/189738/

If the API Working Group hasn’t received any further feedback, we’ll merge them 
on July 13.

Thanks,
Everett
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines ready for cross project review

[michael mccune]

hi all,

we have 1 API guideline that is ready for final review

1. Adds clarifications on state-conflicting requests
https://review.openstack.org/#/c/180094

if the API working group hasn't received any further feedback, we'll 
merge this on July 3.


regards,
mike

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][api] New API Guidelines ready for cross project review

[Everett Toews]

Hi All,

We have 3 API Guidelines that are ready for a final review.

1. Add section on filtering
https://review.openstack.org/#/c/177468/

2. http guideline expansion: background
https://review.openstack.org/#/c/181931/

3. Should not return server-side tracebacks
https://review.openstack.org/#/c/183599/

If the API Working Group hasn’t received any further feedback, we’ll merge them 
on June 26.

Thanks,
Everett


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev