FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Make schema public and restore `/schema` by bradjones1 · Pull Request #1750 · json-api/json-api · GitHub

/ json-api Public

Make schema public and restore /schema - #1750

Open
bradjones1 wants to merge 8 commits into
json-api:gh-pagesfrom
bradjones1:schema-public
ConversationCommits (8)ChecksFiles changed
Open

Make schema public and restore /schema#1750
bradjones1 wants to merge 8 commits into
json-api:gh-pagesfrom
bradjones1:schema-public

Conversation

bradjones1 commented Jul 5, 2024

Copy link
Copy Markdown
Contributor

Fixes #1749

bradjones1 mentioned this pull request Jul 5, 2024
Open

bradjones1 commented Jul 5, 2024

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

auvipy approved these changes Jul 7, 2024
View reviewed changes

auvipy left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good

bradjones1 commented Jul 8, 2024

Copy link
Copy Markdown
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 changed the title Make schema public and restore /schema Make schema public and restore /schema Jul 18, 2024

bradjones1 commented Jul 19, 2024

Copy link
Copy Markdown
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 commented Sep 18, 2024

Copy link
Copy Markdown

@dgeb please take a look

dgeb requested changes Sep 18, 2024
View reviewed changes

dgeb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@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.

Comment thread schemas/1.0/schema.json
"$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",

dgeb Sep 18, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality 
   "$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.

Comment thread faq/index.md

NullVoxPopuli commented Dec 19, 2024

Copy link
Copy Markdown

Anyone feel like finishing this PR? <3

auvipy commented May 21, 2025

Copy link
Copy Markdown

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?

david-fong-bc reviewed Jul 24, 2025
View reviewed changes
Comment thread faq/index.md
documentation. Validation will not yield false negatives, but could yield false
positives for the sake of flexibility.
Yes, you can find the response JSON Schema definition for version 1.0 at
[`https://jsonapi.org/schema`](http://jsonapi.org/schema). (An update for

david-fong-bc Jul 24, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

missing an "s"?

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

dgeb dgeb requested changes
+4 more reviewers
david-fong-bc david-fong-bc left review comments
auvipy auvipy approved these changes
rexiliano89 rexiliano89 approved these changes
Armss9936 Armss9936 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

JSON Schema is not publicly available

7 participants

Back | FazBrowse Home | New Git URL