Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cpommier authored Feb 16, 2021
1 parent 5ae14e0 commit 6858987
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,35 @@ Here is an example of data source description:

The `@id` field contains the URI identifying the data source (we use the URL of the official web site for convinience), the `schema:identifier` contains a short identifier for this data source, the `schema:name` contains the display name and `brapi:endpoint` contains the URL of the BrAPI endpoint.

The BrAPI endpoint must implement the required calls (also listed in `./config/extract-brapi.json`):
- /brapi/v1/studies-search (in GET or POST)
- /brapi/v1/studies/{id}
- /brapi/v1/studies/{id}/germplasm
### BrAPI endpoints requirements
Current BrAPI version: 1.3.
Backward compatibility with 1.2 is ensured to a certain extent.

The BrAPI endpoint must implement the required calls (also listed in `./config/entities/` json files, note that the first element of each "call" array is the recomended implementation):
**Mandatory**:
- /brapi/v1/calls GET
- /brapi/v1/studies GET
- /brapi/v1/studies/{studyDbId}

**Recommended**:
- /brapi/v1/germplasm GET
- /brapi/v1/germplasm/{germplasmDbId} GET
- /brapi/v1/variables GET
- /brapi/v1/locations GET
- /brapi/v1/locations/{locationDbId} GET
- /brapi/v1/studies/{studyDbId}/germplasm GET
- /brapi/v1/studies/{studyDbId}/observationvariables GET
- /brapi/v1/trials GET
- /brapi/v1/trials/{trialDbId} GET

**Optional**:
- /brapi/v1/germplasm/{germplasmDbId}/attributes GET
- /brapi/v1/germplasm/{germplasmDbId}/pedigree GET
- /brapi/v1/programs GET

**Experimental**:
- /brapi/v1/observationunits GET (backward compatibility with phenotype-search)
- /brapi/v1/studies/{studyDbId}/observationunits GET

See [`README-elasticsearch.md`](README-elasticsearch.md) for specific details on BrAPI to elasticsearch ETL.

Expand Down

0 comments on commit 6858987

Please sign in to comment.