Open Stack

308 Permanent Redirect
Location: /api-sig/news

Greetings OpenStack community,

As with last week, today's meeting started off with continued discussion about the Guided Review process that we are trying to create ahead of the Denver PTG. elmiko continues to shape the proposal in a review [0]. For the most part we're all pretty happy with it.

We then moved on to discussing the API-WG becoming API-SIG. Continued email discussion [4] has left us feeling like it's a good idea, so we voted to go for it. There were some concerns about how this might impact repository and bug tracking names, but we felt that we could leave those questions to be addressed when they become problems. Over the next few weeks you may see some changes in how things are named, but existing behaviors (making guidelines, sending this newsletter, having a weekly IRC meeting) will remain.

On the topic of guidance, there's one new work in progress [5] discouraging the use of extensions which add URLs to APIs or change the shape of representations. As the comments there indicate, this is a tricky topic when functionality is impacted either by policy or by the presence of different drivers. We haven't fully decided how we're going to explain these issues, but we do want to make sure that it is well known that if you are trying to create an interoperable API, optional URIs are a bad idea.

# Newly Published Guidelines

None this week.

# API Guidelines Proposed for Freeze

Guidelines that are ready for wider review by the whole community.

None this week

# Guidelines Currently Under Review [3]

* Explain, simply, why extensions are bad
   https://review.openstack.org/#/c/491611/

* A (shrinking) suite of several documents about doing version and service discovery
   Start at https://review.openstack.org/#/c/459405/

* WIP: microversion architecture archival doc (very early; not yet ready for review)
   https://review.openstack.org/444892

# Highlighting your API impacting issues

If you seek further review and insight from the API WG, please address your concerns in an email to the OpenStack developer mailing list[1] with the tag "[api]" in the subject. In your email, you should include any relevant reviews, links, and comments to help guide the discussion of the specific challenge you are facing.

To learn more about the API WG mission and the work we do, see OpenStack API Working Group [2].

Thanks for reading and see you next week!

# References

[0] https://review.openstack.org/#/c/487847/
[1] http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[2] http://specs.openstack.org/openstack/api-wg/
[3] https://review.openstack.org/#/q/status:open+project:openstack/api-wg,n,z
[4] http://lists.openstack.org/pipermail/openstack-sigs/2017-August/000035.html
[5] https://review.openstack.org/#/c/491611/


Meeting Agenda
https://wiki.openstack.org/wiki/Meetings/API-WG#Agenda
Past Meeting Records
http://eavesdrop.openstack.org/meetings/api_wg/
Open Bugs
https://bugs.launchpad.net/openstack-api-wg

-- 
Chris Dent                      (⊙＿⊙')         https://anticdent.org/
freenode: cdent                                         tw: @anticdent