Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
15 changes: 15 additions & 0 deletions Specification/BrAPI-Schema/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## JSON Specification

The BrAPI Specification defined as a JSON Schema. The schema is
defined in individual files per Entity in separate models.
Some files contain more than one definition where the entity has
Value Types that are used only by entity.

[BrAPI-Common](./BrAPI-Common) contains definitions that are used the
accose the four main.

[Requests](./Requests) defines the query model in the form of request
object definitions for the primary entity models.
Shared parameters and object definition between these definitions are placed in the
[Parameters](./Requests/Parameters) and [Schemas](./Requests/Schemas)
directories respectively.
3 changes: 3 additions & 0 deletions Specification/BrAPI-Schema/Requests/Parameters/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Request parameters

This directory contains parameters shared between [Requests](../).
3 changes: 3 additions & 0 deletions Specification/BrAPI-Schema/Requests/Schemas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Request object definitions

This directory contains object definitions shared between [Requests](../).
Loading