Publish an implementation metadata file suitable for use by json-schema.org

[adwait-godbole]

Fixes #1312

@Julian can you review this one so that we can get this file available to @benjagm ASAP. Also earlier you had told me to remove the .json extension from the file, are you still ok with that ? Removing that extension directly downloads the file onto your desktop rather than opening on the Bowtie website.

---

📚 Documentation preview 📚: https://bowtie-json-schema--1408.org.readthedocs.build/en/1408/

[adwait-godbole]

Also @benjagm what all keys do you expect to be included in this API corresponding to an implementation?

[Julian]

Removing that extension directly downloads the file onto your desktop rather than opening on the Bowtie website.

Only if you view it in a browser, for API consumption it doesn't matter either way. (So yes let's remove it).

I'm confused though., didn't we merge this already? Having a look.

[adwait-godbole]

I'm confused though., didn't we merge this already? Having a look.

Nah we didn't. I had that PR opened but later closed it. This

[Julian]

Also @benjagm what all keys do you expect to be included in this API corresponding to an implementation?

Looks like Benja shared what's expected here -- so all we need is a mapping where the keys are source URLs for implementations, and the values should have:

• bowtie's ID (e.g. python-jsonschema)
• the dialects key.
• the badges URLs

We can skip everything else for now.

(EDIT: Also the badges URLs, as we may as well simply include that so that the JSON Schema folks don't need to recalculate it).

[adwait-godbole]

Doing the changes.

[adwait-godbole]

the badges URLs

@Julian Is there a way of generating those URLs programmatically using bowtie 😅? Otherwise will again have to write YAML logic for it.

[Julian]

I think that logic lives in the UI code unfortunately right now which I think you've seen last -- so not directly -- you could have a small typescript script maybe which imports the UI file, but not sure that's simpler than doing the hairy thing again :/

[adwait-godbole]

@Julian made the final changes. Tested on my local works fine.

You can have a look here --> https://adwait-godbole.github.io/bowtie/api/v1/json-schema-org/implementations

[Julian]

Thanks! Let's give it a shot. Well done.

[adwait-godbole]

It would be better if you could manually trigger this workflow once the CI passes, so we know if it works or not.

[Julian]

I kicked a release!

[adwait-godbole]

I hope for e.g. the below output format is fine right ?

  "https://github.com/tdegrunt/jsonschema": {
    "id": "js-jsonschema",
    "dialects": [
      "http://json-schema.org/draft-07/schema#",
      "http://json-schema.org/draft-06/schema#",
      "http://json-schema.org/draft-04/schema#",
      "http://json-schema.org/draft-03/schema#"
    ],
    "badges_urls": {
      "supported_versions": "https://bowtie.report/badges/javascript-jsonschema/supported_versions.json",
      "dialects_compliance": {
        "draft7": "https://bowtie.report/badges/javascript-jsonschema/compliance/draft7.json",
        "draft6": "https://bowtie.report/badges/javascript-jsonschema/compliance/draft6.json",
        "draft4": "https://bowtie.report/badges/javascript-jsonschema/compliance/draft4.json",
        "draft3": "https://bowtie.report/badges/javascript-jsonschema/compliance/draft3.json"
      }
    }
  }

[Julian]

Ah, close, I think ideally the keys in the dialects_compliance badges should be dialect URIs, otherwise there's no way for someone to know the short names of dialects (we "invented" them even though they're basically what everyone uses). Can you make that tweak?

[Julian]

Probably you can also shorten the key name to compliance to match the URI, rather than dialects_compliance.

[adwait-godbole]

Yup makes sense!