<div dir="ltr"><div id="gmail-magicdomid3" class="gmail-"></div><div id="gmail-magicdomid4" class="gmail-"><span class="gmail-">Greetings OpenStack community,</span></div><div id="gmail-magicdomid70" class="gmail-ace-line"><br></div><div id="gmail-magicdomid1553" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">Another jovial meeting of the API-SIG was convened today. We began with a few housekeeping notes and then moved into a discussion of the api-ref work and how we might continue to assist Graham Hayes with the os-api-ref changes[7] that will output a machine-readable format for the API schemas. The group generally agrees that the SIG should continue to assist in moving these changes forward, there are concerns about the inclusion of microversions and how best to capture these, but for the time being the SIG will engage with the review and the parties interested in seeing this work through to completion.</span></div><div id="gmail-magicdomid638" class="gmail-ace-line"><br></div><div id="gmail-magicdomid1119" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">We then talked about the new reviews which have been added recently to the queue. The SIG has decided to freeze the proposed guidance[8] on exposing microversions in SDKs created by Dmitry Tantsur. There is also a review[9] from Ed Leafe to split up the current HTTP guidance document into separate documents to help improve the readability and presence of this material, this should be ready for freeze soon.</span></div><div id="gmail-magicdomid1121" class="gmail-ace-line"><br></div><div id="gmail-magicdomid1495" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">Lastly, we discussed a new bug[10] concerning how services should be referenced in error messages. The current guidance specifies that a service name should be used and the proposed bug by Chris Dent is that the service type should be used instead. Chris has also created a review[11] to address this but the SIG would like more opinions on this change and how it might impact consuming the error messages.</span></div><div id="gmail-magicdomid1503" class="gmail-ace-line"><br></div><div id="gmail-magicdomid12" class="gmail-"><span class="gmail-">As always if you're interested in helping out, in addition to coming to the meetings, there's also:</span></div><div id="gmail-magicdomid13" class="gmail-"><br></div><div id="gmail-magicdomid14" class="gmail-"><span class="gmail-">* The list of bugs [5] indicates several missing or incomplete guidelines.</span></div><div id="gmail-magicdomid15" class="gmail-"><span class="gmail-">* 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.</span></div><div id="gmail-magicdomid16" class="gmail-"><span class="gmail-">* 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].</span></div><div id="gmail-magicdomid17" class="gmail-"><br></div><div id="gmail-magicdomid18" class="gmail-"><span class="gmail-"># Newly Published Guidelines</span></div><div id="gmail-magicdomid19" class="gmail-"><br></div><div id="gmail-magicdomid20" class="gmail-"><span class="gmail-">None this week.</span></div><div id="gmail-magicdomid21" class="gmail-"><br></div><div id="gmail-magicdomid22" class="gmail-"><span class="gmail-"># API Guidelines Proposed for Freeze</span></div><div id="gmail-magicdomid23" class="gmail-"><br></div><div id="gmail-magicdomid24" class="gmail-"><span class="gmail-">Guidelines that are ready for wider review by the whole community.</span></div><div id="gmail-magicdomid1505" class="gmail-ace-line"><br></div><div id="gmail-magicdomid1508" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">* Add guideline on exposing microversions in SDKs</span></div><div id="gmail-magicdomid1510" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">  </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://review.openstack.org/#/c/532814">https://review.openstack.org/#/c/532814</a></span></div><div id="gmail-magicdomid27" class="gmail-"><br></div><div id="gmail-magicdomid28" class="gmail-"><span class="gmail-"># Guidelines Currently Under Review [3]</span></div><div id="gmail-magicdomid1512" class="gmail-ace-line"><br></div><div id="gmail-magicdomid1516" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">* Break up the HTTP guideline into smaller documents</span></div><div id="gmail-magicdomid1521" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">  </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://review.openstack.org/#/c/554234/">https://review.openstack.org/#/c/554234/</a></span></div><div id="gmail-magicdomid1524" class="gmail-ace-line"><br></div><div id="gmail-magicdomid30" class="gmail-"><span class="gmail-author-a-z67zj2z71zz73zz70zz66zpj9fbgz84zqz75z">* Add guidance on needing cache-control headers</span></div><div id="gmail-magicdomid31" class="gmail-"><span class="gmail-author-a-z67zj2z71zz73zz70zz66zpj9fbgz84zqz75z">  </span><span class="gmail-author-a-z67zj2z71zz73zz70zz66zpj9fbgz84zqz75z gmail-url"><a href="https://review.openstack.org/550468">https://review.openstack.org/550468</a></span></div><div id="gmail-magicdomid32" class="gmail-"><br></div><div id="gmail-magicdomid36" class="gmail-"><span class="gmail-">* Add API-schema guide (still being defined)</span></div><div id="gmail-magicdomid37" class="gmail-"><span class="gmail-">  </span><span class="gmail-url"><a href="https://review.openstack.org/#/c/524467/">https://review.openstack.org/#/c/524467/</a></span></div><div id="gmail-magicdomid38" class="gmail-"><br></div><div id="gmail-magicdomid39" class="gmail-"><span class="gmail-">* A (shrinking) suite of several documents about doing version and service discovery</span></div><div id="gmail-magicdomid40" class="gmail-"><span class="gmail-">  Start at </span><span class="gmail-url"><a href="https://review.openstack.org/#/c/459405/">https://review.openstack.org/#/c/459405/</a></span></div><div id="gmail-magicdomid41" class="gmail-"><br></div><div id="gmail-magicdomid42" class="gmail-"><span class="gmail-">* WIP: microversion architecture archival doc (very early; not yet ready for review)</span></div><div id="gmail-magicdomid43" class="gmail-"><span class="gmail-">  </span><span class="gmail-url"><a href="https://review.openstack.org/444892">https://review.openstack.org/444892</a></span></div><div id="gmail-magicdomid44" class="gmail-"><br></div><div id="gmail-magicdomid45" class="gmail-"><span class="gmail-"># Highlighting your API impacting issues</span></div><div id="gmail-magicdomid46" class="gmail-"><br></div><div id="gmail-magicdomid47" class="gmail-"><span class="gmail-">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.</span></div><div id="gmail-magicdomid48" class="gmail-"><br></div><div id="gmail-magicdomid49" class="gmail-"><span class="gmail-">To learn more about the API SIG mission and the work we do, see our wiki page [4] and guidelines [2].</span></div><div id="gmail-magicdomid50" class="gmail-"><br></div><div id="gmail-magicdomid51" class="gmail-"><span class="gmail-">Thanks for reading and see you next week!</span></div><div id="gmail-magicdomid52" class="gmail-"><br></div><div id="gmail-magicdomid53" class="gmail-"><span class="gmail-"># References</span></div><div id="gmail-magicdomid54" class="gmail-"><br></div><div id="gmail-magicdomid55" class="gmail-"><span class="gmail-">[1] </span><span class="gmail-url"><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a></span></div><div id="gmail-magicdomid56" class="gmail-"><span class="gmail-">[2] </span><span class="gmail-url"><a href="http://specs.openstack.org/openstack/api-wg/">http://specs.openstack.org/openstack/api-wg/</a></span></div><div id="gmail-magicdomid57" class="gmail-"><span class="gmail-">[3] </span><span class="gmail-url"><a href="https://review.openstack.org/#/q/status:open+project:openstack/api-wg,n,z">https://review.openstack.org/#/q/status:open+project:openstack/api-wg,n,z</a></span></div><div id="gmail-magicdomid58" class="gmail-"><span class="gmail-">[4] </span><span class="gmail-url"><a href="https://wiki.openstack.org/wiki/API_SIG">https://wiki.openstack.org/wiki/API_SIG</a></span></div><div id="gmail-magicdomid59" class="gmail-"><span class="gmail-">[5] </span><span class="gmail-url"><a href="https://bugs.launchpad.net/openstack-api-wg">https://bugs.launchpad.net/openstack-api-wg</a></span></div><div id="gmail-magicdomid258" class="gmail-ace-line"><span class="gmail-">[6] </span><span class="gmail-url"><a href="https://git.openstack.org/cgit/openstack/api-wg">https://git.openstack.org/cgit/openstack/api-wg</a></span></div><div id="gmail-magicdomid797" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">[7] </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://review.openstack.org/#/c/528801/">https://review.openstack.org/#/c/528801/</a></span></div><div id="gmail-magicdomid1148" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">[8] </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://review.openstack.org/#/c/532814/">https://review.openstack.org/#/c/532814/</a></span></div><div id="gmail-magicdomid1154" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">[9] </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://review.openstack.org/#/c/554234/">https://review.openstack.org/#/c/554234/</a></span></div><div id="gmail-magicdomid1496" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">[10] </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://bugs.launchpad.net/openstack-api-wg/+bug/1756464">https://bugs.launchpad.net/openstack-api-wg/+bug/1756464</a></span></div><div id="gmail-magicdomid1502" class="gmail-ace-line"><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d">[11] </span><span class="gmail-author-a-spz85zz65zz81zy3oz74zrz89zz65zz87zb5d gmail-url"><a href="https://review.openstack.org/#/c/554921/">https://review.openstack.org/#/c/554921/</a></span></div><div id="gmail-magicdomid63" class="gmail-"><br></div><div id="gmail-magicdomid64" class="gmail-"><span class="gmail-">Meeting Agenda</span></div><div id="gmail-magicdomid65" class="gmail-"><span class="gmail-url"><a href="https://wiki.openstack.org/wiki/Meetings/API-SIG#Agenda">https://wiki.openstack.org/wiki/Meetings/API-SIG#Agenda</a></span></div><div id="gmail-magicdomid66" class="gmail-"><span class="gmail-">Past Meeting Records</span></div><div id="gmail-magicdomid67" class="gmail-"><span class="gmail-url"><a href="http://eavesdrop.openstack.org/meetings/api_sig/">http://eavesdrop.openstack.org/meetings/api_sig/</a></span></div><div id="gmail-magicdomid68" class="gmail-"><span class="gmail-">Open Bugs</span></div><div id="gmail-magicdomid69" class="gmail-"><span class="gmail-url"><a href="https://bugs.launchpad.net/openstack-api-wg">https://bugs.launchpad.net/openstack-api-wg</a></span></div><br></div>