Skip to content

Commit 7b4fb51

Browse files
Merge pull request #634 from plantbreeding/improve-generator-documentation
Improve generator documentation
2 parents a70f98a + 126dee2 commit 7b4fb51

9 files changed

Lines changed: 1028 additions & 1486 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## JSON Specification
2+
3+
The BrAPI Specification defined as a JSON Schema. The schema is
4+
defined in individual files per Entity in separate models.
5+
Some files contain more than one definition where the entity has
6+
Value Types that are used only by entity.
7+
8+
[BrAPI-Common](./BrAPI-Common) contains definitions that are used the
9+
accose the four main.
10+
11+
[Requests](./Requests) defines the query model in the form of request
12+
object definitions for the primary entity models.
13+
Shared parameters and object definition between these definitions are placed in the
14+
[Parameters](./Requests/Parameters) and [Schemas](./Requests/Schemas)
15+
directories respectively.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Request parameters
2+
3+
This directory contains parameters shared between [Requests](../).
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Request object definitions
2+
3+
This directory contains object definitions shared between [Requests](../).
File renamed without changes.

0 commit comments

Comments
 (0)