Skip to content

Restructure the API #342

@byewokko

Description

@byewokko

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions