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

Validate API output against a JSON schema #9

Open
wlach opened this issue Mar 29, 2021 · 1 comment
Open

Validate API output against a JSON schema #9

wlach opened this issue Mar 29, 2021 · 1 comment
Labels
good first issue Good for newcomers

Comments

@wlach
Copy link
Contributor

wlach commented Mar 29, 2021

We should create a simple JSON schema for the output of https://github.com/mozilla/glean-annotations/blob/main/scripts/create-api.py

@acmiyaguchi had some good suggestions for the format in #8 (comment)

You can use the probe scraper repository schema as an example: https://github.com/mozilla/probe-scraper/blob/master/schemas/repositories.json

Once the schema is created, the next step is to validate it, using something like python's jsonschema package. you should be able to hook it up to CI by adding a validation step in .circleci/config.yml

Feel free to reach out in #glean-dictionary on chat.mozilla.org if you have questions: https://chat.mozilla.org/#/room/#glean-dictionary:mozilla.org

@wlach wlach added the good first issue Good for newcomers label Mar 29, 2021
@wlach wlach mentioned this issue Mar 29, 2021
@QueshAnmak
Copy link

Hi, I would like to work on this issue, could you please assign it to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants