Skip to content

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Nov 3, 2025

Updated documentation to reflect PR #791's architectural changes to the OpenAI Apps SDK integration. The changes include new server-side storage system, dedicated /openai routes, enhanced bridge API with theme synchronization, and improved client flow from inline HTML to URL-based iframe loading.

Files Changed

  • docs/contributing/openai-sdk-architecture.mdx - Updated all endpoint references, file paths, interface definitions, API methods, architecture diagrams, and added theme synchronization documentation
  • docs/contributing/system-architecture.mdx - Added new /openai routes to API structure documentation and file locations table

Note

Refreshes OpenAI SDK integration docs to use dedicated /openai endpoints with server-side widget storage, enhanced iframe bridge (incl. theme sync), and updated client/server file paths and flows.

  • OpenAI SDK Architecture docs (docs/contributing/openai-sdk-architecture.mdx):
    • Endpoints and flow:
      • Migrate to /openai routes: POST /widget/store, GET /widget/:toolId, GET /widget-content/:toolId.
      • Update two-stage loading URLs and diagrams; renderer stores via store endpoint.
    • Server-side storage:
      • Document new WidgetData fields (toolResponseMetadata, toolName, theme) and TTL cleanup; move location to server/routes/mcp/openai.ts.
    • Iframe bridge (window.openai):
      • Add theme, maxHeight, safeArea, userAgent, toolResponseMetadata; improve setWidgetState handling.
      • Add sendFollowUpMessage alias and openExternal method.
    • Parent integration:
      • Move handler to client/src/components/chat-v2/openai-app-renderer.tsx; add theme synchronization via openai:set_globals.
      • Update iframe sandbox snippet and CSP section references.
    • Troubleshooting:
      • Add widget data 404 checks, state key format, and theme update guidance.
  • System Architecture docs (docs/contributing/system-architecture.mdx):
    • Add /api/mcp/openai route group to API map and file locations.

Written by Cursor Bugbot for commit 73ba80d. This will update automatically on new commits. Configure here.

@chelojimenez chelojimenez marked this pull request as ready for review November 4, 2025 00:11
@chelojimenez chelojimenez merged commit f8738fb into main Nov 4, 2025
3 of 4 checks passed
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Nov 4, 2025
khandrew1 pushed a commit to khandrew1/inspector that referenced this pull request Nov 12, 2025
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants