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

Added deprecation notices for /user/current/update#3954

Merged
mitchell852 merged 3 commits into
apache:masterfrom
ocket8888:user-current-update-deprecation
Oct 14, 2019
Merged

Added deprecation notices for /user/current/update#3954
mitchell852 merged 3 commits into
apache:masterfrom
ocket8888:user-current-update-deprecation

Conversation

@ocket8888

Copy link
Copy Markdown
Contributor

What does this PR (Pull Request) do?

  • This PR is not related to any Issue

Adds deprecation notices for the /user/current/update to all responses from that endpoint as well as to the documentation.

Which Traffic Control components are affected by this PR?

  • Documentation
  • Traffic Ops

What is the best way to verify this PR?

Make requests to the /user/current/update endpoint and notice the new warning-level alert indicating its deprecation.
Also, build and read the documentation.

The following criteria are ALL met by this PR

  • This PR includes tests OR I have explained why tests are unnecessary
  • This PR includes documentation OR I have explained why documentation is unnecessary
  • This PR includes an update to CHANGELOG.md OR such an update is not necessary
  • This PR includes any and all required license headers
  • This PR ensures that database migration sequence is correct OR this PR does not include a database migration
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY (see the Apache Software Foundation's security guidelines for details)

@ocket8888 ocket8888 added Traffic Ops related to Traffic Ops documentation related to documentation tech debt rework due to choosing easy/limited solution labels Oct 3, 2019
@asf-ci

asf-ci commented Oct 3, 2019

Copy link
Copy Markdown
Contributor

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

Comment thread traffic_ops/app/lib/API/User.pm Outdated
Comment thread traffic_ops/app/lib/MojoPlugins/Response.pm Outdated

@mhoppa mhoppa left a comment

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.

I am getting this result when running it

{
    "alerts": [
        [
            {
                "level": "success",
                "text": "User profile was successfully updated"
            }
        ],
        {
            "level": "warning",
            "text": "This endpoint is deprecated, please use 'PUT /api/1.4/user/current' instead"
        }
    ]
}

The deprecation object should be in the alert list

@ocket8888

ocket8888 commented Oct 9, 2019

Copy link
Copy Markdown
Contributor Author

Well, actually, it is. The success message is in a sub-list for some reason.

I'll try to figure out why it's doing that.

@ocket8888
ocket8888 force-pushed the user-current-update-deprecation branch from 442f1b4 to 61ae113 Compare October 10, 2019 02:02
@ocket8888

ocket8888 commented Oct 10, 2019

Copy link
Copy Markdown
Contributor Author

This took hours to figure out. Turns out, [ is VERY different from ( in Perl.

@asf-ci

asf-ci commented Oct 10, 2019

Copy link
Copy Markdown
Contributor

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

@mhoppa mhoppa mentioned this pull request Oct 10, 2019
6 tasks
Comment thread infrastructure/cdn-in-a-box/traffic_ops/Dockerfile Outdated

@mhoppa mhoppa left a comment

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.

Works as expected. Looks like an accidental docker change came in so need to revert that.

@ocket8888
ocket8888 force-pushed the user-current-update-deprecation branch from 61ae113 to 75821e8 Compare October 11, 2019 16:05
@asf-ci

asf-ci commented Oct 11, 2019

Copy link
Copy Markdown
Contributor

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

@mitchell852
mitchell852 merged commit 98604f9 into apache:master Oct 14, 2019
@ocket8888
ocket8888 deleted the user-current-update-deprecation branch October 14, 2019 17:13
@mhoppa mhoppa mentioned this pull request Feb 4, 2020
1 task
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation related to documentation tech debt rework due to choosing easy/limited solution Traffic Ops related to Traffic Ops

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants