<div dir="ltr">Thanks for addressing this in the keystone project Sean!</div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Jan 20, 2017 at 12:41 PM, Sean Dague <span dir="ltr"><<a href="mailto:sean@dague.net" target="_blank">sean@dague.net</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">We released a new os-api-ref yesterday which includes a few<br>
enhancements, including the anchor links on the website working as<br>
expected now.<br>
<br>
One of the things in there is a new warning when a parameter is used,<br>
and is not defined.<br>
<br>
<a href="https://github.com/openstack/keystone/blob/bc8a145de14e455a2a73824e8a84d92ac27aae1c/api-ref/source/v2-ext/ksec2-admin.inc#L31" rel="noreferrer" target="_blank">https://github.com/openstack/<wbr>keystone/blob/<wbr>bc8a145de14e455a2a73824e8a84d9<wbr>2ac27aae1c/api-ref/source/v2-<wbr>ext/ksec2-admin.inc#L31</a><br>
- as an example<br>
<br>
Which will generate an issue such as:<br>
<br>
Warning, treated as error:<br>
/home/sdague/code/openstack/<wbr>keystone/api-ref/source/api-<wbr>ref/source/v2-ext/ksec2-admin.<wbr>inc:112<br>
.rst:: WARNING: No path parameter ``userId`` found in rest_parameter stanza.<br>
<br>
<br>
Long term, these really all need to be fixed, because this is specifying<br>
a parameter and giving the user no expectation about what it is and how<br>
it is used.<br>
<br>
In the short term, if this is too hard for teams to address, remove the<br>
'-W' from the sphinx_build line in your api-ref section, then work<br>
through the warnings, and make warnings enforcing when done.<br>
<br>
I've seen fails on keystone. But there may be fails other places as well.<br>
<br>
Keystone fix is here - <a href="https://review.openstack.org/#/c/423387" rel="noreferrer" target="_blank">https://review.openstack.org/#<wbr>/c/423387</a> as an<br>
example of what might be needed to move forward for projects.<br>
<span class="HOEnZb"><font color="#888888"><br>
        -Sean<br>
<br>
--<br>
Sean Dague<br>
<a href="http://dague.net" rel="noreferrer" target="_blank">http://dague.net</a><br>
<br>
______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.<wbr>openstack.org?subject:<wbr>unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-dev</a><br>
</font></span></blockquote></div><br></div>