Cachegroup fallbacks deprecation by ocket8888 · Pull Request #3766 · apache/trafficcontrol

ocket8888 · 2019-08-01T14:54:45Z

What does this PR (Pull Request) do?

This PR is not related to any Issue

Adds a deprecation notice to the cachegroup_fallbacks TO API endpoint documentation, as discussed in the dev mailing list. Also added missing documentation for the fallbacks property of API request/response payloads to/from the cachegroups and cachegroups/{{ID}} endpoints. Plus I did a little cleaning up of unnamed footnotes and unnecessary escape sequences.

Which Traffic Control components are affected by this PR?

Documentation

What is the best way to verify this PR?

Build and read the documentation.

The following criteria are ALL met by this PR

Tests are unnecessary
This PR includes documentation
This PR includes an update to CHANGELOG.md
This PR includes any and all required license headers
This PR does not include a database migration
This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY

asfgit · 2019-08-01T15:33:22Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4075/
Test PASSed.

asf-ci · 2019-10-05T02:29:51Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4403/

mhoppa

The cachegroup_fallbacks endpoints should have a deprecation message added to its response

discussed on the mailing list: https://lists.apache.org/thread.html/77d4793eed8ed0143ac33554278b0b41dc23f15de18f854120fe2b92@%3Cdev.trafficcontrol.apache.org%3E

ocket8888 · 2019-10-11T23:41:33Z

The cachegroup_fallbacks endpoints should have a deprecation message added to its response

done.

asf-ci · 2019-10-12T03:12:35Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4477/

ocket8888 · 2019-10-12T08:00:38Z

retest this please

asf-ci · 2019-10-12T08:02:17Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4480/

ocket8888 · 2019-10-13T00:26:05Z

retest this please

asf-ci · 2019-10-13T00:58:45Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4484/

mhoppa

This looks good - can you fix the merge conflicts and then I will pull down and test it locally for approval

asf-ci · 2019-10-15T16:18:06Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4518/

ocket8888 · 2019-10-15T16:30:04Z

retest this please

asf-ci · 2019-10-15T16:32:46Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4521/

ocket8888 · 2019-10-15T17:40:46Z

retest this please

asf-ci · 2019-10-15T17:42:54Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4525/

mhoppa

tested locally and deprecation message looks good and returns on CRUD to cachegroup_fallbacks endpoint

ocket8888 · 2019-10-15T18:34:44Z

retest this please

asf-ci · 2019-10-15T18:49:35Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4527/

mitchell852 added the documentation related to documentation label Aug 1, 2019

ocket8888 force-pushed the cachegroup_fallbacks-deprecation branch from 9565464 to ce555cd Compare October 4, 2019 23:26

mhoppa suggested changes Oct 9, 2019

View reviewed changes

Comment thread docs/source/api/cachegroup_fallbacks.rst Outdated

Comment thread docs/source/api/cachegroups.rst Outdated

mhoppa mentioned this pull request Oct 10, 2019

Deprecate /capabilities/{{name}} #3880

Merged

6 tasks

ocket8888 added 4 commits October 11, 2019 17:40

Added deprecation notice for cachegroup_fallbacks

bf14918

discussed on the mailing list: https://lists.apache.org/thread.html/77d4793eed8ed0143ac33554278b0b41dc23f15de18f854120fe2b92@%3Cdev.trafficcontrol.apache.org%3E

fixed missing documentation for 'fallbacks' array

bb0ad05

added deprecation section to CHANGELOG

9992d94

add deprecation warning alerts to API responses

55d1375

ocket8888 force-pushed the cachegroup_fallbacks-deprecation branch from ce555cd to 55d1375 Compare October 11, 2019 23:40

mhoppa reviewed Oct 15, 2019

View reviewed changes

Merge branch 'master' into cachegroup_fallbacks-deprecation

ec5fe60

mhoppa approved these changes Oct 15, 2019

View reviewed changes

rawlinp added Traffic Ops related to Traffic Ops tech debt rework due to choosing easy/limited solution labels Oct 15, 2019

rawlinp merged commit 9af4d49 into apache:master Oct 15, 2019

ocket8888 deleted the cachegroup_fallbacks-deprecation branch October 15, 2019 19:12

mhoppa mentioned this pull request Jan 29, 2020

Rewrite /cachegroup_fallbacks to Go #3848

Closed

4 tasks

Uh oh!

Conversation

ocket8888 commented Aug 1, 2019

What does this PR (Pull Request) do?

Which Traffic Control components are affected by this PR?

What is the best way to verify this PR?

The following criteria are ALL met by this PR

Uh oh!

asfgit commented Aug 1, 2019

Uh oh!

asf-ci commented Oct 5, 2019

Uh oh!

mhoppa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ocket8888 commented Oct 11, 2019

Uh oh!

asf-ci commented Oct 12, 2019

Uh oh!

ocket8888 commented Oct 12, 2019

Uh oh!

asf-ci commented Oct 12, 2019

Uh oh!

ocket8888 commented Oct 13, 2019

Uh oh!

asf-ci commented Oct 13, 2019

Uh oh!

mhoppa left a comment

Choose a reason for hiding this comment

Uh oh!

asf-ci commented Oct 15, 2019

Uh oh!

ocket8888 commented Oct 15, 2019

Uh oh!

asf-ci commented Oct 15, 2019

Uh oh!

ocket8888 commented Oct 15, 2019

Uh oh!

asf-ci commented Oct 15, 2019

Uh oh!

mhoppa left a comment

Choose a reason for hiding this comment

Uh oh!

ocket8888 commented Oct 15, 2019

Uh oh!

asf-ci commented Oct 15, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants