-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Guy Davenport
committed
Nov 11, 2024
1 parent
559c089
commit 0d72b00
Showing
2 changed files
with
66 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
|
||
# BrAPI Schema Generator | ||
|
||
Generates the OpenAPI Specification, GraphQL Schema and OWL Model from the JSON Schema. | ||
The files are generated in the Specification/Generated directory. | ||
|
||
### How to use | ||
|
||
To generate all use the following | ||
|
||
* In windows | ||
|
||
```powershell | ||
./gradlew generateAll | ||
``` | ||
|
||
* In Linux or macOS | ||
|
||
```shell | ||
./gradle generateAll | ||
``` | ||
For individual tasks try | ||
|
||
* *generateGraphQL* to generate the GraphQL Schema from the JSON Schema | ||
* *generateOpenAPI* to generate the OpenAPI Specification from the JSON Schema | ||
* *generateOWL* to generate the OWL Model from the JSON Schema | ||
* *validate* to validate the JSON Schema without generating any file | ||
|
||
The files are generated in the Specification/Generated directory. | ||
|
||
to change the version of BrAPI used in the file name edit the *brapiVersion* in | ||
[Settings](settings.gradle). | ||
|
||
### Configuration | ||
|
||
To configure the generator see https://github.com/plantbreeding/brapi-schema-tools | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters