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.

Sign up for GitHub

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

Jump to bottom

Restructure the API #342

Open
4 of 14 tasks
byewokko opened this issue Feb 9, 2024 · 0 comments
Open
4 of 14 tasks

Restructure the API #342

byewokko opened this issue Feb 9, 2024 · 0 comments
Assignees
@byewokko
Labels
enhancement New feature or request

Comments

@byewokko
Copy link
Collaborator

byewokko commented Feb 9, 2024 •
edited
Loading

Proposed changes

  • Public web container will not contain any endpoints that require authenticated access. Those must be placed in the private web container only.
  • All endpoints contained in the public container will also be included in the private container with the same authorization.
  • Replace dots and underscores in path names with a dash -
    • e.g. /public/login-prologue instead of /public/login.prologue
  • Organize all endpoints into meaningful categories (e.g. admin|account|public|openidconnect) that will be reflected in their path prefix.
    • User account management endpoint paths must start with /account/ (Add new "/account"- prefixed paths for account management endpoints #343)
    • Admin endpoint paths must start with /admin/
    • Login-related endpoint paths must start with /public/
    • Internal Nginx utility endpoint paths must start with /nginx/
    • OAuth and OpenID Connect endpoint paths must start with /openidconnect/
    • Apart from those, there are ASAB API endpoints, ASAB (Swagger) endpoints and well-known endpoints
    • Verify that every endpoint falls under one of these categories
    • Remove the old endpoints that have been renamed
  • Update Nginx configs
  • Update documentation

Complete table of proposed path changes

seacat-auth-endpoints-rev-2024-02.ods
@byewokko byewokko added the enhancement New feature or request label Feb 9, 2024
@byewokko byewokko self-assigned this Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@byewokko byewokko

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@byewokko