Open Stack

Greetings OpenStack community,

Wide-ranging conversations in the API-SIG meeting today [7]. We started out discussing techniques for driving the adoption of the guidelines published by the group. Two ideas received most of the attention:

* Provide guidance on the tools available to make it easier to align new API projects with the guidelines, from the outset. The idea of an example or cookbook project was mooted, but the number of options, variables, and opinions that such an effort would face killed this idea. Better, perhaps, are recommend tools for addressing common problems.

* Making use of the OpenStack-wide goals [8] process to encourage working towards consistency. Monty has made a proposal [9] based on the rfc5988 link guidance newly listed below.

Then we talked about work in progress to establish a common health check system across the OpenStack services. There's an oslo-spec [10] in progress. The API-SIG's involvement is to help make sure the HTTP side of things is handled well.

As always if you're interested in helping out, in addition to coming to the meetings, there's also:

* The list of bugs [5] 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 [6] 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 [6].

# Newly Published Guidelines

None this week.

# API Guidelines Proposed for Freeze

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

* Expand note about rfc5988 link header
   https://review.openstack.org/#/c/531914/

# Guidelines Currently Under Review [3]

* Add guideline on exposing microversions in SDKs
   https://review.openstack.org/#/c/532814/

* 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

* WIP: Add API-schema guide (still being defined)
   https://review.openstack.org/#/c/524467/

# 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] https://bugs.launchpad.net/openstack-api-wg
[6] https://git.openstack.org/cgit/openstack/api-wg
[7] http://eavesdrop.openstack.org/meetings/api_sig/2018/api_sig.2018-01-11-15.59.html
[8] https://governance.openstack.org/tc/goals/index.html
[9] https://review.openstack.org/#/c/532627/
[10] https://review.openstack.org/#/c/531456/

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