Skip to content

docs(api-reference): add attachment API endpoints - #131

Draft
Yash1hi wants to merge 1 commit into
mainfrom
docs/attachment-api-reference
Draft

docs(api-reference): add attachment API endpoints#131
Yash1hi wants to merge 1 commit into
mainfrom
docs/attachment-api-reference

Conversation

@Yash1hi

@Yash1hi Yash1hi commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Adds the Attachments API to the reference — session-attachment upload and management endpoints, matching the current main schemas.

  • openapi.yaml: +4 paths (POST /attachments, POST /attachments/{attachmentId}/commit, GET/DELETE /attachments/{attachmentId}, GET /sessions/{sessionId}/attachments) and the Attachment schema. Spliced into the existing spec so all 35 existing SDK code samples are preserved (the diff is purely additive).
  • docs.json: new Attachments nav group.
  • 5 new api-reference/*.mdx pages, one per operation.

Note: the attachment endpoints don't carry JS/Python code samples yet — those are generated by Stainless when the SDK ships these endpoints. Everything else keeps its samples.

Test plan

  • openapi.yaml parses and every $ref resolves (validated locally)
  • The 4 attachment paths + Attachment schema are present; existing endpoints' x-codeSamples unchanged
  • Each new .mdx renders its endpoint (frontmatter openapi: matches a spec operation)
  • Attachments nav group appears in the sidebar

@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
scorecard 🟢 Ready View Preview Aug 6, 2026, 11:28 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

🖼️ Image Usage Check ✅

All 247 images in the repository are being used! No unused images found.

Great job keeping the repository clean! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant