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

Publish a JSON File with all the implementations details suitable for consumption by json-schema.org #1312

Closed
benjagm opened this issue Jun 18, 2024 · 12 comments · Fixed by #1408
Labels
enhancement New feature or request

Comments

@benjagm
Copy link

benjagm commented Jun 18, 2024

Could it be possible to have a JSON file containing the details of all the implementations?

  • Name
  • Source
  • Supported Dialects

We are building the new Tooling page for the JSON Schema website and we plan to add a depth integration with Bowtie. The idea is to shaw the shields of the implementations if they are in Bowtie.

Our problem is we don't know the bowtie name of each implementation and without it we can generate the shield urls. As of now the only shared value in both data sources is the repo url (source) so if you guys provide this new file we'll manage to build all the shield urls using the Bowtie name of each tool.

Thanks a lot!

@Julian
Copy link
Member

Julian commented Jun 19, 2024

Sounds great, I'll look into this and follow up with a URL.

@Julian Julian added the enhancement New feature or request label Jun 19, 2024
@adwait-godbole
Copy link
Contributor

@Julian how are we planning to provide this ? We already generate the known_implementations.json file during the hatch(ling) build process but as we discussed that time, we could possibly end up inputting much more information in that file rather than just the implementation names. Also by sheild urls we mean the badges right ? Like e.g. https://bowtie.report/#/implementations/rust-boon/badges ? or something else ?

@Julian
Copy link
Member

Julian commented Jun 24, 2024

Essentially the same as that file yes, though for encapsulation reasons we should publish a second one specifically for this use (meaning to make sure we are free to make changes to our own file without risking breaking what is needed for this). So known_implementations.json remains a private API, and we'll publish a second file for json-schema.org as you say.

(And yep shields == badges)

@adwait-godbole
Copy link
Contributor

We already have one published at https://bowtie.report/implementations.json, right ?

@Julian
Copy link
Member

Julian commented Jun 24, 2024

Yep seems like it (though again, private to us).

@adwait-godbole
Copy link
Contributor

though again, private to us

so how to resolve that?

@Julian
Copy link
Member

Julian commented Jun 24, 2024

I'm not sure I understand the question! As I say, the goal of this issue is to publish a similar file, which we'll consider public, and whose target audience is the json-schema.org site, but it's meant to be very similar to what you linked (albeit with the keys being source URLs it sounds like).

@adwait-godbole
Copy link
Contributor

What is an appropriate public url for such a file then ?

@Julian
Copy link
Member

Julian commented Jun 24, 2024

Haven't thought too hard there yet but possibly something like https://bowtie.report/v1/json-schema-org/implementations

@benjagm
Copy link
Author

benjagm commented Aug 6, 2024

Hi everyone! Is there any update on this? This is critical for us to provide a seamless integration from the JSON Schema tooling page to Bowtie.

@Julian Julian changed the title JSON File with all the implementations details Publish a JSON File with all the implementations details suitable for consumption by json-schema.org Aug 6, 2024
@Julian
Copy link
Member

Julian commented Aug 7, 2024

@benjagm @DarhkVoyd with big thanks to @adwait-godbole this is live.

You can find the file at http://bowtie.report/api/v1/json-schema-org/implementations -- and a JSON Schema for it here

We wouldn't make backwards incompatible changes to that without coordinating, it's meant for you/json-schema.org.

We're making one last tweak to the exact format (which we mention here) and should go out shortly, but you can already start playing with that data if need be!

Let us know if there's anything else that'd help!

@DarhkVoyd
Copy link

@Julian @adwait-godbole This looks great! Thanks so much—much appreciated.

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
4 participants