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 2020/01/13 22:38:35 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new issue #4290: Undocumented
Traffic Ops Golang routes
zrhoffman opened a new issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290
<!--
************ STOP!! ************
If this issue identifies a security vulnerability, DO NOT submit it! Instead, contact
the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
<!--
- For *SUPPORT QUESTIONS*, use the
[Traffic Control slack channels](https://traffic-control-cdn.slack.com) or [Traffic Control mailing lists](http://trafficcontrol.apache.org/mailing_lists/).
- Before submitting, please **SEARCH GITHUB** for a similar issue or PR. -->
## I'm submitting a ...
<!-- (check all that apply with "[x]") -->
<!--- security vulnerability (STOP!! - see above)-->
- [x] bug report
- [ ] new feature / enhancement request
- [x] improvement request (usability, performance, tech debt, etc.)
- [ ] other <!--(Please do not submit support requests here - see above)-->
## Traffic Control components affected ...
<!-- (check all that apply with "[x]") -->
- [ ] CDN in a Box
- [x] Documentation
- [ ] Grove
- [ ] Traffic Control Client
- [ ] Traffic Monitor
- [x] Traffic Ops
- [ ] Traffic Ops ORT
- [ ] Traffic Portal
- [ ] Traffic Router
- [ ] Traffic Stats
- [ ] Traffic Vault
- [ ] unknown
## Current behavior:
<!-- Describe how the bug manifests / how the current features are insufficient. -->
The following routes are defined in `routes.go` but do not have a page in our Traffic Ops API documentation:
* [`about`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L356)
* [`cdns/dnsseckeys/generate`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L190)
* [`deliveryservice_matches`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L303)
* [`deliveryservice_request_comments`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L389-L393)
* [`deliveryservice_requests`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L378-L383)
* [`deliveryservice_requests/{{ID}}/assign`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L386)
* [`deliveryservice_requests/{{ID}}/status`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L387)
* [`deliveryservices/{{ID}}/urlkeys`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L556)
* [`divisions/name/{{name}}`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L209)
* [`federations/all`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L514)
* [`keys/ping`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L266)
* [`ping`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L264)
* [`regions/name/{{name}}`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L286)
* [`riak/bucket/{{bucket}}/key/{{key}}/values`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L557)
* [`riak/ping`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L265)
* [`servers/checks`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L310)
* [`servers/details`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L314)
* [`steering`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/traffic_ops/traffic_ops_golang/routing/routes.go#L568)
## Expected / new behavior:
<!-- Describe what the behavior would be without the bug / how the feature would improve Traffic Control -->
All routes defined in `routes.go` should be documented in the Traffic Ops API documentation.
## Minimal reproduction of the problem with instructions:
<!--
If the current behavior is a bug or you can illustrate your feature request better with an example,
please provide the *STEPS TO REPRODUCE* and include the applicable TC version.
-->
These RST files do not exist yet in the repo:
* [`/docs/source/api/about.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/about.rst)
* [`/docs/source/api/cdns_dnsseckeys_generate.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/cdns_dnsseckeys_generate.rst)
* [`/docs/source/api/deliveryservice_matches.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservice_matches.rst)
* [`/docs/source/api/deliveryservice_request_comments.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservice_request_comments.rst)
* [`/docs/source/api/deliveryservice_requests.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservice_requests.rst)
* [`/docs/source/api/deliveryservice_requests_id_assign.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservice_requests_id_assign.rst)
* [`/docs/source/api/deliveryservice_requests_id_status.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservice_requests_id_status.rst)
* [`/docs/source/api/deliveryservices_id_urlkeys.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservices_id_urlkeys.rst)
* [`/docs/source/api/divisions_name_name.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/divisions_name_name.rst)
* [`/docs/source/api/federations_all.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/federations_all.rst)
* [`/docs/source/api/keys_ping.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/keys_ping.rst)
* [`/docs/source/api/ping.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/ping.rst)
* [`/docs/source/api/regions_name_name.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/regions_name_name.rst)
* [`/docs/source/api/riak_bucket_bucket_key_key_values.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/riak_bucket_bucket_key_key_values.rst)
* [`/docs/source/api/riak_ping.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/riak_ping.rst)
* [`/docs/source/api/servers_checks.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/servers_checks.rst)
* [`/docs/source/api/servers_details.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/servers_details.rst)
* [`/docs/source/api/steering.rst`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/steering.rst)
## Anything else:
<!-- e.g. stacktraces, related issues, suggestions how to fix -->
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] zrhoffman commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574796877
Added them.
Also, that issue also mentions incomplete documentation for [POST `deliveryservices/dnsseckeys/generate`](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC0/docs/source/api/deliveryservices_dnsseckeys_generate.rst). I have been unsuccessful finding any history of references to that route in the project (including TO Perl) except [in the Python TO client](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC1/traffic_control/clients/python/trafficops/tosession.py#L754) and in our documentation. The route itself 404s. Can we just remove that page?
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 edited a comment on issue #4290:
Undocumented Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 edited a comment on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574887662
> _"Updated"_
err, that's not exactly what I meant. I've edited it so things can be checked off
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-579864890
`divisions/name/{{name}}` is deprecated, so it doesn't need docs
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574822024
Based on the routes that _do_ exist and the response example on the `/deliveryservices/dnsseckeys/generate` page:
```json
{
"response": "Successfully created dnssec keys for cdn1"
}
```
I think maybe there was a typo somewhere and that was meant to be `/cdns/dnsseckeys/generate`. So the docs page can get removed, and it looks like you already captured the *actual* undocumented route.
By the way, can you turn your list in the Issue into a checklist, so that items can be checked off as they're done? That way we don't need to make an issue out of each one in order to keep track of what needs to be done.
Also, looks like your bottom list has `/types/{{ID}}` in it twice.
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-573911298
Does this list overlap with #3443?
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] zrhoffman commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574889927
Oops, my update didn't save. It should be good now.
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574887662
> _"Updated"_
err, that's not exactly what I meant. I've edited it so things can be checked off
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574010038
yes, please do. I think that's probably referring to `/types`
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] zrhoffman commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-574884937
> [...] [T]he `/deliveryservices/dnsseckeys/generate` [...] docs page can get removed [...].
Now the issue mentions removing the `deliveryservices/dnsseckeys/generate` page.
> By the way, can you turn your list in the Issue into a checklist, so that items can be checked off as they're done?
Updated.
> Also, looks like your bottom list has /types/{{ID}} in it twice.
Thanks, fixed. In a draft, they were links to the different sections of ATC Read the Docs site.
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ocket8888 commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-573922333
Are the others in that issue no longer undocumented, then?
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] ZugNZwang commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-587929554
`servers/{{ID}}/deliveryservices` is also missing the documentation for the `POST` method
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] zrhoffman commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-573932216
These endpoints are documented:
* POST `roles`
* PUT `roles`
* DELETE `roles`
These endpoints from that issue are listed in this one (and are still undocumented):
* GET `steering`
* GET/POST/PUT/DELETE `deliveryservice_requests`
These endpoints are still undocumented yet unmentioned in this issue:
* DELETE `divisions/{{ID}}`
* DELETE `regions/{{ID}}`
@ocket8888 Should I add those endpoints to this issue so we have a list of undocumented ones in one place?
Not sure which exact endpoints that issue is referring to:
* POST type
* PUT type
* DELETE type
---
Also, I have edited this issue to specify which HTTP methods the mentioned endpoints are defined for.
----------------------------------------------------------------
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
[GitHub] [trafficcontrol] zrhoffman commented on issue #4290: Undocumented
Traffic Ops Golang routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4290: Undocumented Traffic Ops Golang routes
URL: https://github.com/apache/trafficcontrol/issues/4290#issuecomment-573916512
The following routes are also mentioned in #3443:
* GET `steering`
* GET/POST/PUT/DELETE `deliveryservice_requests `
----------------------------------------------------------------
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