MCP server docs and changes to build environment#24
Closed
mderazon wants to merge 4 commits intodocusaurus-mainfrom
Closed
MCP server docs and changes to build environment#24mderazon wants to merge 4 commits intodocusaurus-mainfrom
mderazon wants to merge 4 commits intodocusaurus-mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the OnceHub Developer Center (Docusaurus) by adding new MCP server documentation, introducing/expanding OpenAPI spec content for Scalar-based API reference pages, and adjusting the build/deploy environment (Azure Static Web Apps + formatting/tooling).
Changes:
- Add MCP Server doc section + sidebar navigation updates.
- Add/update OpenAPI spec files (resources, schemas, webhook events) to power API reference docs.
- Add deployment/configuration and site hardening assets (Azure SWA config, robots/sitemap, editor/tooling configs).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.json | Adds Docusaurus-based TS config for editor/typechecking. |
| staticwebapp.config.json | Adds global security headers + 404 rewrite for Azure SWA. |
| static/robots.txt | Adds crawler directives + sitemap URL. |
| static/img/logo-light.png | Adds light-mode logo asset. |
| static/img/logo-dark.png | Adds dark-mode logo asset. |
| static/google939cc3256aca4ddd.html | Adds Google site verification file. |
| static/.nojekyll | Adds .nojekyll marker for static hosting behavior. |
| src/theme/MDXComponents/index.tsx | Adds custom MDX components (Image/Callout/Table). |
| src/theme/MDXComponents.tsx | Adds an MDX Image override (competes with folder override). |
| src/plugins/scalarScriptPlugin.js | Injects Scalar standalone script tag. |
| src/plugins/productBadgePlugin.js | Injects client-side badge enhancer for Scalar-rendered content. |
| src/plugins/README.md | Documents the product badge plugin usage and conventions. |
| src/pages/markdown-page.md | Adds a sample markdown page. |
| src/pages/index.tsx | Adds new homepage feature grid + hero content. |
| src/pages/index.module.css | Styles new homepage hero/features layout. |
| src/pages/api-reference.tsx | Adds a dynamic-import Scalar API reference page. |
| src/css/custom.css | Global styling updates incl. Scalar + product badge styles. |
| src/components/Image.tsx | Adds a reusable MDX-friendly Image component with caption/border options. |
| src/components/HomepageFeatures/styles.module.css | Adds styles for HomepageFeatures component. |
| src/components/HomepageFeatures/index.tsx | Adds HomepageFeatures component implementation. |
| sidebars.ts | Adds MCP Server section and reorganizes doc sidebar. |
| schemathesis.toml | Adds Schemathesis config scaffolding. |
| package.json | Defines scripts/deps for Docusaurus, Scalar, formatting, typecheck, OpenAPI lint. |
| openapi/webhooks/tag.yaml | Adds “Webhook Events” tag definition. |
| openapi/webhooks/conversation-started.yaml | Adds webhook event payload path for conversation.started. |
| openapi/webhooks/conversation-closed.yaml | Adds webhook event payload path for conversation.closed. |
| openapi/webhooks/conversation-abandoned.yaml | Adds webhook event payload path for conversation.abandoned. |
| openapi/webhooks/booking-scheduled.yaml | Adds webhook event payload path for booking.scheduled. |
| openapi/webhooks/booking-rescheduled.yaml | Adds webhook event payload path for booking.rescheduled. |
| openapi/webhooks/booking-reassigned.yaml | Adds webhook event payload path for booking.reassigned. |
| openapi/webhooks/booking-no-show.yaml | Adds webhook event payload path for booking.no_show. |
| openapi/webhooks/booking-completed.yaml | Adds webhook event payload path for booking.completed. |
| openapi/webhooks/booking-canceled.yaml | Adds webhook event payload path for booking.canceled. |
| openapi/webhooks/booking-canceled-then-rescheduled.yaml | Adds webhook event payload path for booking.canceled_then_rescheduled. |
| openapi/webhooks/booking-canceled-reschedule-requested.yaml | Adds webhook event payload path for booking.canceled_reschedule_requested. |
| openapi/resources/webhooks/tag.yaml | Adds Webhooks resource tag. |
| openapi/resources/webhooks/list.yaml | Adds GET /webhooks definition. |
| openapi/resources/webhooks/get.yaml | Adds GET /webhooks/{id} definition. |
| openapi/resources/webhooks/delete.yaml | Adds DELETE /webhooks/{id} definition. |
| openapi/resources/webhooks/create.yaml | Adds POST /webhooks definition. |
| openapi/resources/users/tag.yaml | Adds Users resource tag. |
| openapi/resources/users/list.yaml | Adds GET /users definition. |
| openapi/resources/users/get.yaml | Adds GET /users/{id} definition. |
| openapi/resources/users/delete.yaml | Adds DELETE /users/{id} definition. |
| openapi/resources/users/add.yaml | Adds POST /users definition. |
| openapi/resources/users/update.yaml | Adds PATCH /users/{id} definition. |
| openapi/resources/teams/tag.yaml | Adds Teams resource tag. |
| openapi/resources/teams/list.yaml | Adds GET /teams definition. |
| openapi/resources/teams/get.yaml | Adds GET /teams/{id} definition. |
| openapi/resources/notifications/tag.yaml | Adds Notifications resource tag. |
| openapi/resources/notifications/list.yaml | Adds GET /notifications/sms definition. |
| openapi/resources/master-pages/tag.yaml | Adds Master Pages resource tag. |
| openapi/resources/master-pages/list.yaml | Adds GET /master-pages definition. |
| openapi/resources/master-pages/get.yaml | Adds GET /master-pages/{id} definition. |
| openapi/resources/master-pages/one-time-links.yaml | Adds POST /master-pages/{id}/one-time-links definition. |
| openapi/resources/event-types/tag.yaml | Adds Event Types resource tag. |
| openapi/resources/event-types/list.yaml | Adds GET /event-types definition. |
| openapi/resources/event-types/get.yaml | Adds GET /event-types/{id} definition. |
| openapi/resources/contacts/tag.yaml | Adds Contacts resource tag. |
| openapi/resources/contacts/list.yaml | Adds GET /contacts definition. |
| openapi/resources/contacts/get.yaml | Adds GET /contacts/{id} definition. |
| openapi/resources/contacts/delete.yaml | Adds DELETE /contacts/{id} definition. |
| openapi/resources/contacts/create.yaml | Adds POST /contacts definition. |
| openapi/resources/contacts/update.yaml | Adds PATCH /contacts/{id} definition. |
| openapi/resources/bookings/tag.yaml | Adds Bookings resource tag. |
| openapi/resources/bookings/list.yaml | Adds GET /bookings definition (+ product-specific filters). |
| openapi/resources/bookings/get.yaml | Adds GET /bookings/{id} definition. |
| openapi/resources/bookings/cancel.yaml | Adds POST /bookings/{id}/cancel definition. |
| openapi/resources/bookings/reschedule.yaml | Adds POST /bookings/{id}/request-reschedule definition. |
| openapi/resources/bookings/no-show.yaml | Adds POST /bookings/{id}/no-show definition. |
| openapi/resources/booking-pages/tag.yaml | Adds Booking Pages resource tag. |
| openapi/resources/booking-pages/list.yaml | Adds GET /booking-pages definition. |
| openapi/resources/booking-pages/get.yaml | Adds GET /booking-pages/{id} definition. |
| openapi/resources/booking-calendars/tag.yaml | Adds Booking Calendars resource tag. |
| openapi/resources/booking-calendars/list.yaml | Adds GET /booking-calendars definition. |
| openapi/resources/booking-calendars/get.yaml | Adds GET /booking-calendars/{id} definition. |
| openapi/resources/booking-calendars/time-slots.yaml | Adds GET /booking-calendars/{id}/time-slots definition. |
| openapi/resources/booking-calendars/schedule.yaml | Adds POST /booking-calendars/{id}/schedule definition. |
| openapi/resources/booking-calendars/one-time-links.yaml | Adds POST /booking-calendars/{id}/one-time-links definition. |
| openapi/resources/authentication/tag.yaml | Adds Authentication tag definition. |
| openapi/resources/authentication/validate.yaml | Adds GET /test (API key validation) definition. |
| openapi/info/info.yaml | Adds OpenAPI info metadata file. |
| openapi/components/schemas/common.yaml | Adds shared Error/DeletedObject schemas. |
| openapi/components/schemas/contact.yaml | Adds Contact + ContactList schemas. |
| openapi/components/schemas/user.yaml | Adds User + UserList schemas. |
| openapi/components/schemas/team.yaml | Adds Team + TeamList schemas. |
| openapi/components/schemas/notification.yaml | Adds SmsNotification + SmsNotificationList schemas. |
| openapi/components/schemas/event-type.yaml | Adds EventType + EventTypeList schemas. |
| openapi/components/schemas/master-page.yaml | Adds MasterPage + MasterPageList schemas. |
| openapi/components/schemas/utm-params.yaml | Adds UtmParams schema. |
| openapi/components/schemas/webhook.yaml | Adds Webhook + WebhookList schemas. |
| openapi/components/schemas/webhook-event.yaml | Adds base WebhookEvent schema. |
| openapi/components/schemas/conversation.yaml | Adds Conversation + related schemas (Website/Audience/Bot) and list schema. |
| openapi/components/schemas/booking-webhook-event.yaml | Adds BookingWebhookData schema for webhook payloads. |
| openapi/components/schemas/conversation-webhook-event.yaml | Adds ConversationWebhookData schema for webhook payloads. |
| openapi/components/schemas/booking-form.yaml | Adds BookingForm schema. |
| openapi/components/schemas/booking-calendar.yaml | Adds BookingCalendar + BookingCalendarList schemas. |
| openapi/components/schemas/booking-page.yaml | Adds BookingPage + BookingPageList schemas. |
| openapi/components/responses/errors.yaml | Adds shared error response components (401/403/429/etc). |
| openapi/components/parameters/common.yaml | Adds shared parameters (pagination, filters, expand, id). |
| openapi/components/examples/list-errors.yaml | Adds shared list endpoint error examples. |
| openapi/README.md | Documents OpenAPI file organization and usage. |
| openapi/index.yaml | Defines the main OpenAPI entrypoint and path/tag refs. |
| docusaurus.config.ts | Configures Docusaurus site, Scalar plugins, theme, navbar/footer, Algolia, GTM. |
| docs/webhooks/introduction-to-webhooks.md | Adds/updates webhook docs content. |
| docs/webhooks/managing-webhook-subscriptions.md | Adds/updates webhook subscription management doc. |
| docs/webhooks/using-webhooks.md | Adds/updates webhook usage doc. |
| docs/webhooks/webhook-signatures.md | Adds webhook signature verification doc + samples. |
| docs/recipes/fetch-bookings-periodically.md | Adds recipe showing pagination-based polling. |
| docs/overview/introduction.md | Adds overview introduction content. |
| docs/overview/authentication.md | Adds authentication overview + guidance. |
| docs/overview/error-handling.md | Adds error handling docs. |
| docs/overview/expanding-responses.md | Adds expand parameter docs. |
| docs/overview/pagination.md | Adds pagination docs. |
| docs/overview/rate-limits.md | Adds rate limits docs. |
| docs/overview/request-ids.md | Adds request id docs. |
| docs/overview/deleted-resources.md | Adds deleted resources behavior docs. |
| docs/overview/api-versioning.md | Adds versioning docs. |
| docs/mcp-server/introduction.md | Adds MCP server introduction doc. |
| docs/mcp-server/getting-started.md | Adds MCP server setup guide. |
| docs/mcp-server/tools.md | Adds MCP tool reference. |
| docs/faq.md | Adds FAQ doc. |
| docs/client-side-api/introduction.md | Adds client-side API intro doc. |
| docs/client-side-api/embed-events.md | Adds embed event subscription doc. |
| docs/client-side-api/embedded-booking-calendar-events.md | Adds embedded booking calendar events doc. |
| docs/client-side-api/embedded-chatbot-events.md | Adds embedded chatbot events doc. |
| docs/client-side-api/embedded-form-events.md | Adds embedded form events doc. |
| docs/client-side-api/collecting-data-from-embedded-booking-page.md | Adds legacy embedded booking page callback doc. |
| docs/client-side-api/redirecting-booking-confirmation-data.md | Adds redirect confirmation data doc (with tabs). |
| docs/changelog.md | Adds API changelog page. |
| README.md | Adds repository overview + local dev/build/test instructions. |
| LICENSE | Adds proprietary license notice. |
| .vscode/settings.json | Adds editor formatting defaults. |
| .vscode/extensions.json | Recommends Prettier extension. |
| .redocly.yaml | Adds Redocly CLI config. |
| .prettierignore | Adds formatting ignore list incl. generated OpenAPI variants. |
| .npmrc | Adds npm settings (save-exact, legacy-peer-deps). |
| .husky/pre-commit | Adds lint-staged pre-commit hook. |
| .husky/.gitignore | Adds husky gitignore entry. |
| .gitignore | Expands ignored artifacts (env files, logs, build outputs). |
| .github/workflows/azure-static-web-apps-nice-meadow-0c0634100.yml | Adds CI/CD workflow for dev Azure Static Web App. |
| .github/workflows/azure-static-web-apps-delightful-desert-0513ad50f.yml | Adds CI/CD workflow for main Azure Static Web App. |
| .gitattributes | Normalizes line endings + marks binaries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.