Greetings OpenStack community,
At today's meeting we discussed an issue that came up on a nova/placement
review [9] wherein there was some indecision about whether a response code of
400 or 404 is more appropriate when a path segement expects a UUID, the request
doesn't supply something that is actually a UUID, and the method being used on
the URI may be creating a resource. We agreed with the earlier discussion that
a 400 was approrpiate in this narrow case. Other cases may be different.
With that warm up exercise out of the way, we moved on to discussing pending
guidelines, freezing one of them [10] and declaring that another [11] required
a followup to clarify the format of strings codes used in error responses.
After that, we did some group learning about StoryBoard [8]. This is becoming
something of a regular activity.
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
Guidelines that are ready for wider review by the whole community.
* Expand error code document to expect clarity
https://review.openstack.org/#/c/577118/
# Guidelines Currently Under Review [3]
* Add links to errors-example.json
https://review.openstack.org/#/c/578369/
* 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] http://lists.openstack.org/pipermail/openstack-dev/2018-June/131881.html
[8] https://storyboard.openstack.org/#!/project/1039
[9] https://review.openstack.org/#/c/580373/
[10] https://review.openstack.org/#/c/577118/
[11] https://review.openstack.org/#/c/578369/
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
