Clarify generators.yml dual purpose: API declaration and code generation #1902
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
- Update OpenAPI and gRPC generators.yml reference pages to mention both SDKs and documentation - Add clarifying notes explaining generators.yml serves two roles: declaring APIs and configuring code generation - Update generators-yml-project-structure.mdx snippet to clarify dual purpose - Add note to docs product generate-api-ref.mdx explaining APIs must be declared in generators.yml - Update API definitions project-structure.mdx comment for consistency - Fix Vale style issues (capitalize API Reference, use contractions) Addresses user feedback that generators.yml appeared to be only for SDK generation, when it also declares APIs that can be rendered in documentation via docs.yml. Co-Authored-By: Devin Logan <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </Tab> | ||
| <Tab title="OpenAPI (API Reference + SDKs)"> | ||
| To generate SDKs in addition to API Reference docs, add a `groups` section below your `api.specs`: |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'also' instead of 'in addition'.
Contributor
Contributor
| </Tab> | ||
| <Tab title="Fern Definition"> | ||
| For Fern Definition, the `api` section is not needed. Fern auto-detects your API from the `definition/` directory. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Contributor
Contributor
devalog
approved these changes
Nov 12, 2025
devalog
deleted the
devin/1762816502-clarify-generators-yml-dual-purpose
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clarify generators.yml dual purpose: API declaration and code generation
Summary
Addresses user feedback that documentation made it seem like
generators.ymlis only used for SDK generation, when in fact it also declares which APIs your project contains and those APIs can be rendered in documentation viadocs.yml.Changes made:
generators-yml-project-structure.mdxto clarify both rolesReview & Testing Checklist for Human
generators-yml-project-structure.mdxsnippet reads well when included in the API definitions project-structure page (line 35)Notes
Session: https://app.devin.ai/sessions/90f2c2014224469ab6c9166fc254b21e
Requested by: Devin Logan ([email protected]) / @devalog