kdamichie commented on code in PR #7698:
URL: https://github.com/apache/trafficcontrol/pull/7698#discussion_r1284732002
##########
docs/source/api/v5/regions.rst:
##########
@@ -126,19 +124,16 @@ Request Structure
Content-Type: application/json
{
- "name": "Manchester",
- "division": "4",
- "divisionName": "England"
+ "division": 4,
+ "name": "Manchester"
}
-.. [1] The only "division" key that actually matters in the request body is
``division``; ``divisionName`` is not validated and has no effect -
particularly not the effect of re-naming the division - beyond changing the
name in the API response to this request. Subsequent requests will reveal the
true name of the division. Note that if ``divisionName`` is not present in the
request body it will be ``null`` in the response, but again further requests
will show the true division name (provided it has been assigned to a division).
-
Response Structure
------------------
:divisionName: The name of the division which contains this region
Review Comment:
Shouldn't `divisionName` be removed in the documentation here as well?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
