docs(style): apply mintlify-docs style guide to OpenAPI strings#272
docs(style): apply mintlify-docs style guide to OpenAPI strings#272muhsinking wants to merge 1 commit intomainfrom
Conversation
Apply the togethercomputer/mintlify-docs style guide to summary,
description, and title fields in openapi.yaml. Fix em-dashes,
future-tense ("will be/return/use/..."), banned words ("please",
filler "just"), "the user" references, trailing periods on summaries,
and a few case/acronym issues (e.g. "GPU Cluster" -> "GPU cluster",
"Id" -> "ID"). Two error-response descriptions wrapped in single
quotes after replacing em-dashes with colons, since YAML otherwise
misparses the second colon as a key separator.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✱ Stainless preview builds for togetheraiThis PR will update the go openapi python terraform typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ togetherai-python studio · code · diff
✅ togetherai-go studio · code · diff
✅ togetherai-typescript studio · code · diff
✅ togetherai-openapi studio · code · diff
✅ togetherai-terraform studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Summary
Applies the togethercomputer/mintlify-docs style guide to user-facing strings (
summary,description,title) inopenapi.yaml. Field names, enum values, and code samples are untouched.Fixes by category
:or rephrased): 3.will be added→to add,will return→returns,will be used→uses, etc.): ~30.you/youror removed: 5.info.description: 1.only: 2.GPU Cluster→GPU cluster(×2),Id/id→ID(×2).Defined the behavior→Defines the behavior.YAML note
Two
400/500response 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_loadparses the file cleanly (74 paths, 99 endpoints).summaryfield.will (be|return|use|...), "please", or "the user" patterns indescription/summary/titlestrings.Test plan
yaml.safe_load).🤖 Generated with Claude Code