-
Notifications
You must be signed in to change notification settings - Fork 7
toast api docs #649
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
toast api docs #649
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style Review
Found 4 style suggestion(s).
Powered by Vale + Claude
|
|
||
| ## Authentication | ||
|
|
||
| The Arcade Toast API MCP Server requires credentials from the [Toast Developer Portal](https://doc.toasttab.com/doc/devguide/authentication.html). Toast uses a **client credentials** OAuth2 flow. Authentication is handled automatically - you just need to provide your client credentials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arcade.WordList: Changed 'OAuth2' to 'OAuth 2.0' per style guide
| The Arcade Toast API MCP Server requires credentials from the [Toast Developer Portal](https://doc.toasttab.com/doc/devguide/authentication.html). Toast uses a **client credentials** OAuth2 flow. Authentication is handled automatically - you just need to provide your client credentials. | |
| The Arcade Toast API MCP Server requires credentials from the [Toast Developer Portal](https://doc.toasttab.com/doc/devguide/authentication.html). Toast uses a **client credentials** OAuth 2.0 flow. Arcade handles authentication automatically - you just need to provide your client credentials. |
|
|
||
| <Callout type="info"> | ||
| Bearer tokens are fetched automatically for each API request using your client credentials. | ||
| You don't need to manage token expiration or refresh - it's handled for you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Google.Exclamation: Removed exclamation point from documentation text
| You don't need to manage token expiration or refresh - it's handled for you! | |
| You don't need to manage token expiration or refresh - it's handled for you. |
| **Parameters** | ||
|
|
||
| - **restaurant_external_id** (`string`, required): The Toast platform GUID for the restaurant. | ||
| - **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Google.Latin: Replaced 'e.g.' with 'for example'
| - **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115). | |
| - **business_date** (`string`, required): The business date in YYYYMMDD format (for example, 20240115). |
| **Parameters** | ||
|
|
||
| - **restaurant_external_id** (`string`, required): The Toast platform GUID for the restaurant. | ||
| - **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Google.Latin: Replaced 'e.g.' with 'for example'
| - **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115). | |
| - **business_date** (`string`, required): The business date in YYYYMMDD format (for example, 20240115). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| "toast-api": { | ||
| title: "Toast POS API", | ||
| }, | ||
| }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing default theme configuration in hospitality meta
Medium Severity
The hospitality/_meta.tsx file is missing the "*" default theme configuration that all other integration category meta files include. Every other category (databases, payments, entertainment, sales, customer-support, etc.) has a "*": { theme: { breadcrumb: true, toc: true, copyPage: true } } entry. Without this, the Toast API page will render without breadcrumb navigation, table of contents, and copy page functionality, making it inconsistent with all other integration pages.
Note
Introduces hospitality docs and Toast POS API tooling documentation.
hospitalitycategory toapp/en/resources/integrations/_meta.tsx("Retail & Hospitality")app/en/resources/integrations/hospitality/toast-api/page.mdxwith comprehensiveToastApidocs: auth (client credentials), scope coverage, and tool references (orders, menus, kitchen, labor, inventory, cash mgmt, restaurant info)app/en/resources/integrations/hospitality/_meta.tsxto registerToast POS APIpublic/llms.txtto include the newToastApidocs linkWritten by Cursor Bugbot for commit 911b05f. This will update automatically on new commits. Configure here.