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

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

Closed
wants to merge 4 commits into from
Closed

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

wants to merge 4 commits into from

Conversation

adwait-godbole
Copy link
Contributor

@adwait-godbole adwait-godbole commented Jun 25, 2024

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/

| del(.os, .os_version, .language_version, .source)
)
})
| add' implementations.json > public-implementations.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will break if/when we change the format of our own implementations.json, which is the sort of thing we're trying to avoid, so it would be slightly better to generate this from scratch via other public API commands. E.g. you could probably use bowtie filter-implementations + bowtie info I think?

@Julian
Copy link
Member

Julian commented Jun 25, 2024

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
Copy link

DarhkVoyd commented Jul 13, 2024

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
Copy link
Member

Julian commented Jul 16, 2024

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
Copy link

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

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

Successfully merging this pull request may close these issues.

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