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

added Json Schema for dtspec yaml format #53

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

fuchsst
Copy link

@fuchsst fuchsst commented Oct 15, 2022

The Json schema allows users to reference it from their IDE (e.g. VSCode or IntelliJ) and get support by the editor, like syntax highlighting and code completion.

IntelliJ: https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom
VSCode: https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings

@gnilrets
Copy link

Hi and thanks for the contribution. Would you be able to combine this with the json schema that is already defined? Is this where you started, and you just added the descriptions? If so, maybe just change this to load from the file you created rather than having the schema hard-coded in the .py file.

@fuchsst
Copy link
Author

fuchsst commented Oct 18, 2022

oh...i totally missed that one. i took referred to the readme...

sure, will take this as a basis and double check (and fix)!

@fuchsst
Copy link
Author

fuchsst commented Oct 20, 2022

so took the existing schema in api.py as base, added some descriptions and extracted it into a yaml that is now loaded in api.py

@gnilrets
Copy link

gnilrets commented Nov 8, 2022

I moved your PR here since this project is no longer being maintained by Inside-Track.

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