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

APIv4 and v5 docs still list id as a property of Roles, despite being removed in v4. #7225

Closed
ocket8888 opened this issue Nov 29, 2022 · 0 comments · Fixed by #7265
Closed

APIv4 and v5 docs still list id as a property of Roles, despite being removed in v4. #7225

ocket8888 opened this issue Nov 29, 2022 · 0 comments · Fixed by #7265
Labels
bug something isn't working as intended documentation related to documentation 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 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:

The docs for the /roles endpoint of API versions 4 and 5 still list in their response structure descriptions an id property, which no longer exists in those versions in reality.

Expected behavior:

Docs should be correct.

Steps to reproduce:

Read the docs.
@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 Nov 29, 2022
@joobisb joobisb mentioned this issue Jan 4, 2023
Merged
4 tasks
@asf-ci asf-ci mentioned this issue Feb 1, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug something isn't working as intended documentation related to documentation 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 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.

Fixed docs for roles and cdn locks description joobisb/trafficcontrol
1 participant
@ocket8888