[PR] docs: document the auth status, password change and run speed endpoints [rocketmq-dashboard]

["Frun1na (via GitHub)" <gi...@apache.org>]

Frun1na opened a new pull request, #4830:
URL: https://github.com/apache/rocketmq-dashboard/pull/4830

   ### Which Issue(s) This PR Fixes
   
   - Fixes #ISSUE_ID
   
   ### Brief Description
   
   Three standalone endpoints were missing from `docs/api-spec.md`:
   
   - **1.3 `GET /api/auth/status`** (`AuthController:48`): the login policy and current user probe —
     `AuthStatusVO` is `{loginRequired, authenticated, user}` where `loginRequired` combines the
     deployment property and the general settings' `requireLogin`, and the response carries
     `Cache-Control: no-store`.
   - **1.4 `POST /api/auth/password`** (`AuthController:94`): change the current user's password;
     `ChangePasswordDTO` requires `currentPassword` and `newPassword`, the endpoint answers 401 when
     unauthenticated and 503 when Studio user management is not initialized.
   - **15.14 `POST /api/ai/runs/:runId/speed`** (`AiConversationController:304`): persists the
     client-measured generation speed (`ReportRunSpeedDTO.tokensPerSecond`, `@NotNull @DecimalMin("0.0")`)
     so a replayed transcript shows the same number; a run owned by somebody else is treated as absent.
   
   Three rows (108-110) were appended to the quick reference. Together with #4827 the quick reference now
   covers 110 documented endpoints.
   
   ### How Did You Test This Change
   
   Documentation-only change; there is no docs build or spec validation to run. Every endpoint path,
   parameter, requiredness and response field was read back from `AuthController`, `AuthStatusVO`,
   `ChangePasswordDTO`, `AiConversationController` and `ReportRunSpeedDTO` before being written down.
   


-- 
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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: document the auth status, password change and run speed endpoints [rocketmq-dashboard]

["Frun1na (via GitHub)" <gi...@apache.org>]

Frun1na commented on PR #4830:
URL: https://github.com/apache/rocketmq-dashboard/pull/4830#issuecomment-5770078072

   Consolidating the undocumented-endpoints documentation into #4835 (this branch's sections and quick-reference rows are included there), so the specification changes land as one reviewable unit.


-- 
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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: document the auth status, password change and run speed endpoints [rocketmq-dashboard]

["Frun1na (via GitHub)" <gi...@apache.org>]

Frun1na closed pull request #4830: docs: document the auth status, password change and run speed endpoints
URL: https://github.com/apache/rocketmq-dashboard/pull/4830


-- 
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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org