Ragnaroos commented on PR #66690:
URL: https://github.com/apache/doris/pull/66690#issuecomment-5351264345
## FE endpoints used by the UI
Enumerated from `ui/src/api/**` on the current head, split by whether the
endpoint is added here or reused from existing Doris controllers.
### Added by this PR
| Endpoint | Method | Purpose |
| --- | --- | --- |
| `/rest/v1/ui/me` | GET | Bootstrap after login: current ADMIN user and
CSRF token (`UiSessionController`) |
| `/rest/v1/sql-sessions` | POST | Create a Web SQL session
(`WebSqlSessionController`) |
| `/rest/v1/sql-sessions/{id}` | GET, DELETE | Inspect and close a session |
| `/rest/v1/sql-sessions/{id}/statements` | POST | Execute exactly one
statement |
| `/rest/v1/sql-sessions/{id}/cancel` | POST | Cancel the running statement |
| `/rest/v1/sql-sessions/{id}/reset` | POST | Reset the connection state |
| `/rest/v1/hardware_info/fe/version` | GET | Version-only route on the
existing `HardwareInfoController`, so Home does not trigger OSHI hardware
collection |
### Reused, no new controller
| Endpoint | Method | Page | Controller |
| --- | --- | --- | --- |
| `/rest/v1/login` | POST | Login | `WebConfigurer` |
| `/rest/v1/logout` | POST | Sign out | `WebConfigurer` |
| `/rest/v1/system?path=/frontends` | GET | Cluster Overview, Frontends |
`SystemController` |
| `/rest/v1/system?path=/backends` | GET | Cluster Overview, Backends |
`SystemController` |
| `/rest/v1/system?path=...` | GET | Proc System navigation |
`SystemController` |
| `/rest/v1/session` | GET | Sessions | `SessionController` |
| `/rest/v1/log` | GET | Log configuration and contents | `LogController` |
| `/rest/v1/log` | POST | Add or delete a verbose logger, sent as the legacy
`add_verbose` / `del_verbose` form parameters | `LogController` |
| `/rest/v1/query_profile` | GET | Query Profile list | `QueryProfileAction`
|
| `/rest/v1/query_profile/text/{queryId}` | GET | Raw profile text, shared
by the Text and Visual tabs | `QueryProfileAction` |
| `/rest/v2/manager/node/configuration_info?type={fe\|be}` | POST |
Configuration read | `NodeAction` |
| `/rest/v2/manager/node/set_config/{fe\|be}` | POST | Configuration update,
ADMIN only | `NodeAction` |
### Authentication
`/rest/v1/ui/**` and `/rest/v1/sql-sessions**` go through `uiRequest`, which
requires the login cookie and sends the CSRF header on mutations. Everything
else goes through `legacyRequest` and keeps the existing cookie
authorization.
Web SQL additionally accepts HTTP Basic. All of them require global `ADMIN`.
`/rest/v1/ui/example` appears only in unit tests, and `/rest/v1/ui/` is a
prefix test inside `ui/src/api/client.ts`; neither is a real endpoint.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
