Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix example of json-chema README.md #5145

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

satoshionoda
Copy link

the example was not working as the property name model is a reserved keyword.

the example was not working as the property name `model` is a reserved keyword.
Copy link
Contributor

@AlitzelMendez AlitzelMendez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for your pull request! the change looks good! but the change on packages/json-schema/README.md is missing, please run pnpm regen-docs on repo root and after that it should be ready!
thanks again!

@chrisradek
Copy link
Member

Thank you for submitting this PR!

The README.md is generated by running npm run regen-docs from inside packages/json-schema. This is the file where the property name should be changed:
https://github.com/microsoft/typespec/blob/main/packages/json-schema/.tspd/docs/usage.md

Note: In your original change, you updated make to maker, but I think this should remain make since it's common in the context of automobiles to refer to a car's model, make, and year. Definitely understand the model rename though given it's a reserved word.

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

Successfully merging this pull request may close these issues.

3 participants