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

Add a schema of autorest configuration to schemastore.org #4903

Open
davidyuk opened this issue Mar 10, 2024 · 0 comments
Open

Add a schema of autorest configuration to schemastore.org #4903

davidyuk opened this issue Mar 10, 2024 · 0 comments
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@davidyuk
Copy link

davidyuk commented Mar 10, 2024

Is your feature request related to a problem? Please describe.
I may do a typo in the autorest configuration file and if I had the schema set up then my IDE would warn me before running autorest. Also, the schema would help to investigate available options without looking in the docs.

Describe the solution you'd like
To add a schema to https://schemastore.org/ matching files autorest.(yaml|json), and maybe *.autorest.(yaml|json). So, the extension I'm using would automatically pick up that schema.

Describe alternatives you've considered
If I had that schema just published somewhere, I would add a comment like

# yaml-language-server: $schema=<urlToTheSchema>

to enable validation without using schemastore.

Additional context
By configuration I mean the format mentioned in https://github.com/Azure/autorest/blob/main/docs/generate/readme.md

@microsoft-github-policy-service microsoft-github-policy-service bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Mar 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Development

No branches or pull requests

1 participant