Skip to content

Commit 152ae2a

Browse files
author
Ryan Sites
committed
update description
1 parent d4e44ec commit 152ae2a

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

readme.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,23 @@
99
<a href="https://github.com/pages/optum/jsonschema-editor-react/"><img src="https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg"></a>
1010
</p>
1111

12-
> JsonSchemaEditor is a React component library that allows the easy generation of valid JsonSchema from a UI.
12+
## Description
13+
14+
> JSON Schema is hypermedia ready, and ideal for annotating your existing JSON-based HTTP API. JSON Schema documents are identified by URIs, which can be used in HTTP Link headers, and inside JSON Schema documents to allow recursive definitions. - [json-schema.org](https://json-schema.org/)
15+
16+
JsonSchemaEditor is a React component library that allows the easy generation of valid `Draft 07` JsonSchema from a UI, so that it can be easily persisted in a schema management system.
17+
18+
Benefits include:
19+
- Describes your existing data format(s).
20+
- Provides clear human- and machine- readable - documentation.
21+
- Validates data which is useful for:
22+
- Automated testing.
23+
- Ensuring quality of client submitted data.
24+
JSON Hyper-Schema
25+
Make any JSON format a hypermedia format with no constraints on document structure
26+
Allows use of URI Templates with instance data
27+
Describe client data for use with links using JSON Schema.
28+
Recognizes collections and collection items.
1329

1430
## Documentation
1531

0 commit comments

Comments
 (0)