[Openstack-sigs] [all][api] POST /api-sig/news

Michael McCune msm at redhat.com
Thu Aug 2 16:49:39 UTC 2018


Greetings OpenStack community,

Today's meeting was primarily focused around two topics: the IETF[7]
draft proposal for Best Practices when building HTTP protocols[8], and
the upcoming OpenStack Project Teams Gathering (PTG)[9].

The group had taken a collective action to read the aforementioned
draft[8], and as such we were well prepared to discuss its nuances.
For the most part, we agreed that the draft is a good prepartory text
when approaching HTTP APIs and that we should provide a link to it
from the guidelines. Although there are a few areas that we identified
as points of discussion regarding the text of the draft, on balance it
was seen as helpful to the OpenStack community and consistent with our
established guidelines.

On the topic of the PTG, the group has started planning for the event
and is in the early stages gathering content. We will soon have an
etherpad available for topic collection and as an added bonus mordred
himself made a pronouncement about the API-SIG meeting being a
priority in his schedule for this PTG. We hope to see you all there!

The OpenStack infra team will be doing the final rename from API-WG to
API-SIG this Friday. Although there are not expected to be any issues
from this rename, we will be updating documentation references, and
appreciate any help in chasing down bugs.

There were no new guidelines to discuss, nor bugs that have arisen
since last week.

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

# API Guidelines Proposed for Freeze

* None

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

* None

# Guidelines Currently Under Review [3]

* Update parameter names in microversion sdk spec
  https://review.openstack.org/#/c/557773/

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

* 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] https://bugs.launchpad.net/openstack-api-wg
[6] https://git.openstack.org/cgit/openstack/api-wg
[7] https://ietf.org/
[8] https://tools.ietf.org/html/draft-ietf-httpbis-bcp56bis-06
[9] https://www.openstack.org/ptg/

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



More information about the openstack-sigs mailing list