Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BrAPI extraction improvements #2

Open
9 tasks done
gcornut opened this issue Oct 18, 2017 · 0 comments
Open
9 tasks done

BrAPI extraction improvements #2

gcornut opened this issue Oct 18, 2017 · 0 comments
Assignees
Milestone

Comments

@gcornut
Copy link
Contributor

gcornut commented Oct 18, 2017

TODO:

  • Describe BrAPI object (identifier, list calls, detail call, links to other objects)
  • Flexible BrAPI extraction
    • Check /brapi/v1/calls call for implemented calls
    • Error handling by BrAPI source (if required call not implemented)
  • Download BrAPI objects list (ex: /brapi/v1/studies-search) and for each:
    • Download object details (if any) (ex: /brapi/v1/studies/{studyDbId})
    • Download object links (if any) (ex: /brapi/v1/studies/{studyDbId}/germplasm)
  • Create reversed links (ex: if study -> germplasm then create germplasm -> study)
  • [ ] (Optional) Create BrAPI object index (ID => JSON File, File offset to object)
  • Report per data source (WARNINGS & ERRORS) on required BrAPI calls and required fields, required entity links, etc.
  • [ ] Basic JSON validation (minimum fields required, minimum links between objects) (moved to elasticsearch transform)

Extracting link from BrAPI object to another:

  1. GET object (ex: /brapi/v1/studies/1)
{ "studyDbId": "1", "studyName": "Study 1" }
  1. GET linked objects (ex: /brapi/v1/studies/1/germplasm)
{ "germplasmDbId": "1", "germplasmName": "Germplasm 1" },
{ "germplasmDbId": "2", "germplasmName": "Germplasm 2" }
  1. Add linked object ids to parent object
{ "studyDbId": "1", "studyName": "Study 1", "germplasmDbIds": ["1", "2"]}
  1. Generate reversed links
{ "germplasmDbId": "1", "germplasmName": "Germplasm 1", "studyDbIds": ["1"] },
{ "germplasmDbId": "2", "germplasmName": "Germplasm 2", "studyDbIds": ["1"] }
@gcornut gcornut self-assigned this Mar 7, 2018
@gcornut gcornut added this to the v1 milestone Mar 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant