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

Utilize Schemas from Spec Repository #72

Open
Teque5 opened this issue Sep 13, 2024 · 3 comments
Open

Utilize Schemas from Spec Repository #72

Teque5 opened this issue Sep 13, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@Teque5
Copy link
Collaborator

Teque5 commented Sep 13, 2024

Now that the specification repository is using it's own schemas to generate the documentation, we can now use those schemas in the validator instead of having our own.

I dislike git submodule, but I don't see a better way. Since the spec schemas is based upon the one here I suspect this will be an easy transition.

Any alternatives to git submodule? If no, we can try to get this working during grcon next week.

@Teque5 Teque5 added the enhancement New feature or request label Sep 13, 2024
@777arc
Copy link
Member

777arc commented Sep 13, 2024

One alternative to git submodule is for the github action that publishes to pypi to clone the spec repo as part of building the package, and then for folks doing local dev there can be a line in the install instructions that involves cloning it. There may also be some pyproject.toml way to do it, I know that you can specify a dependency by giving it the github url but we're not talking about a python package, it just needs the json schema. The other thing is that json schemas are supposed to be available via url, so if we standardize the url its available at we can hardcode it in this repo.

@Teque5
Copy link
Collaborator Author

Teque5 commented Sep 13, 2024

I like the idea of having the URL, but will there be a separate URL for each version of the spec? I wouldn't want the spec to change and break the python module. At least with submodule you explicitly pin a commit value.

@777arc
Copy link
Member

777arc commented Sep 13, 2024

Alright I just tried something on the main repo to see if it would work- what we can do is use githubs release system and the fact you can get to any raw file using the tag in the URL, to deal with version control of the json schema without going out of our way. Eg the latest one is- https://raw.githubusercontent.com/sigmf/SigMF/v1.2.2/sigmf-schema.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants