docs(influxdb3): document 3.10 Enterprise backup/restore, import, user management, and concurrency API#7362
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jstirnaman
force-pushed
the
influxdb3-3.10-api-spec
branch
from
bfc2062 to
a23c339
Compare
- Core: `--max-concurrent-queries` sets the maximum number of concurrent queries at server startup. - Enterprise: adjust the limit at runtime with `GET`/`PUT`/`DELETE` `/api/v3/configure/query_concurrency_limit`.
…, user management, and query-concurrency API Add OpenAPI reference documentation for InfluxDB 3 Enterprise v3.10 endpoints: - Backup and restore: create, cancel, list, get, and delete backups; create, list, get, and cancel restores. - Bulk import: upload Parquet files and list import statuses. - User management: update and delete users, get and replace user roles, require a password reset, and look up a user by OAuth ID. - Roles: get a role by name and get a role's permissions. - Row deletion: abort a pending row-delete request. - Query concurrency: read, set, and reset the runtime query-concurrency limit. All endpoints are Enterprise-only. Changes are additive; existing content is unchanged.
jstirnaman
force-pushed
the
influxdb3-3.10-api-spec
branch
from
a23c339 to
a4c0279
Compare
Vale Style Check Results
✅ Check passed |
jstirnaman
force-pushed
the
influxdb3-3.10-query-concurrency-api
branch
from
d6929ea to
036dfb8
Compare
|
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
peterbarnett03
left a comment
peterbarnett03
left a comment
There was a problem hiding this comment.
Made some small permission and engine changes, otherwise LGMT
abshierjoel
left a comment
abshierjoel
left a comment
There was a problem hiding this comment.
I took a look over the endpoints relating to users and roles and had a few comments. The main 2 things I think are exposing the users-by-oauth endpoint and using account to refer to a user.
| Returns the role with the specified name. | ||
|
|
||
|
|
||
| Requires a token or user with permission to read roles. |
There was a problem hiding this comment.
It's probably worth noting that for the role endpoints that all users have access to list/read roles, regardless of which roles that user has.
| display name can be updated. | ||
|
|
||
|
|
||
| Requires a token or user with permission to update users. |
There was a problem hiding this comment.
This may be a bit pedantic, since this format used for this spec, "user with permission to...", is probably clear enough, but it may be worth clarifying that users don't directly have permissions, rather, they have roles and the user's permissions are a union of the permissions of their roles. So maybe something like "a user whose roles have permission to update users".
| Lists all roles assigned to the specified user. | ||
|
|
||
|
|
||
| Requires a token or user with permission to read users. |
There was a problem hiding this comment.
Repeating myself just to identify the other place: It's probably worth noting that for the role endpoints that all users have access to list/read roles, regardless of which roles that user has.
| /api/v3/users_by_oauth_id/{oauth_id}: | ||
| get: | ||
| operationId: get_user_by_oauth_id | ||
| summary: Get a user by OAuth identity-provider ID | ||
| description: >- | ||
| Returns the user associated with the specified OAuth identity-provider | ||
| ID. Requires the server to be configured with an OAuth validator. | ||
|
|
||
|
|
||
| Requires a token or user with permission to read users. | ||
|
|
||
|
|
||
| This endpoint is only available in InfluxDB 3 Enterprise. User | ||
| authentication is a preview feature enabled by setting | ||
| `--without-user-auth false`. | ||
| x-enterprise-only: true | ||
| parameters: | ||
| - name: oauth_id | ||
| in: path | ||
| required: true | ||
| description: The OAuth identity-provider ID of the user. | ||
| schema: | ||
| type: string | ||
| responses: | ||
| "200": | ||
| description: Success. Returns the matching user. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "#/components/schemas/UserResponse" | ||
| "401": | ||
| $ref: "#/components/responses/Unauthorized" | ||
| "403": | ||
| $ref: "#/components/responses/Forbidden" | ||
| "404": | ||
| description: >- | ||
| Not found. No user matches the specified OAuth ID, or OAuth is not | ||
| configured on the server. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "#/components/schemas/ErrorMessage" | ||
| tags: | ||
| - User management |
There was a problem hiding this comment.
I don't think it's a bad thing to have this in the spec, since it's an endpoint we're exposing. But OTOH the real consumer of this is our own CLI, so I think it may make sense to not expose this in the spec to customers, unless there's a feature ask for it.
There was a problem hiding this comment.
Thanks! I wasn't sure if this was meant to be user-facing or not.
Co-authored-by: Joel Abshier <31899323+abshierjoel@users.noreply.github.com>
Co-authored-by: Joel Abshier <31899323+abshierjoel@users.noreply.github.com>
jstirnaman
changed the base branch from
influxdb3-3.10-query-concurrency-api
to
master
github-actions
Bot
added
product:shared
3 participants
Part of the InfluxDB 3.10 documentation updates (stacked on #7360).
Adds OpenAPI reference documentation for InfluxDB 3 Enterprise v3.10 endpoints:
All endpoints are Enterprise-only. Changes are additive — existing spec content is unchanged.
Preview URLs: