docs(style): apply mintlify-docs style guide to OpenAPI strings

[muhsinking]

Summary

Applies the togethercomputer/mintlify-docs style guide to user-facing strings (summary, description, title) in openapi.yaml. Field names, enum values, and code samples are untouched.

Fixes by category

• Em-dashes removed (replaced with : or rephrased): 3.
• Future tense rewritten as present (will be added → to add, will return → returns, will be used → uses, etc.): ~30.
• "the user" / "the user's" / "one" replaced with you / your or removed: 5.
• "please" removed from info.description: 1.
• Filler "just" → only: 2.
• Summary trailing periods removed: 8.
• Case/acronym fixes: GPU Cluster → GPU cluster (×2), Id/id → ID (×2).
• Typo: Defined the behavior → Defines the behavior.

YAML note

Two 400/500 response descriptions had em-dashes replaced with colons. Without quoting, YAML misparses the second : as a key separator, so those two strings are now wrapped in single quotes.

Verified

• yaml.safe_load parses the file cleanly (74 paths, 99 endpoints).
• All 99 endpoints still have a summary field.
• Zero remaining em-dashes, future-tense will (be|return|use|...), "please", or "the user" patterns in description/summary/title strings.

Test plan

• Spec parses (already verified locally with yaml.safe_load).
• Mintlify rendering of API reference looks correct on a preview build.
• No SDK/codegen consumers break (string changes are content-only, not field-name).

🤖 Generated with Claude Code

[github-actions]

✱ Stainless preview builds for togetherai

This PR will update the togetherai SDKs with the following commit messages.

go

docs(api): update docstrings from future to present tense

openapi

docs(api): update descriptions and summaries across API endpoints and models

python

docs(api): reword docstrings to present tense across resources

terraform

docs(api): update reservation_start_time description in beta_cluster

typescript

docs(api): improve docstring clarity and grammar across resources

✅ togetherai-openapi studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅

⚠️ togetherai-go studio · code

Your SDK build had a failure in the test CI job, which is a regression from the base state.
generate ✅ → build ✅ → lint ✅ → test ❗

go get github.com/stainless-sdks/togetherai-go@7795a05304ff9012c78e58263250b82e53971405

⚠️ togetherai-python studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️ → build ✅ → lint ✅ → test ⏭️

pip install https://pkg.stainless.com/s/togetherai-python/65c175682f4f8432dfe4d880d6dc0a21acc46655/together-2.12.0-py3-none-any.whl

⚠️ togetherai-typescript studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️ → build ✅ → lint ✅ → test ✅

npm install https://pkg.stainless.com/s/togetherai-typescript/3fff4b65ebf0a6e409a1325f4b0c39ccb453526a/dist.tar.gz

✅ togetherai-terraform studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅ → lint ✅ → test ✅

---

This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-11 18:00:26 UTC

[blainekasten]

lovely!

I wonder if there is a way to auto-apply this on future PRs as other devs add fields and their own descriptions. Maybe a bot with doc suggestions using our doc guidelines as a skill?