-
Notifications
You must be signed in to change notification settings - Fork 168
Update OpenAI SDK Architecture Documentation #793
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
Merged
Merged
Conversation
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
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.
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.
Updated documentation to reflect PR #791's architectural changes to the OpenAI Apps SDK integration. The changes include new server-side storage system, dedicated
/openairoutes, 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 documentationdocs/contributing/system-architecture.mdx- Added new/openairoutes to API structure documentation and file locations tableNote
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.
docs/contributing/openai-sdk-architecture.mdx):/openairoutes:POST /widget/store,GET /widget/:toolId,GET /widget-content/:toolId.WidgetDatafields (toolResponseMetadata,toolName,theme) and TTL cleanup; move location toserver/routes/mcp/openai.ts.theme,maxHeight,safeArea,userAgent,toolResponseMetadata; improvesetWidgetStatehandling.sendFollowUpMessagealias andopenExternalmethod.client/src/components/chat-v2/openai-app-renderer.tsx; add theme synchronization viaopenai:set_globals.docs/contributing/system-architecture.mdx):/api/mcp/openairoute group to API map and file locations.Written by Cursor Bugbot for commit 73ba80d. This will update automatically on new commits. Configure here.