docs(api-reference): document sessionId on record creation - #133
Draft
Yash1hi wants to merge 1 commit into
Draft
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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.
The public v2 Create Record endpoint accepts an optional
sessionIdthat joins the record to its session's traces and attachments. The field is live on the API and described in the backend's generated spec (schemas/src/external.tsin the monorepo), but this repo'sopenapi.yamldidn't show it — API-import scripts have been relying on an undocumented field.openapi.yaml— splices thesessionIdproperty into thecreateRecordrequest body, synced verbatim from the backend's generated spec (spliced rather than regenerated, to keep the Stainless code samples intact).Test plan
openapi.yamlparses as valid YAML and the property text matches the backend's generatedschemas/openapi.yaml(verified).npx mintlify devrenders the new field on the Create Record page.