Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plantbreeding/BrAPI

Repository for version control of the BrAPI specifications
https://github.com/plantbreeding/BrAPI

api apiary brapi brapi-genotyping brapi-germplasm brapi-phenotyping brapi-server data-management open-api-v3 plant-breeding specification standard swagger swaggerhub

Last synced: about 2 months ago
JSON representation

Repository for version control of the BrAPI specifications

Host: GitHub
URL: https://github.com/plantbreeding/BrAPI
Owner: plantbreeding
License: mit
Created: 2015-08-22T08:57:55.000Z (about 9 years ago)
Default Branch: brapi-V2.1
Last Pushed: 2024-07-30T19:10:36.000Z (about 2 months ago)
Last Synced: 2024-07-31T09:25:24.143Z (about 2 months ago)
Topics: api, apiary, brapi, brapi-genotyping, brapi-germplasm, brapi-phenotyping, brapi-server, data-management, open-api-v3, plant-breeding, specification, standard, swagger, swaggerhub
Language: Python
Homepage: https://brapi.org
Size: 15.2 MB
Stars: 54
Watchers: 51
Forks: 33
Open Issues: 88
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # BrAPI V2.1

The Breeding API (BrAPI) is a Standardized RESTful Web Service API Specification for communicating Plant Breeding Data. BrAPI allows for easy data sharing between databases and tools involved in plant breeding.

## Versions

### V2

BrAPI V2 is divided into four modules:

**BrAPI Core** - The BrAPI Core module contains high level entities used for organization and management. This includes Programs, Trials, Studies, Locations, People, and Lists

**BrAPI Phenotyping** - The BrAPI Phenotyping module contains entities related to phenotypic observations. This includes Observation Units, Observations, Observation Variables, Traits, Scales, Methods, and Images

**BrAPI Genotyping** - The BrAPI Genotyping module contains entities related to genotyping analysis. This includes Samples, Markers, Variant Sets, Variants, Call Sets, Calls, References, Reads, and Vendor Orders

**BrAPI Germplasm** - The BrAPI Germplasm module contains entities related to germplasm management. This includes Germplasm, Germplasm Attributes, Seed Lots, Crosses, Pedigree, and Progeny

| Version | Status | Release Date | SwaggerHub | Apiary | Notes |

|---------|--------|--------------|------------|--------|-------|

|[V2.1](https://github.com/plantbreeding/API/tree/V2.0) |Released |July 1, 2022 | | | [Release Notes](https://github.com/plantbreeding/API/releases/tag/V2.1) / [Change File](https://github.com/plantbreeding/API/releases/download/V2.1/BrAPI_V2-1_Release_Notes.xlsx)|

| | | |[BrAPI Core](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Core/2.1)               |[BrAPI Core](https://brapicore21.docs.apiary.io) | |

| | | |[BrAPI Phenotyping](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Phenotyping/2.1) |[BrAPI Phenotyping](https://brapiphenotyping21.docs.apiary.io) | |

| | | |[BrAPI Genotyping](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Genotyping/2.1)   |[BrAPI Genotyping](https://brapigenotyping21.docs.apiary.io) | |

| | | |[BrAPI Germplasm](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Germplasm/2.1)     |[BrAPI Germplasm](https://brapigermplasm21.docs.apiary.io) | |

|[V2.0](https://github.com/plantbreeding/API/tree/brapi-V2.0) |Released |Mar 11, 2020 | | | [Release Notes](https://github.com/plantbreeding/API/releases/tag/V2.0) / [Change File](https://github.com/plantbreeding/API/releases/download/V2.0/BrAPI_V2-0_Release_Notes.xlsx)|

| | | |[BrAPI Core](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Core/2.0)               |[BrAPI Core](https://brapicore20.docs.apiary.io) | |

| | | |[BrAPI Phenotyping](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Phenotyping/2.0) |[BrAPI Phenotyping](https://brapiphenotyping20.docs.apiary.io) | |

| | | |[BrAPI Genotyping](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Genotyping/2.0)   |[BrAPI Genotyping](https://brapigenotyping20.docs.apiary.io) | |

| | | |[BrAPI Germplasm](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Germplasm/2.0)     |[BrAPI Germplasm](https://brapigermplasm20.docs.apiary.io) | |

### V1

Version | Status | Release Date | SwaggerHub | Apiary | Notes

--|--|--|--|--|--

[V1.3](https://github.com/plantbreeding/API/tree/brapi-V1.3) | Archived | Nov 01, 2018 |[Archive-1.3](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI/1.3) | [Archive-1.3](https://brapiarchive13.docs.apiary.io/#) | [Release Notes](https://github.com/plantbreeding/API/releases/tag/V1.3) / [Change File]()

[V1.2](https://github.com/plantbreeding/API/tree/brapi-V1.2) | Archived | Apr 27, 2018 |[Archive-1.2](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI/1.2) | [Archive-1.2](https://brapiarchive12.docs.apiary.io/#) | [Release Notes](https://github.com/plantbreeding/API/releases/tag/V1.2) / [Change File](https://github.com/plantbreeding/API/files/1964628/BrAPI_V1-2_Release_Notes.xlsx)

[V1.1](https://github.com/plantbreeding/API/tree/brapi-V1.1) | Archived | Jan 26, 2018 |                                                                          | [Archive-1.1](https://brapiarchive11.docs.apiary.io/#) | [Release Notes](https://github.com/plantbreeding/API/releases/tag/V1.1) / [Change File](https://github.com/plantbreeding/API/files/1668289/BrAPI_V1-1_Release_Notes.xlsx)

[V1.0](https://github.com/plantbreeding/API/tree/brapi-V1.0) | Archived | Nov 13, 2017 |                                                                          | [Archive-1.0](https://brapiarchive10.docs.apiary.io/#) | [Release Notes](https://github.com/plantbreeding/API/releases/tag/V1.0)

## General Reference Documentation

- [URL Structure](https://wiki.brapi.org/index.php/RESTfulness)

- [Response Structure](https://wiki.brapi.org/index.php/Response_Structure)

- [Date/Time Encoding](https://wiki.brapi.org/index.php/Dates_and_Times)

- [Location Encoding](https://wiki.brapi.org/index.php/Location_Coordinates)

- [Error Handling](https://wiki.brapi.org/index.php/Error_Handling)

- [Search Services](https://wiki.brapi.org/index.php/Search_Services)

## Resources

[Brapi.org](https://brapi.org) - The home of all things BrAPI

[BrAPI On Apiary](https://brapi.docs.apiary.io/#) - Apiary documentation of BrAPI

[BrAPI On SwaggerHub](https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI) - SwaggerHub documentation of BrAPI

[BrAPI Community Forum](https://forum.brapi.org) - Consult with BrAPI experts from all over the world

[BRAVA](http://webapps.ipk-gatersleben.de/brapivalidator/) - Test your BrAPI Server with this robust test client

[BrAPI Test Server](https://test-server.brapi.org) - Test your BrAPI Client against sample data