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.

Sign up for GitHub

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

docs: explain how JSON Schema files are served #229

Merged
merged 4 commits into from
Jun 15, 2022
+16 −1
Merged

docs: explain how JSON Schema files are served #229

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f31157
docs: explain how JSON Schema files are served
smoya Jun 13, 2022
8cccf78
Update schemas/README.md
smoya Jun 14, 2022
f7ec272
clarify
smoya Jun 14, 2022
4a32d57
skip README on tests
smoya Jun 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions schemas/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AsyncAPI JSON Schema definitions

All the JSON Schema documents for validating AsyncAPI documents are located here.
Copy link
Member

Choose a reason for hiding this comment

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

here - did you want to add a link or specify here as here in this repository?

Copy link
Member Author

Choose a reason for hiding this comment

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

The second; here in this repository. I'm going to clarify it then 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

done! let me know if it sounds better now.


## Download and usage
Files are served via `https://asyncapi.com/definitions/<asyncapi-version>.json`, for example, https://asyncapi.com/definitions/2.4.0.json.

In that way, documents are served with the proper `Content-Type` response header. It also allows us to measure AsyncAPI user adoption of those files ([More info in this Github Issue](https://github.com/asyncapi/website/issues/780)).
We encourage you to **only** download the files from our website instead of from Github.

### JSON Schema Store

[JSON Schema Store](schemastore.org) is a universal JSON schema store, where schemas for popular JSON documents can be found.
AsyncAPI JSON Schema documents are also available in the store, meaning you can use their [plugins for most IDEs](https://www.schemastore.org/json/#editors), adding linting and validation automatically for all your AsyncAPI documents.