Skip to content

Adding feedback to improve the messaging and illustration of What is JSON Schema #724

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

Merged
merged 6 commits into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
8 changes: 4 additions & 4 deletions pages/overview/what-is-jsonschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
section: docs
title: What is JSON Schema?
---
JSON Schema is a declarative language for annotating and validating JSON documents' structure, constraints, and data types. It provides a way to standardize and define expectations for JSON data.
JSON Schema is a declarative language for annotating and validating JSON instances' structure, constraints, and data types. It provides a way to standardize and define expectations for JSON data.
<br/>


Expand All @@ -14,13 +14,13 @@ While JSON Schema provides the language, validating a JSON [instance](https://js

JSON validators are open-source and commercial tools that implement the JSON Schema specification. They make it very easy to integrate JSON Schema into projects of any size.

![How JSON Schema works](/img/json_schema.svg)
![How JSON Schema works](/img/json_schema.png)

## Benefits of JSON Schema for Developers

JSON Schema empowers developers in the following ways:

* **Structured Data Description**: JSON Schema allows developers to describe the structure, constraints, and data types of existing JSON formats.
* **Structured Data Description**: JSON Schema empower developers to use JSON to describe the structure, constraints, and data types of existing JSON data.
* **Rule Definition and Enforcement**: By adhering to JSON schema constraints, it becomes easier to exchange structured data between applications as it maintains a consistent pattern.
* **Produce clear documentation**: JSON Schema supports the creation of machine and human readable documentation.
* **Extensibility:** JSON Schema offers high adaptability to developers' needs. Custom keywords, formats, and validation rules can be created to tailor schemas according to specific requirements.
Expand All @@ -45,7 +45,7 @@ JSON Schema empowers organizations by:

JSON Schema dates back to the [first JSON Schema proposal](https://web.archive.org/web/20071026185150/http://json.com/json-schema-proposal/) submitted by Kris Zyp to [json.com](http://json.com) on October 2nd, 2007.

The current version of JSON Schema is [2020-12](https://json-schema.org/draft/2020-12/release-notes), which represents the latest advancements and has expanded capabilities compared with the previous versions, `draft-04`, `draft-06`, and `draft-07`.
The newest version of JSON Schema is [2020-12](https://json-schema.org/draft/2020-12/release-notes), which represents the latest advancements and has expanded capabilities compared with the previous versions, `draft-04`, `draft-06`, and `draft-07`.

We recommend using the newest version of JSON Schema and taking advantage of its benefits.

Expand Down
Binary file added public/img/json_schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion public/img/json_schema.svg

This file was deleted.