[GitHub] ocket8888 opened a new pull request #3134: Added an explanation of the format and structure of API endpoint docs

[GitBox <gi...@apache.org>]

ocket8888 opened a new pull request #3134: Added an explanation of the format and structure of API endpoint docs
URL: https://github.com/apache/trafficcontrol/pull/3134
 
 
   ## What does this PR do?
   Adds an explanation of the format and structure of API endpoint docs.
   
   ## Which TC components are affected by this PR?
   - [x] Documentation
   - [ ] Grove
   - [ ] Traffic Analytics
   - [ ] Traffic Monitor
   - [ ] Traffic Ops
   - [ ] Traffic Ops ORT
   - [ ] Traffic Portal
   - [ ] Traffic Router
   - [ ] Traffic Stats
   - [ ] Traffic Vault
   - [ ] Other _________
   
   ## What is the best way to verify this PR?
   Ensure the docs build properly, then read the index page for the Traffic Ops API and make sure the format is explained in a thorough, sensible manner. 
   
   ## Check all that apply
   - [ ] This PR includes tests
   - [x] This PR includes documentation updates
   - [ ] This PR includes an update to CHANGELOG.md
   - [ ] This PR includes all required license headers
   - [ ] This PR includes a database migration (ensure that migration sequence is correct)
   - [ ] This PR fixes a serious security flaw. Read more: [www.apache.org/security](http://www.apache.org/security/)
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services