Try   HackMD

Breeding API (BrAPI) Team

The objective of this is to document the work, progress and efforts of the team during the Codefest. Members of the team should be able to check in to this document to find project details, instructions, design descriptions, etc. as needed fo the Codefest activities.

Team Lead

Name Organization Contact Time Zone
Valentin Guignon Bioversity & CGIAR v.guignon@cgiar.org European Central

Members

Name Organization Contact Time Zone
Lilia Mesina liliamesina@gmail.com Canada Mountain
Sook Jung Washington State Univ. sook_jung@wsu.edu US Eastern
Menolin Sharma Univ. of Deleware (Bradyrhizobia) menolin@udel.edu US Eastern
Taein Lee Washington State Univ. leetaei@wsu.edu US Pacific

Schedule

Team leaders should reach out prior to Jan 11-15th to schedule team meetings when members can meet to discuss project objectives and divide work.

Date Time Where
GatherTown BreedersAPI Room

Plans

Core Objectives

  • Help to setup BrAPI on your Tripal instances
  • Create a Tripal 4 compatible version that share some code with T2-3 version for calls implementation
  • Upgrade current BrAPI module implementation to BrAPI v2 as much as possible

Task list

  • clear Drupal issue queue at https://www.drupal.org/project/issues/brapi?categories=All vguignon
  • create a complete the table for call implementation status below:
    • call name
    • supported BrAPI call versions
    • Tripal v2-3 implementation status
    • Tripal v4 implementation status
    • priority level (high, normal, low)
    • who needs it (name or lab)
    • who is working on it
  • setup your own dev environment for BrAPI
  • create a BrAPI skeleton module for Tripal 4 and see what can be "bridged" with T4/D9 features
  • transfer existing BrAPI call implementations for Tripal 2-3 to Tripal 4 module
  • start working on call implementation update (for all versions)
  • complete documentation according to needs
    • setup a "read-the-doc"?
    • list items to document

Call implemtation status

Call name versions T2-T3 T4 Priority Notes Needed by Assigned to Issue
/ (root call) 1.0-1.3 yes no medium not official Bioversity, all vguignon
/calls 1.0-1.3 yes no high replaced by /serverinfo call on v2 Bioversity, all vguignon
/serverinfo 2.0 no no high port of call from v1.x Bioversity, all vguignon
to complete 1.0-2.0 n/a no low somelab yourself #123
1.0-2.0 yes/no yes/no/ n/a high/medium/low/done me,you,lab,whoever somebody/nobody #123

Organization

When you want to handle a task, create an issue at https://github.com/tripal/brapi/issues and assign it to yourself. If it is part of the task list here or call implementations in the table above, write down your name there as well and add the issue link.
For direct communication (questions, comments,) use slack channel #brapi on Tripal Project's slack: https://tripal-project.slack.com/archives/CF9V50M7W
Keep in mind we are in different timezones which may lead to delayed answers.

Accomplishments

Once the Codefest week is over, here is where the team documents the accomplishments that were made during the week!

Orientation for resources

Current github (via Tripal): https://github.com/tripal/brapi
Drupal project page: https://www.drupal.org/project/brapi
Issue queue: https://github.com/tripal/brapi/issues
Official BrAPI site: https://brapi.org/
BrAPI specifications: https://brapi.org/specification
BrAPI v2 specs on Swagger: https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Core/2.0#/
See example of BrAPI calls and answers (obsolete v1.0-1.3): https://www.crop-diversity.org/mgis/brapi/query