bito-code-review[bot] commented on code in PR #38486:
URL: https://github.com/apache/superset/pull/38486#discussion_r2899246586
##########
docs/developer_docs/api.mdx:
##########
@@ -68,14 +68,14 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
| `POST` | [Create a new dashboard](./api/create-a-new-dashboard) |
`/api/v1/dashboard/` |
| `GET` | [Get metadata information about this API resource
(dashboard--info)](./api/get-metadata-information-about-this-api-resource-dashboard-info)
| `/api/v1/dashboard/_info` |
| `GET` | [Get a dashboard detail
information](./api/get-a-dashboard-detail-information) |
`/api/v1/dashboard/{id_or_slug}` |
-| `GET` | [Get a dashboard's chart
definitions.](./api/get-a-dashboard-s-chart-definitions) |
`/api/v1/dashboard/{id_or_slug}/charts` |
+| `GET` | [Get a dashboard's chart
definitions.](./api/get-a-dashboards-chart-definitions) |
`/api/v1/dashboard/{id_or_slug}/charts` |
| `POST` | [Create a copy of an existing
dashboard](./api/create-a-copy-of-an-existing-dashboard) |
`/api/v1/dashboard/{id_or_slug}/copy/` |
-| `GET` | [Get dashboard's datasets](./api/get-dashboard-s-datasets) |
`/api/v1/dashboard/{id_or_slug}/datasets` |
-| `DELETE` | [Delete a dashboard's embedded
configuration](./api/delete-a-dashboard-s-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
-| `GET` | [Get the dashboard's embedded
configuration](./api/get-the-dashboard-s-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
-| `POST` | [Set a dashboard's embedded
configuration](./api/set-a-dashboard-s-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
+| `GET` | [Get dashboard's datasets](./api/get-dashboards-datasets) |
`/api/v1/dashboard/{id_or_slug}/datasets` |
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Grammatical error in possessive form</b></div>
<div id="fix">
The change from 'Get dashboard's datasets' to 'Get dashboards datasets' is
grammatically incorrect. The possessive form 'dashboard's' indicates ownership,
which 'dashboards' does not. Revert to maintain correct English in API
descriptions.
</div>
<details>
<summary>
<b>Code suggestion</b>
</summary>
<blockquote>Check the AI-generated fix before applying</blockquote>
<div id="code">
```
-| `GET` | [Get dashboards datasets](./api/get-dashboards-datasets) |
`/api/v1/dashboard/{id_or_slug}/datasets` |
+| `GET` | [Get dashboard's datasets](./api/get-dashboard-s-datasets) |
`/api/v1/dashboard/{id_or_slug}/datasets` |
```
</div>
</details>
</div>
<small><i>Code Review Run #d115de</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/developer_docs/api.mdx:
##########
@@ -363,10 +363,10 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
| Method | Endpoint | Description |
|--------|----------|-------------|
-| `POST` | [Create a dashboard's filter
state](./api/create-a-dashboard-s-filter-state) |
`/api/v1/dashboard/{pk}/filter_state` |
-| `DELETE` | [Delete a dashboard's filter state
value](./api/delete-a-dashboard-s-filter-state-value) |
`/api/v1/dashboard/{pk}/filter_state/{key}` |
-| `GET` | [Get a dashboard's filter state
value](./api/get-a-dashboard-s-filter-state-value) |
`/api/v1/dashboard/{pk}/filter_state/{key}` |
-| `PUT` | [Update a dashboard's filter state
value](./api/update-a-dashboard-s-filter-state-value) |
`/api/v1/dashboard/{pk}/filter_state/{key}` |
+| `POST` | [Create a dashboard's filter
state](./api/create-a-dashboards-filter-state) |
`/api/v1/dashboard/{pk}/filter_state` |
+| `DELETE` | [Delete a dashboard's filter state
value](./api/delete-a-dashboards-filter-state-value) |
`/api/v1/dashboard/{pk}/filter_state/{key}` |
+| `GET` | [Get a dashboard's filter state
value](./api/get-a-dashboards-filter-state-value) |
`/api/v1/dashboard/{pk}/filter_state/{key}` |
+| `PUT` | [Update a dashboard's filter state
value](./api/update-a-dashboards-filter-state-value) |
`/api/v1/dashboard/{pk}/filter_state/{key}` |
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Inconsistent API doc links and text</b></div>
<div id="fix">
The link paths for the dashboard filter state endpoints have been changed
from 'a-dashboard-s-...' to 'a-dashboards-...', but the display text remains 'a
dashboard's ...'. This creates inconsistency between the visible text and the
underlying link. Additionally, 'a-dashboards' does not form proper English when
read as a phrase. If the file names are being updated, ensure the display text
is also changed to match, or revert the link changes to maintain consistency.
</div>
</div>
<small><i>Code Review Run #d115de</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/developer_docs/api.mdx:
##########
@@ -177,7 +177,7 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
| `GET` | [Get names of databases currently
available](./api/get-names-of-databases-currently-available) |
`/api/v1/database/available/` |
| `GET` | [Download database(s) and associated dataset(s) as a zip
file](./api/download-database-s-and-associated-dataset-s-as-a-zip-file) |
`/api/v1/database/export/` |
| `POST` | [Import database(s) with associated
datasets](./api/import-database-s-with-associated-datasets) |
`/api/v1/database/import/` |
-| `GET` | [Receive personal access tokens from
OAuth2](./api/receive-personal-access-tokens-from-oauth2) |
`/api/v1/database/oauth2/` |
+| `GET` | [Receive personal access tokens from
OAuth2](./api/receive-personal-access-tokens-from-o-auth-2) |
`/api/v1/database/oauth2/` |
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Incorrect term hyphenation in link</b></div>
<div id="fix">
OAuth2 is a standard term (not 'O Auth 2'). The link hyphenation 'o-auth-2'
incorrectly splits it. Revert to 'oauth2' for consistency with codebase usage.
</div>
<details>
<summary>
<b>Code suggestion</b>
</summary>
<blockquote>Check the AI-generated fix before applying</blockquote>
<div id="code">
````suggestion
| `GET` | [Receive personal access tokens from
OAuth2](./api/receive-personal-access-tokens-from-oauth2) |
`/api/v1/database/oauth2/` |
````
</div>
</details>
</div>
<small><i>Code Review Run #d115de</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/developer_docs/api.mdx:
##########
@@ -68,14 +68,14 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
| `POST` | [Create a new dashboard](./api/create-a-new-dashboard) |
`/api/v1/dashboard/` |
| `GET` | [Get metadata information about this API resource
(dashboard--info)](./api/get-metadata-information-about-this-api-resource-dashboard-info)
| `/api/v1/dashboard/_info` |
| `GET` | [Get a dashboard detail
information](./api/get-a-dashboard-detail-information) |
`/api/v1/dashboard/{id_or_slug}` |
-| `GET` | [Get a dashboard's chart
definitions.](./api/get-a-dashboard-s-chart-definitions) |
`/api/v1/dashboard/{id_or_slug}/charts` |
+| `GET` | [Get a dashboard's chart
definitions.](./api/get-a-dashboards-chart-definitions) |
`/api/v1/dashboard/{id_or_slug}/charts` |
| `POST` | [Create a copy of an existing
dashboard](./api/create-a-copy-of-an-existing-dashboard) |
`/api/v1/dashboard/{id_or_slug}/copy/` |
-| `GET` | [Get dashboard's datasets](./api/get-dashboard-s-datasets) |
`/api/v1/dashboard/{id_or_slug}/datasets` |
-| `DELETE` | [Delete a dashboard's embedded
configuration](./api/delete-a-dashboard-s-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
-| `GET` | [Get the dashboard's embedded
configuration](./api/get-the-dashboard-s-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
-| `POST` | [Set a dashboard's embedded
configuration](./api/set-a-dashboard-s-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
+| `GET` | [Get dashboard's datasets](./api/get-dashboards-datasets) |
`/api/v1/dashboard/{id_or_slug}/datasets` |
+| `DELETE` | [Delete a dashboard's embedded
configuration](./api/delete-a-dashboards-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
+| `GET` | [Get the dashboard's embedded
configuration](./api/get-the-dashboards-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
+| `POST` | [Set a dashboard's embedded
configuration](./api/set-a-dashboards-embedded-configuration) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
| `PUT` | [Update dashboard by id_or_slug
embedded](./api/update-dashboard-by-id-or-slug-embedded) |
`/api/v1/dashboard/{id_or_slug}/embedded` |
-| `GET` | [Get dashboard's tabs](./api/get-dashboard-s-tabs) |
`/api/v1/dashboard/{id_or_slug}/tabs` |
+| `GET` | [Get dashboard's tabs](./api/get-dashboards-tabs) |
`/api/v1/dashboard/{id_or_slug}/tabs` |
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Grammatical error in possessive form</b></div>
<div id="fix">
Similar to line 73, changing 'dashboard's' to 'dashboards' removes the
possessive, making the phrase incorrect. Revert for proper grammar in API docs.
</div>
<details>
<summary>
<b>Code suggestion</b>
</summary>
<blockquote>Check the AI-generated fix before applying</blockquote>
<div id="code">
```
-| `GET` | [Get dashboards tabs](./api/get-dashboards-tabs) |
`/api/v1/dashboard/{id_or_slug}/tabs` |
+| `GET` | [Get dashboard's tabs](./api/get-dashboard-s-tabs) |
`/api/v1/dashboard/{id_or_slug}/tabs` |
```
</div>
</details>
</div>
<small><i>Code Review Run #d115de</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]
