[openstack-dev] [all][api] POST /api-sig/news

Ed Leafe ed at leafe.com
Thu Apr 12 16:39:31 UTC 2018


Greetings OpenStack community,

It was a fairly quick meeting today, as we weren't able to find anything to argue about. That doesn't happen too often. :)

We agreed that the revamped HTTP guidelines [8] should be merged, as they were strictly formatting changes, and no content change. We also merged the change to update the errors guidance [9] to use service-type instead of service-name, as that had been frozen last week, with no negative feedback since then.

We still have not gotten a lot of feedback from the SDK community about topics to discuss at the upcoming Vancouver Forum. If you are involved with SDK development and have something you'd like to discuss there, please reply to the openstack-dev mailing list thread [7] with your thoughts.

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

* Update the errors guidance to use service-type for code
  https://review.openstack.org/#/c/554921/

* Break up the HTTP guideline into smaller documents
  https://review.openstack.org/#/c/554234/

# API Guidelines Proposed for Freeze

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

None

# Guidelines Currently Under Review [3]

* Add guidance on needing cache-control headers
  https://review.openstack.org/550468

* 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-sigs/2018-March/000353.html
[8] https://review.openstack.org/#/c/554234/
[9] https://review.openstack.org/#/c/554921/

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

-- Ed Leafe








More information about the OpenStack-dev mailing list