Greetings OpenStack community,
A rousing good time at the API-SIG meeting today. We opened with some
discussion on what might be missing from the Methods [7] section of the HTTP
guidelines. At the PTG we had discussed that perhaps we needed more info on
which methods were appropriate when. It turns that what we probably need is
better discoverability, so we're going to work on that but at the same time do
a general review of that entire page.
We then talked about microversions a bit (because it wouldn't be an API-SIG
without them). There's an in-progress history of microversions document (linked
below) that we need to decide if we'll revive. If you have a strong opinion,
let us know.
And finally we explored the options for how or if Neutron can cleanly resolve the
handling of invalid query parameters. This was raised a while back in an email thread
[8]. It's generally a good idea not to break existing client code, but what if that
client code is itself broken? The next step will be to make the choice configurable.
Neutron doesn't support microversions so "throw another microversion at it"
won't work.
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.
None this week.
# Guidelines Currently Under Review [3]
* Add guidance on needing cache-control headers
https://review.openstack.org/550468
* Add guideline on exposing microversions in SDKs
https://review.openstack.org/#/c/532814/
* 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]
http://specs.openstack.org/openstack/api-wg/guidelines/http.html#http-methods
[8] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128023.html
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
__________________________________________________________________________
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
