Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incorrect method on docs for /cdns/dnsseckeys/refresh in APIv4 #6903

Closed
ocket8888 opened this issue Jun 15, 2022 · 3 comments · Fixed by #7105
Closed

Incorrect method on docs for /cdns/dnsseckeys/refresh in APIv4 #6903

ocket8888 opened this issue Jun 15, 2022 · 3 comments · Fixed by #7105
Assignees
@deepto98
Labels
bug something isn't working as intended documentation related to documentation good first issue first-time committers will find this easy to resolve hacktoberfest low difficulty the estimated level of effort to resolve this issue is low low impact affects only a small portion of a CDN, and cannot itself break one

Comments

@ocket8888
Copy link
Contributor

This Bug Report affects these Traffic Control components:

  • Documentation

Current behavior:

In versions of the Traffic Ops API earlier than 4.0, the only supported request method for /cdns/dnsseckeys/refresh was GET. In APIv4, the method was switched to PUT, but the documentation still lists only the GET method (which no longer works).

Expected behavior:

Documentation should be correct.

Steps to reproduce:

https://traffic-control-cdn.readthedocs.io/en/v6.1.0/api/v4/cdns_dnsseckeys_refresh.html#get
@ocket8888 ocket8888 added bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one good first issue first-time committers will find this easy to resolve low difficulty the estimated level of effort to resolve this issue is low labels Jun 15, 2022
@deepto98
Copy link

Can I pick this up? Is the doc file within this repo itself?

@ocket8888
Copy link
Contributor Author

Yes, it's at docs/source/api/v4/cdns_dnsseckeys_refresh.rst

@deepto98
Copy link

Okay, thanks

@joobisb joobisb mentioned this issue Oct 4, 2022
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@deepto98 deepto98

Labels
bug something isn't working as intended documentation related to documentation good first issue first-time committers will find this easy to resolve hacktoberfest low difficulty the estimated level of effort to resolve this issue is low low impact affects only a small portion of a CDN, and cannot itself break one
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Incorrect method on docs for /cdns/dnsseckeys/refresh in APIv4 and APIv5 joobisb/trafficcontrol
3 participants
@ocket8888 @zrhoffman @deepto98