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

Documentation for cdns/{{name}}/federations is missing a property #6947

Closed
ocket8888 opened this issue Jul 8, 2022 · 2 comments · Fixed by #7112
Closed

Documentation for cdns/{{name}}/federations is missing a property #6947

ocket8888 opened this issue Jul 8, 2022 · 2 comments · Fixed by #7112
Assignees
@everly-gif
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:

Current behavior:

The Response Structure section of the documentation for /cdns/{{name}}/federations doesn't include a description of the id property, which can nevertheless be seen in the Response Example.

Expected behavior:

Documentation should be accurate.

Steps to reproduce:

  1. 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 Jul 8, 2022
@everly-gif
Copy link
Contributor

Hi, I would like to work on this issue, please assign it to me.

@everly-gif everly-gif mentioned this issue Oct 7, 2022
Merged
4 tasks
@everly-gif
Copy link
Contributor

Made PR #7112 please have a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@everly-gif everly-gif

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.

fix : Documentation for cdns/{{name}}/federations is missing a property everly-gif/trafficcontrol
3 participants
@ocket8888 @zrhoffman @everly-gif