Comment 2 for bug 1604216

Revision history for this message
Karen Bradshaw (kbhawkey) wrote :

Typically, the request parameter table precedes the request example. If there is no request body, then text such as 'No expected request body for this method' could be in place of the sample. This piece of information is probably missing in a number of instances. Another idea would be to separate the query, header, and path parameters from the request parameter table, and list these parameters in text format above the request body parameter table. This may provide more information on how to create the actual request string.
The response parameter table and response example currently follow the request information.
The examples should have a sub-title identifying the example.