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

feat: add scalingo.schema.json #390

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

Conversation

revolunet
Copy link
Contributor

@revolunet revolunet commented Feb 8, 2024

A json-schema proposal for the scalingo.json file. This allows linting and documentation from your editor.

Its been created manually from the docs and tested against various scalingo.json examples.

Once this file is published, we can add it to SchemaStore so every IDE can associate scalingo.json to the published schema.

Meanwhile, you can see it in action by adding "$schema":https://raw.githubusercontent.com/Scalingo/developers-documentation/ba2c542c3a8c77145445a942c1ffc14790ce8799/scalingo.schema.json to your scalingo.json. If you use VScode and the Red Hat YAML extension then you you should see documentation appear instantly.

Note: The addons.plan key provide some examples but no restriction on what you can set here. (would be cool to have an exhaustive list if possible)

Some examples:

Capture d’écran 2024-02-06 à 10 46 09 Capture d’écran 2024-02-06 à 10 49 02 Capture d’écran 2024-02-06 à 10 48 07 Capture d’écran 2024-02-06 à 10 46 52 Capture d’écran 2024-02-06 à 10 46 16

@ksol
Copy link
Contributor

ksol commented Jun 17, 2024

👋🏼 Hello @revolunet, sorry for not getting back to you on this topic sooner, and thanks for the submission! I'll add this on our plate of things to review, but it's indeed something that we'd benefit from

@ksol ksol self-assigned this Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants