identity v3 api-ref doesn't indicate request or response

[Brant Knudson]

See http://developer.openstack.org/api-ref-identity-v3.html#tokens-v3 for an example of where this is a problem. The first example there is a sample of the JSON request data, but there's no header for the section that says that's what it is.

The 9th example there is the JSON response, but there's no header for the section that says it's the response data.

So nobody knows if the samples are request data or response data. The examples in identity v3 api-ref need headers.

[Anne Gentle (annegentle)]

Just a starting attempt to triage...

If you look at http://developer.openstack.org/api-ref-identity-v2.html and click details next to GET tokens, you see dropdown lists for JSON request and XML request above the first request example, and JSON response and XML response above the first example response. So it's possible the tool isn't outputting a "request" or response" label due to assuming that the APIs will all have XML and JSON examples.

So the fix in the content would be to add XML examples.

The fix in the tool would be to output labels for each example.

[Tom Fifield (fifieldt)]

This one should be taken care of by the shiny new API doc blueprint

[Lana (loquacity)]

I think we can consider this closed with the new approach.