Open Stack

Greetings OpenStack community,

With this week, the API-SIG had its first real meeting since before the summit in Sydney. Travel and US holidays have meant not enough people were around to make a meeting worth having.

This week there were. First order of business was to officially make Dmitry Tantsur "core". In the context of the API-SIG that means he has the power to freeze and merge guidelines, run the meetings, and write this newsletter. For many months he's been providing excellent reviews on the guidelines that the SIG produces, and excellent and regular input in the discussions we have during the meetings. Welcome Dmitry!

This week's excellent discussion [5] was centered around effective ways of dealing with versions in client code. One of the things that was remarkable about the conversation is that many things that a few years ago were often subject to debate are now fairly commonly accepted as good behavior: service discovery, version discovery, microversions, microversioning per-request (rather than per-session). As the SIG expands into working with SDK developers, being able to talk about and demonstrate these behaviors as "normal" will be very useful.

There has not, of late, been much progress on new (or improved) guidelines, but there are plenty of opportunities. Those of us who are regulars are full of good intentions but in recent months have had too many other obligations. If you are interested in helping out there are three entry points:

* The list of bugs [6] indicates several missing or incomplete guidelines.
* The existing guidelines [2] always need refreshing to account for changes over time. If you find something that's not quite right, submit a patch [7] to fix it.
* Have you done something for which you think guidance would have made things easier but couldn't find any? Submit a patch and help others [7].

# 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]

* 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 SIG about APIs that you are developing or changing, 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 SIG mission and the work we do, see our wiki page [4] and guidelines [2].

Thanks for reading and see you next week!

# References

[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] https://wiki.openstack.org/wiki/API_SIG
[5] http://eavesdrop.openstack.org/meetings/api_sig/2017/api_sig.2017-11-30-16.01.log.html#l-71
[6] https://bugs.launchpad.net/openstack-api-wg
[7] https://git.openstack.org/cgit/openstack/api-wg

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

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