You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2019/06/10 17:20:52 UTC
[GitHub] [trafficcontrol] ocket8888 opened a new pull request #3674: Cleaned
up API endpoint documentation to point to DS overview
ocket8888 opened a new pull request #3674: Cleaned up API endpoint documentation to point to DS overview
URL: https://github.com/apache/trafficcontrol/pull/3674
## What does this PR (Pull Request) do?
Removes a lot of boilerplate explanations of DS fields in the API docs, and changes them to reference the definitions provided in the Delivery Service overview. There's still boilerplate, but it's much smaller and should only need to be updated in one place from now on.
- [x] This PR is not related to any Issue
It also fixes a bunch of incorrect notices regarding tenancy, and adds some missing fields to various DS-related endpoints. One of which was not properly formatted - so it fixed that too.
## Which Traffic Control components are affected by this PR?
- Documentation
## What is the best way to verify this PR?
Build the documentation, then read the docs to be sure they are correct and make sense. No tests, just a docs change.
## The following criteria are ALL met by this PR
- [x] I have explained why tests are unnecessary
- [x] This PR includes documentation
- [x] An update to CHANGELOG.md is not necessary
- [x] This PR includes any and all required license headers
- [x] This PR does not include a database migration
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY**
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services