Greetings OpenStack community, Today's meeting covered a few topics, but was mainly focused on a few updates to the errors guideline.
We began with a review of last week's actions. Ed Leafe has sent an email[7] to mailing list to let the folks working on the GraphQL experiments know that the API-SIG StoryBoard was available for them to use to track their progress. We mentioned the proposed time slot[7] for the API-SIG at the upcoming PTG, but as we are still a few months out from that event no other actions were proposed. Next we moved into a discussion of two guideline updates[8][9] that Chris Dent is proposing. The first review adds concrete examples for the error responses described in the guideline, and the second adds some clarifying language and background on the intent of error codes. During discussion among the group, a few minor areas of improvement were identified and recorded on the reviews with updates to be made by Chris. We discussed the transition to StoryBoard[10] during our bug discussion, noting the places where the workflow differs from Launchpad. Chris also showed us a Board[11] that he created to help figure out how to best use this new tool. 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. None # Guidelines Currently Under Review [3] * Add links to errors-example.json https://review.openstack.org/#/c/578369/ * Expand error code document to expect clarity https://review.openstack.org/#/c/577118/ * 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://review.openstack.org/#/c/578369/ [9] https://review.openstack.org/#/c/577118/ [10] https://storyboard.openstack.org/#!/project/1039 [11] https://storyboard.openstack.org/#!/board/91 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 __________________________________________________________________________ OpenStack Development Mailing List (not for usage questions) Unsubscribe: [email protected]?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
