8000 Make schema public and restore `/schema` by bradjones1 · Pull Request #1750 · json-api/json-api · GitHub
[go: up one dir, main page]

Skip to content

Make schema public and restore /schema #1750

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

Open
wants to merge 8 commits into
base: gh-pages
Choose a base branch
from

Conversation

bradjones1
Copy link
Contributor

Fixes #1749

@bradjones1
Copy link
Contributor Author

Decided to make /schema basically a pointer to the latest version, which also has a public, stable URI/URL if someone wants to reference a particular version directly. Made some related improvements to the static site, as well.

Copy link
@auvipy auvipy left a comment

Choose a reason for hiding this comment

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

Looks good

@bradjones1
Copy link
Contributor Author

Thanks @auvipy for the review. @jelhan any thoughts on this as a move toward forking the schemas into a different repository as we discussed in the forums?

@bradjones1 bradjones1 changed the title Make schema public and restore /schema Make schema public and restore /schema Jul 18, 2024
@bradjones1
Copy link
Contributor Author

I have been testing this by way of improving Drupal's OpenAPI docs and noted errors from the Redocly CLI validator that the "dependencies" key is unknown. That's not quite correct because it's deprecated, so they're a little over-strict, but we should not ship a schema with deprecated properties. I also upped the validation level for ajv to strict and fixed a few of those nits.

It would be really amazing to move this forward. I think this schema is stable, a huge improvement on what was previously on jsonapi.org and fixes public schema use at /schema. What else needs to happen to get this committed?

@auvipy
Copy link
auvipy commented Sep 18, 2024

@dgeb please take a look

Copy link
Member
@dgeb dgeb left a comment

Choose a reason for hiding this comment

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

@bradjones1 this appears to be a solid start, but one that I'd like to give the community the chance to weigh in on before it is finalized. For this reason, I have left the schema a "draft" until it has been publicly reviewed and commented upon. I'll add a blurb to the front page soon.

@@ -1,15 +1,11 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://jsonapi.org/schemas/spec/v1.0/draft",
"$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.",
"$id": "https://jsonapi.org/schemas/1.0/schema.json",
Copy link
Member

Choose a reason for hiding this comment

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

   "$id": "https://jsonapi.org/schemas/spec/v1.0/draft",
   "$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.",

The schema should remain a draft until it has been publicly reviewed.

@NullVoxPopuli
Copy link

Anyone feel like finishing this PR? <3

@auvipy
Copy link
auvipy commented Apr 28, 2025

we really need this to be merged

@auvipy
Copy link
auvipy commented May 21, 2025

Decided to make /schema basically a pointer to the latest version, which also has a public, stable URI/URL if someone wants to reference a particular version directly. Made some related improvements to the static site, as well.

would you mind resolving the review comment please?

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.

JSON Schema is not publicly available
5 participants
0