API Template Organization – Response fields to bottom of layout (#973)

* “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> * “fix#788-API-Guide-further-edits” Signed-off-by: cwillum <cwmmoore@amazon.com> Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-08-24 15:44:57 -07:00 · 2022-08-24 15:44:57 -07:00 · 04d65c8c6f
parent f586fdcd2c
commit 04d65c8c6f
1 changed files with 9 additions and 9 deletions
--- a/STYLE_API_TEMPLATE.md
+++ b/STYLE_API_TEMPLATE.md
@ -33,8 +33,8 @@ Depending on where the documentation appears within a section or subsection, hea
 3. Query parameters (heading level 3)
 4. Request fields (heading level 3)
 5. Sample request (heading level 4)
-6. Response fields (heading level 3)
-7. Sample response (heading level 4)
+6. Sample response (heading level 4)
+7. Response fields (heading level 3)

 ## API name

@ -122,13 +122,6 @@ POST _reindex
 }
 ```

-### Response fields
-
-For PUT and POST APIs: Define all allowable response fields that can be returned in the body of the response.
-
-Field | Data Type | Description
-:--- | :--- | :--- 
-
 #### Sample response

 Include a JSON example response to show what the API returns. See the examples below.
@ -178,3 +171,10 @@ The `POST _reindex` request returns the following response fields:
  "failures" : [ ]
 }
 ```
+
+### Response fields
+
+For PUT and POST APIs: Define all allowable response fields that can be returned in the body of the response.
+
+Field | Data Type | Description
+:--- | :--- | :---