lasdf1234 opened a new issue, #11259:
URL: https://github.com/apache/gravitino/issues/11259
### What would you like to be improved?
The `idp-basic` plugin exposes built-in IdP REST APIs under `/api/idp/users`
and `/api/idp/groups` (see design doc
`design-docs/gravitino-local-authentication.md` and implementation in
`plugins/idp-basic`). The Gravitino REST OpenAPI specification under
`docs/open-api/` does not yet document these endpoints, so API consumers and
reviewers cannot discover request/response shapes from the published spec.
### How should we improve?
Add OpenAPI definitions for the IdP endpoints in a dedicated file under
`docs/open-api/idp/` (for example `idp.yaml`) and register the paths in
`docs/open-api/openapi.yaml`, following the same pattern as other API modules
(`users.yaml`, `authn.yaml`, etc.). The spec should cover:
- User APIs: `POST/GET/PUT/DELETE /idp/users` and `/idp/users/{user}`
- Group APIs: `POST/GET/DELETE /idp/groups` and `/idp/groups/{group}`
- Group membership: `PUT /idp/groups/{group}/users` with `usersToAdd` /
`usersToRemove`
Ensure `./gradlew :docs:build` (Redocly lint) passes.
**Target branch:** `main`
--
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]
