A public directory structure for serving `implementations.json` to `json-schema-org`

bowtie-json-schema / bowtie

JSON Schema in every programming language

https://bowtie.report/

Other

52 stars 40 forks source link

A public directory structure for serving `implementations.json` to `json-schema-org` #1331

Closed adwait-godbole closed 2 months ago

adwait-godbole commented 3 months ago

resolves #1312

@Julian I am not sure if this was the best way of doing this but this is where my initial thoughts inclined towards. Here's how this file would look like once deployed.

https://adwait-godbole.github.io/bowtie/v1/json-schema-org/implementations.json

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

Julian commented 3 months ago

This looks more or less reasonable I think, thanks. Left a comment. Two others are:

Let's leave off the .json I think for public API endpoints, I think it's fine to just have it be a bare URL with no extension, which is a bit more common
Try to write a JSON Schema for that file, and test it's valid under it in the workflow

DarhkVoyd commented 2 months ago

Hey, apologies for being late to the discussion, I am working towards building the new tooling page. Thanks for your work on this issue. I am somewhat new to usage of bowtie, how are we planning the integration? My current idea is that the data model for the tooling page has a slot to store bowtie identifier, so we could possible somehow (maybe linking using repo link) populate that field and use some sort of api which we would fetch during build process to generate the badges. If I am mistaken, I am open to any implementation that is easier for you to implement and maintain. We could also hop on a quick call over slack if you prefer. Let me know!

Julian commented 2 months ago

Hey!

The idea from this issue/PR was basically that you / json-schema.org would pull this file from https://bowtie.report/v1/json-schema-org/implementations (as soon as we merge) and then you could use it for the tooling page -- I'll have another look at this since it's easier to describe once live I guess, but you'd get a JSON object where the key was the source URL (which is also present on the tooling page) so you can look up any implementation that way essentially, and then the value would give you all the data you might want from Bowtie.

DarhkVoyd commented 2 months ago

Great! Thank you for this. Let me know if anything.