Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Incorrect response structure documentation for jobs#7262

Merged
ocket8888 merged 1 commit intoapache:masterfrom
joobisb:fix/jobs-doc
Jan 3, 2023
Merged

Incorrect response structure documentation for jobs#7262
ocket8888 merged 1 commit intoapache:masterfrom
joobisb:fix/jobs-doc

Conversation

@joobisb
Copy link
Copy Markdown
Contributor

@joobisb joobisb commented Jan 2, 2023

Closes: #7246


Which Traffic Control components are affected by this PR?

  • Documentation

What is the best way to verify this PR?

  1. Goto /api/v4/jobs.html and /api/v5/jobs.html in the docs.
  2. Response structure documentation aligns with the response sample.

If this is a bugfix, which Traffic Control versions contained the bug?

  • master

PR submission checklist

@ocket8888 ocket8888 self-assigned this Jan 3, 2023
@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 labels Jan 3, 2023
Comment thread CHANGELOG.md
- [#7120](https://github.com/apache/trafficcontrol/pull/7120) *Docs* Update t3c documentation regarding parent.config parent_retry.

### Fixed
- [#7246](https://github.com/apache/trafficcontrol/issues/7246) *Docs* Fixed docs for /jobs response description in APIv4 and APIv5.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically you didn't need to mention APIv5 since that's not released and therefore won't actually be "changed" in whatever release does include this fix, but it's not hurting anything.

@ocket8888 ocket8888 merged commit 2b9827b into apache:master Jan 3, 2023
@asf-ci asf-ci mentioned this pull request Feb 1, 2023
4 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect Response Structure documentation for Jobs

2 participants