Update system health API docs to clarify authentication requirements (#34086)
Some checks are pending
API / build (push) Waiting to run
Server CI / Compute Go Version (push) Waiting to run
Server CI / Check mocks (push) Blocked by required conditions
Server CI / Check go mod tidy (push) Blocked by required conditions
Server CI / check-style (push) Blocked by required conditions
Server CI / Check serialization methods for hot structs (push) Blocked by required conditions
Server CI / Vet API (push) Blocked by required conditions
Server CI / Check migration files (push) Blocked by required conditions
Server CI / Generate email templates (push) Blocked by required conditions
Server CI / Check store layers (push) Blocked by required conditions
Server CI / Check mmctl docs (push) Blocked by required conditions
Server CI / Postgres with binary parameters (push) Blocked by required conditions
Server CI / Postgres (push) Blocked by required conditions
Server CI / Postgres (FIPS) (push) Blocked by required conditions
Server CI / Generate Test Coverage (push) Blocked by required conditions
Server CI / Run mmctl tests (push) Blocked by required conditions
Server CI / Run mmctl tests (FIPS) (push) Blocked by required conditions
Server CI / Build mattermost server app (push) Blocked by required conditions
Web App CI / check-lint (push) Waiting to run
Web App CI / check-i18n (push) Waiting to run
Web App CI / check-types (push) Waiting to run
Web App CI / test (push) Waiting to run
Web App CI / build (push) Waiting to run

Clarified that authentication is not required for the /api/v4/system/ping
endpoint. Documented three response scenarios:
- Basic response (no auth, no parameters)
- Enhanced response with get_server_status=true (no auth required)
- Admin response with get_server_status=true and manage_system permission

Fixes MM-66073
This commit is contained in:
Jesse Hallam 2025-10-14 13:50:25 -03:00 committed by GitHub
parent c3c292f8de
commit 144face19f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -54,12 +54,30 @@
##### Permissions
None.
None. Authentication is not required for this endpoint.
##### Response Details
The response varies based on query parameters and authentication:
- **Basic response** (no parameters): Returns basic server information including
`status`, mobile app versions, and active search backend.
- **Enhanced response** (`get_server_status=true`): Additionally returns
`database_status` and `filestore_status` to verify backend connectivity.
Authentication is not required.
- **Admin response** (`get_server_status=true` with `manage_system` permission):
Additionally returns `root_status` indicating whether the server is running as root.
Requires authentication with `manage_system` permission.
operationId: GetPing
parameters:
- name: get_server_status
in: query
description: Check the status of the database and file storage as well
description: >
Check the status of the database and file storage as well.
When true, adds `database_status` and `filestore_status` to the response.
If authenticated with `manage_system` permission, also adds `root_status`.
required: false
schema:
type: boolean