bito-code-review[bot] commented on code in PR #37943: URL: https://github.com/apache/superset/pull/37943#discussion_r2838664745
########## docs/docs/api.mdx: ########## @@ -528,11 +533,12 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ #### User & System <details> -<summary><strong>Current User</strong> (2 endpoints) — Get information about the currently authenticated user.</summary> +<summary><strong>Current User</strong> (3 endpoints) — Get information about the authenticated user.</summary> | Method | Endpoint | Description | |--------|----------|-------------| | `GET` | [Get the user object](./api/get-the-user-object) | `/api/v1/me/` | +| `PUT` | [Update the current user](./api/update-the-current-user) | `/api/v1/me/` | Review Comment: <div> <div id="suggestion"> <div id="issue"><b>Broken Documentation Links</b></div> <div id="fix"> The added API documentation includes relative links like ./api/update-the-current-user, but the docs/api/ directory does not exist, resulting in broken links. Ensure these documentation files are created or adjust links to match the project's doc structure. </div> </div> <small><i>Code Review Run #5ef092</i></small> </div> --- Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>) - [ ] Yes, avoid them ########## docs/docs/api.mdx: ########## @@ -582,6 +588,60 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ </details> +#### Other + +<details> +<summary><strong>Security Groups</strong> (6 endpoints) — Endpoints related to Security Groups.</summary> + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `GET` | [Get security groups](./api/get-security-groups) | `/api/v1/security/groups/` | +| `POST` | [Create security groups](./api/create-security-groups) | `/api/v1/security/groups/` | +| `GET` | [Get security groups info](./api/get-security-groups-info) | `/api/v1/security/groups/_info` | +| `DELETE` | [Delete security groups by pk](./api/delete-security-groups-by-pk) | `/api/v1/security/groups/{pk}` | +| `GET` | [Get security groups by pk](./api/get-security-groups-by-pk) | `/api/v1/security/groups/{pk}` | +| `PUT` | [Update security groups by pk](./api/update-security-groups-by-pk) | `/api/v1/security/groups/{pk}` | + +</details> + +<details> +<summary><strong>Themes</strong> (14 endpoints) — Manage UI themes for customizing Superset's appearance.</summary> + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `DELETE` | [Bulk delete themes](./api/bulk-delete-themes) | `/api/v1/theme/` | +| `GET` | [Get a list of themes](./api/get-a-list-of-themes) | `/api/v1/theme/` | +| `POST` | [Create a theme](./api/create-a-theme) | `/api/v1/theme/` | +| `GET` | [Get metadata information about this API resource (theme--info)](./api/get-metadata-information-about-this-api-resource-theme-info) | `/api/v1/theme/_info` | +| `DELETE` | [Delete a theme](./api/delete-a-theme) | `/api/v1/theme/{pk}` | +| `GET` | [Get a theme](./api/get-a-theme) | `/api/v1/theme/{pk}` | +| `PUT` | [Update a theme](./api/update-a-theme) | `/api/v1/theme/{pk}` | +| `PUT` | [Set a theme as the system dark theme](./api/set-a-theme-as-the-system-dark-theme) | `/api/v1/theme/{pk}/set_system_dark` | +| `PUT` | [Set a theme as the system default theme](./api/set-a-theme-as-the-system-default-theme) | `/api/v1/theme/{pk}/set_system_default` | +| `GET` | [Download multiple themes as YAML files](./api/download-multiple-themes-as-yaml-files) | `/api/v1/theme/export/` | +| `POST` | [Import themes from a ZIP file](./api/import-themes-from-a-zip-file) | `/api/v1/theme/import/` | +| `GET` | [Get related fields data (theme-related-column-name)](./api/get-related-fields-data-theme-related-column-name) | `/api/v1/theme/related/{column_name}` | +| `DELETE` | [Clear the system dark theme](./api/clear-the-system-dark-theme) | `/api/v1/theme/unset_system_dark` | +| `DELETE` | [Clear the system default theme](./api/clear-the-system-default-theme) | `/api/v1/theme/unset_system_default` | + +</details> + +<details> +<summary><strong>UserRegistrationsRestAPI</strong> (8 endpoints) — Endpoints related to UserRegistrationsRestAPI.</summary> + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `GET` | [Get security user registrations](./api/get-security-user-registrations) | `/api/v1/security/user_registrations/` | +| `POST` | [Create security user registrations](./api/create-security-user-registrations) | `/api/v1/security/user_registrations/` | +| `GET` | [Get security user registrations info](./api/get-security-user-registrations-info) | `/api/v1/security/user_registrations/_info` | +| `DELETE` | [Delete security user registrations by pk](./api/delete-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `GET` | [Get security user registrations by pk](./api/get-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `PUT` | [Update security user registrations by pk](./api/update-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `GET` | [Get distinct values from field data (security-user-registrations-distinct-column-name)](./api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name) | `/api/v1/security/user_registrations/distinct/{column_name}` | +| `GET` | [Get related fields data (security-user-registrations-related-column-name)](./api/get-related-fields-data-security-user-registrations-related-column-name) | `/api/v1/security/user_registrations/related/{column_name}` | + +</details> + --- ### Additional Resources Review Comment: <div> <div id="suggestion"> <div id="issue"><b>Broken API doc links and description typos</b></div> <div id="fix"> The new API documentation sections for Security Groups, Themes, and UserRegistrationsRestAPI include links to ./api/ files that do not exist in the repository, resulting in broken links that will confuse users. Additionally, there are typos such as double spaces in 'groups info' and 'registrations info', and a double dash in '(theme--info)' which should be '(theme-info)'. The descriptions for the _info endpoints are inconsistent in wording and capitalization compared to existing patterns. </div> </div> <small><i>Code Review Run #3479c9</i></small> </div><div> <div id="suggestion"> <div id="issue"><b>Non-existent API Documentation</b></div> <div id="fix"> The documentation adds a Security Groups API section with 6 endpoints under /api/v1/security/groups/, but no such API exists in the codebase. This could confuse users expecting these endpoints. Remove this section unless the API is implemented. </div> </div> <small><i>Code Review Run #5ef092</i></small> </div> --- Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>) - [ ] Yes, avoid them -- 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]
