Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Admin APIs for Roles #107

Open
mikelax opened this issue Jun 14, 2024 · 0 comments
Open

Implement Admin APIs for Roles #107

mikelax opened this issue Jun 14, 2024 · 0 comments
Labels
component: admin Administration related functionality enhancement New feature or request

Comments

@mikelax
Copy link
Collaborator

mikelax commented Jun 14, 2024

Feature Overview

Is your feature request related to a problem? Please describe.
As an admin usher user, I would like to have APIs available to manage Roles. Some of the APIs are already implemented, this issue should complete the missing APIs.

API Design

Status URL Auth Params Notes
TODO PATCH /roles/:role_key bearerAdminAuth name and/or description: body Update Role attributes
TODO DELETE /roles/:role_key bearerAdminAuth role key: path, required Delete a Role

Implementation Notes

  • The source files should be placed in the src/api_endpoints/roles folder.
  • Move the existing endpoint_roles.js file from the api_endpoints folder to api_endpoints/roles and also rename the file. This will also require updating the open api spec x-swagger-router-controller.
  • Refactor the createRole function to handle and return errors like all newer APIs.

Questions

@mikelax mikelax added enhancement New feature or request component: admin Administration related functionality labels Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: admin Administration related functionality enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant