docs: add license configuration examples for SDK generators #1755
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
- Add license field example to metadata section in generators-yml-reference.mdx - Add ParamField documentation for license configuration - Add license example to Python publishing guide Co-Authored-By: [email protected] <[email protected]>
🤖 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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </ParamField> | ||
|
|
||
| <ParamField path="license" type="'MIT' | 'Apache-2.0'" required={false} toc={true}> | ||
| Software license for the generated SDK. Supported values are `MIT` or `Apache-2.0`. This populates the license field in package manifests (e.g., `pyproject.toml` for Python, `package.json` for TypeScript). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'MIT' has no definition.
|
@devalog added per this slack thread |
@dannysheridan |
devalog
approved these changes
Nov 5, 2025
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.
docs: add license configuration examples for SDK generators
Summary
Adds documentation for how to specify a license for generated SDKs using the
metadata.licensefield. This addresses customer confusion about where to configure licenses ingenerators.yml.Changes:
license: MITexample to the top-level metadata section ingenerators-yml-reference.mdxmetadata.licenseacceptsMITorApache-2.0and populates package manifestslicense: MITexample to the Python publishing guide showing the correct placement at the generator levelReview & Testing Checklist for Human
metadata.license: MITand confirm it populates thelicensefield inpyproject.tomland adds the appropriate PyPI classifieroutput.metadata(PyPI-specific) andmetadata(general SDK metadata). Confirm this isn't confusing for usersNotes
This was a minimal change per Danny's request to "change less rather than more." The customer originally tried using
pyproject_tomlunderconfigwhich doesn't work - the correct location ismetadata.licenseat the generator level.Link to Devin run: https://app.devin.ai/sessions/62df5dfa1f934ae5b60671d82da03897
Requested by: [email protected] (@dannysheridan)