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

Conversation

@Rohith-Raju
Copy link
Contributor

Closes: #7326

Documentation changes for user registration endpoint role property. In APIv4 and later, Roles don't have IDs and use names as their primary identifiers. The /users/register endpoint was updated accordingly, and the role property should actually be a Role's name, not its ID.


Which Traffic Control components are affected by this PR?

  • Documentation

What is the best way to verify this PR?

  • Build Docs

PR submission checklist

Signed-off-by: Rohith-Raju <rohithraju488@gmail.com>
Copy link
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.

Updating the example is necessary, and good, but the actual description of the property under "Response Structure" for the PUT method. It currently reads:

"The integral, unique identifier of the highest permission Role which will be permitted to the user..."

but actually, it's not an integer anymore, it's a name

@Rohith-Raju
Copy link
Contributor Author

@ocket8888 can I change it to

"A name, unique identifier of the highest permission Role which will be permitted to the user.."

@ocket8888
Copy link
Contributor

I think instead you should change it to

"The name of the Role which will be given to the user..."

The bit about "permission level" refers to a legacy concept from the same era as the integral, unique IDs which has likewise been eliminated.

Signed-off-by: Rohith-Raju <rohithraju488@gmail.com>
@Rohith-Raju Rohith-Raju requested a review from ocket8888 March 13, 2023 05:03
Signed-off-by: Rohith-Raju <rohithraju488@gmail.com>
@Rohith-Raju Rohith-Raju requested a review from ocket8888 March 14, 2023 06:31
@ocket8888 ocket8888 merged commit 88d38c5 into apache:master Mar 14, 2023
@Rohith-Raju Rohith-Raju deleted the Doc-changes branch March 15, 2023 05:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs for user registration endpoint have incorrect property

2 participants