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

Prevent RequestedName field from being returned in Topologies and Ser…#6970

Merged
ocket8888 merged 2 commits intoapache:masterfrom
tcfdev:fix/6792_ext-field-SC-Top
Jul 18, 2022
Merged

Prevent RequestedName field from being returned in Topologies and Ser…#6970
ocket8888 merged 2 commits intoapache:masterfrom
tcfdev:fix/6792_ext-field-SC-Top

Conversation

@tcfdev
Copy link
Copy Markdown
Collaborator

@tcfdev tcfdev commented Jul 15, 2022

Closes: #6792

The same field (RequestedName) was added to the structs in use with the Topology and Server Capability endpoints. This field is undocumented in it's response and should not be returned in POST or PUT responses (or any such http verbs). This fix simply prevents the response from returning said fields to match expected behavior and documentation.

Additionally, a small edit was made to the documentation to remove an incorrect part of the URL.


Which Traffic Control components are affected by this PR?

  • Documentation
  • Traffic Ops

What is the best way to verify this PR?

Verify that POST and PUT responses do not contain the RequestedName field in the JSON response.

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

PR submission checklist

@tcfdev tcfdev marked this pull request as ready for review July 15, 2022 20:50
@ocket8888 ocket8888 added Traffic Ops related to Traffic Ops low impact affects only a small portion of a CDN, and cannot itself break one regression bug a bug in existing functionality introduced by a new version labels Jul 15, 2022
@ocket8888 ocket8888 self-assigned this Jul 15, 2022
Copy link
Copy Markdown
Contributor

@ocket8888 ocket8888 left a comment

Choose a reason for hiding this comment

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

Confirmed that the extra field is no longer present in responses

@ocket8888 ocket8888 merged commit a109b37 into apache:master Jul 18, 2022
@asf-ci asf-ci mentioned this pull request Aug 1, 2022
4 tasks
zrhoffman pushed a commit to zrhoffman/trafficcontrol that referenced this pull request Oct 2, 2022
…ver Capability responses (apache#6970)

Co-authored-by: Taylor Frey <taylor_frey@comcast.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

low impact affects only a small portion of a CDN, and cannot itself break one regression bug a bug in existing functionality introduced by a new version Traffic Ops related to Traffic Ops

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Extraneous field erroneously included in Server Capability and Topology creation/modification responses

2 participants