From e738468ad4988ba98aae968a785d4d96ff3523b5 Mon Sep 17 00:00:00 2001 From: Peter Selby Date: Mon, 23 Oct 2017 13:34:09 -0400 Subject: [PATCH 1/3] First pass at standardizing pagination information --- Specification/Calls/Calls.md | 10 +++++----- Specification/Crops/ListCrops.md | 10 ++++++---- Specification/GenomeMaps/GenomeMapData.md | 10 ++++++---- .../GenomeMapDataByRangeOnLinkageGroup.md | 10 ++++++---- Specification/GenomeMaps/ListOfGenomeMaps.md | 13 ++++++++----- Specification/Germplasm/GermplasmSearchGET.md | 14 +++++++------- Specification/Germplasm/GermplasmSearchPOST.md | 6 +++--- .../GermplasmAttributeValuesByGermplasmDbId.md | 8 ++++---- .../ListAttributeCategories.md | 4 ++-- .../ListAttributesByAttributeCategoryDbId.md | 14 ++++++++------ Specification/Locations/ListLocations.md | 16 ++++++++-------- .../MarkerProfiles/MarkerProfileAlleleMatrix.md | 2 +- .../MarkerProfiles/MarkerProfileData.md | 4 ++-- .../MarkerProfiles/MarkerProfileSearch.md | 4 ++-- .../MarkerProfiles/MarkerProfileSearchPost.md | 4 ++-- .../Markers/MarkerDetailsByMarkerDbId.md | 8 ++++---- Specification/Markers/MarkerSearch.md | 6 +++--- .../ObservationVariables/VariableDataTypeList.md | 7 +++++-- .../ObservationVariables/VariableList.md | 6 +++--- .../ObservationVariables/VariableOntologyList.md | 6 +++--- .../ObservationVariables/VariableSearch.md | 2 +- Specification/Phenotypes/PhenotypeSearch.md | 8 ++++---- Specification/Programs/ListPrograms.md | 6 +++--- Specification/README.md | 6 +++--- ...etObservationUnitsByObservationVariableIds.md | 12 +++++++----- Specification/Studies/ListObservationLevels.md | 7 +++++-- Specification/Studies/ListSeasons.md | 6 +++--- Specification/Studies/ListStudySummaries.md | 6 +++--- Specification/Studies/ListStudyTypes.md | 6 +++--- Specification/Studies/ObservationUnitDetails.md | 8 +++++--- Specification/Studies/PlotLayoutDetails.md | 8 +++++--- Specification/Studies/SearchStudies.md | 10 ++++++---- Specification/Studies/Seasons.md | 6 +++--- Specification/Traits/ListAllTraits.md | 11 +++++++---- Specification/Trials/ListTrialSummaries.md | 6 +++--- 35 files changed, 149 insertions(+), 121 deletions(-) diff --git a/Specification/Calls/Calls.md b/Specification/Calls/Calls.md index 6ab0fd37..b704cf58 100644 --- a/Specification/Calls/Calls.md +++ b/Specification/Calls/Calls.md @@ -20,18 +20,18 @@ Used by: Flapjack ### Call search [GET] + Parameters - + datatype (optional, string, `tsv`) ... The data type supported by the call - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + datatype (optional, string, `tsv`) ... The data type supported by the call + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata": { "pagination" : { - "totalCount" : 7, + "totalCount" : 8, "currentPage" : 0, "totalPages" : 1, - "pageSize" : "10" + "pageSize" : 1000 }, "datafiles" : [] }, diff --git a/Specification/Crops/ListCrops.md b/Specification/Crops/ListCrops.md index 7d669588..237a7a90 100644 --- a/Specification/Crops/ListCrops.md +++ b/Specification/Crops/ListCrops.md @@ -3,16 +3,18 @@ Scope: CORE. Status: ACCEPTED. ### List supported crops [GET] - ++ Parameters + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata": { "pagination": { - "pageSize": 2, + "pageSize": 1000, "currentPage": 0, - "totalCount": 100, - "totalPages": 50 + "totalCount": 3, + "totalPages": 1 }, "status" : [], "datafiles": [] diff --git a/Specification/GenomeMaps/GenomeMapData.md b/Specification/GenomeMaps/GenomeMapData.md index a4d25368..e47660c6 100644 --- a/Specification/GenomeMaps/GenomeMapData.md +++ b/Specification/GenomeMaps/GenomeMapData.md @@ -13,16 +13,18 @@ markers ordered by linkageGroup and position + Parameters + mapDbId (required, string, `6`) ... unique id of the map + linkageGroupId (optional, string, `123`) ... the linkage group id + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination" : { - "pageSize": 30, - "currentPage": 2, - "totalCount": 40, - "totalPages":2 + "pageSize": 1000, + "currentPage": 0, + "totalCount": 2, + "totalPages": 1 }, "status": [], "datafiles": [] diff --git a/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md b/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md index 55ff97c0..b589c460 100644 --- a/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md +++ b/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md @@ -9,16 +9,18 @@ markers ordered by linkageGroup and position + linkageGroupId (required, string) + min (optional) ... minimum position on linkage group + max (optional) ... maximumn position on linkage group + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination" : { - "pageSize": 30, - "currentPage": 2, - "totalCount": 40, - "totalPages":2 + "pageSize": 1000, + "currentPage": 0, + "totalCount": 2, + "totalPages": 1 }, "status" : [], "datafiles": [] diff --git a/Specification/GenomeMaps/ListOfGenomeMaps.md b/Specification/GenomeMaps/ListOfGenomeMaps.md index fe9bd845..c03f30f3 100644 --- a/Specification/GenomeMaps/ListOfGenomeMaps.md +++ b/Specification/GenomeMaps/ListOfGenomeMaps.md @@ -11,16 +11,19 @@ Get list of maps do we need list of parents and specify mapping population? ### Get list of maps [GET] - ++ Parameters + + species (optional, string, ``) ... Species + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination" : { - "pageSize": 30, - "currentPage": 2, - "totalCount": 40, - "totalPages": 2 + "pageSize": 1000, + "currentPage": 0, + "totalCount": 2, + "totalPages": 1 } "status" : [], "datafiles": [] diff --git a/Specification/Germplasm/GermplasmSearchGET.md b/Specification/Germplasm/GermplasmSearchGET.md index 9972e5ee..67267d3e 100644 --- a/Specification/Germplasm/GermplasmSearchGET.md +++ b/Specification/Germplasm/GermplasmSearchGET.md @@ -46,11 +46,11 @@ Adresses these needs: Use GET when parameter size is less than 2K bytes. + Parameters - + germplasmPUI (optional, text, `http://data.inra.fr/accession/234Col342`) ... Permanent unique identifier (DOI, URI, etc.) - + germplasmDbId (optional, text, `986`) ... Internal database identifier - + germplasmName (optional, text, `Pah`, `Pahang`) ... Name of the germplasm - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + germplasmPUI (optional, text, `http://data.inra.fr/accession/234Col342`) ... Permanent unique identifier (DOI, URI, etc.) + + germplasmDbId (optional, text, `986`) ... Internal database identifier + + germplasmName (optional, text, `Pah`, `Pahang`) ... Name of the germplasm + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) @@ -59,8 +59,8 @@ Use GET when parameter size is less than 2K bytes. "status": [], "datafiles": [], "pagination": { - "pageSize": 10, - "currentPage": 1, + "pageSize": 1000, + "currentPage": 0, "totalCount": 2, "totalPages": 1 } diff --git a/Specification/Germplasm/GermplasmSearchPOST.md b/Specification/Germplasm/GermplasmSearchPOST.md index 54ba7a6f..f98fff33 100644 --- a/Specification/Germplasm/GermplasmSearchPOST.md +++ b/Specification/Germplasm/GermplasmSearchPOST.md @@ -22,10 +22,10 @@ Use POST for large queries (>2K bytes). "status": [], "datafiles": [], "pagination": { - "pageSize": 10, + "pageSize": 100, "currentPage": 1, - "totalCount": 2, - "totalPages": 1 + "totalCount": 102, + "totalPages": 2 } }, "result": { diff --git a/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md b/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md index 1fd4e43f..cb118bba 100644 --- a/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md +++ b/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md @@ -1,4 +1,4 @@ -## Germplasm attribute values by germplasmDbId [/brapi/v1/germplasm/{germplasmDbId}/attributes?attributeList={attributeDbId},{attributeDbId}&pageSize=&page=] +## Germplasm attribute values by germplasmDbId [/brapi/v1/germplasm/{germplasmDbId}/attributes?attributeList={attributeDbId},{attributeDbId}&pageSize={pageSize}&page={page}] Status: ACCEPTED.] @@ -15,9 +15,9 @@ Values for all attributes by default. { "metadata" : { "pagination": { - "pageSize": 10, - "currentPage": 1, - "totalCount": 10, + "pageSize": 1000, + "currentPage": 0, + "totalCount": 1, "totalPages": 1 }, "status": [], diff --git a/Specification/GermplasmAttributes/ListAttributeCategories.md b/Specification/GermplasmAttributes/ListAttributeCategories.md index fe577fcf..eb2fdf57 100644 --- a/Specification/GermplasmAttributes/ListAttributeCategories.md +++ b/Specification/GermplasmAttributes/ListAttributeCategories.md @@ -1,4 +1,4 @@ -## List attribute categories [/brapi/v1/attributes/categories/?pageSize=10&page=2] +## List attribute categories [/brapi/v1/attributes/categories/?pageSize={pageSize}&page={page}] Scope: OTHER. Status: ACCEPTED. Implementation target date: PAG2016 @@ -15,7 +15,7 @@ List all available attribute categories. "pagination": { "pageSize": 10, "currentPage": 1, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md b/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md index 0d63a7be..ff618428 100644 --- a/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md +++ b/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md @@ -1,4 +1,4 @@ -## List attributes available [/brapi/v1/attributes?attributeCategoryDbId=2] +## List attributes available [/brapi/v1/attributes?attributeCategoryDbId={attributeCategoryDbId}&pageSize={pageSize}&page={page}] Scope: OTHER. Status: ACCEPTED. Implementation target date: PAG2016 @@ -17,16 +17,18 @@ List available attributes. |datatype|string|e.g. Categorical, Numeric, Boolean|| |values|array of string|array of all possible values for this attribute|Y| + Parameters - + attributeCategoryDbId (optional, string, `2`) ... filter for kind of attributes + + attributeCategoryDbId (optional, string, `2`) ... filter for kind of attributes + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination": { - "pageSize": 10, - "currentPage": 1, - "totalCount": 10000, - "totalPages": 1000 + "pageSize": 1000, + "currentPage": 0, + "totalCount": 1, + "totalPages": 1 }, "status": [], "datafiles": [] diff --git a/Specification/Locations/ListLocations.md b/Specification/Locations/ListLocations.md index 64494fef..bc52deec 100644 --- a/Specification/Locations/ListLocations.md +++ b/Specification/Locations/ListLocations.md @@ -1,4 +1,4 @@ -## List Locations [/brapi/v1/locations?locationType={locationType}] +## List Locations [/brapi/v1/locations?locationType={locationType}&pageSize={pageSize}&page={page}] Implemented by: Germinate @@ -12,19 +12,19 @@ Get a list of locations. ### List locations [GET] + Parameters - + locationType (optional, string, `Breeding Locations`) - Filter by location type specified. - + page (optional, int, `2282`) - request a specific response page - + pageSize (optional, int, `5000`) - request a non-default page size (1000 is default) + + locationType (optional, string, `Breeding Locations`) - Filter by location type specified. + + page (optional, int, `2282`) - request a specific response page + + pageSize (optional, int, `5000`) - request a non-default page size (1000 is default) + Response 200 (application/json) { "metadata": { "pagination": { - "currentPage": 1, - "pageSize": 2, - "totalCount": 100, - "totalPages": 50 + "currentPage": 0, + "pageSize": 1000, + "totalCount": 2, + "totalPages": 1 }, "status" : [], "datafiles": [] diff --git a/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md b/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md index 68c1b2a7..3ee99c5e 100644 --- a/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md +++ b/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md @@ -34,7 +34,7 @@ This method may support asynchronous processing. { "metadata": { "pagination": { - "pageSize": 100, + "pageSize": 1000, "currentPage": 0, "totalCount": 1, "totalPages": 1 diff --git a/Specification/MarkerProfiles/MarkerProfileData.md b/Specification/MarkerProfiles/MarkerProfileData.md index 242815fc..c21e892d 100644 --- a/Specification/MarkerProfiles/MarkerProfileData.md +++ b/Specification/MarkerProfiles/MarkerProfileData.md @@ -49,9 +49,9 @@ Alphabetically? { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 1, "totalPages": 1 }, "status": [], diff --git a/Specification/MarkerProfiles/MarkerProfileSearch.md b/Specification/MarkerProfiles/MarkerProfileSearch.md index 0372b371..0e9d688c 100644 --- a/Specification/MarkerProfiles/MarkerProfileSearch.md +++ b/Specification/MarkerProfiles/MarkerProfileSearch.md @@ -22,9 +22,9 @@ For the requested Germplasm Id and/or Extract Id, returns the Markerprofile Id a { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/MarkerProfiles/MarkerProfileSearchPost.md b/Specification/MarkerProfiles/MarkerProfileSearchPost.md index 284087a3..f79ebcdc 100644 --- a/Specification/MarkerProfiles/MarkerProfileSearchPost.md +++ b/Specification/MarkerProfiles/MarkerProfileSearchPost.md @@ -18,9 +18,9 @@ For the requested Germplasm Ids and/or Extract Ids, returns the Markerprofile Id { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/Markers/MarkerDetailsByMarkerDbId.md b/Specification/Markers/MarkerDetailsByMarkerDbId.md index 9b6796cc..eb884d38 100644 --- a/Specification/Markers/MarkerDetailsByMarkerDbId.md +++ b/Specification/Markers/MarkerDetailsByMarkerDbId.md @@ -26,10 +26,10 @@ Implemented By: { "metadata": { "pagination": { - "pageSize": 100, - "currentPage": 1, - "totalCount": 1, - "totalPages": 1 + "pageSize": 0, + "currentPage": 0, + "totalCount": 0, + "totalPages": 0 }, "status": [], "datafiles": [], diff --git a/Specification/Markers/MarkerSearch.md b/Specification/Markers/MarkerSearch.md index bdacab7a..e3d564dc 100644 --- a/Specification/Markers/MarkerSearch.md +++ b/Specification/Markers/MarkerSearch.md @@ -39,9 +39,9 @@ For the requested name or synonym, returns an array (possibly empty) of marker r "metadata": { "pagination": { "pageSize": 1000, - "currentPage": 10, - "totalCount": 27338, - "totalPages": 28 + "currentPage": 0, + "totalCount": 2, + "totalPages": 1 }, "status": [], "datafiles": [] diff --git a/Specification/ObservationVariables/VariableDataTypeList.md b/Specification/ObservationVariables/VariableDataTypeList.md index 55ba0b22..e6b1fb23 100644 --- a/Specification/ObservationVariables/VariableDataTypeList.md +++ b/Specification/ObservationVariables/VariableDataTypeList.md @@ -1,15 +1,18 @@ -## Variable data type list [/brapi/v1/variables/datatypes] +## Variable data type list [/brapi/v1/variables/datatypes&pageSize={pageSize}&page={page}] Call to retrieve a list of data types the variable can have. ### Variable data type list [GET] ++ Parameters + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata": { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, "totalCount": 6, "totalPages": 1 diff --git a/Specification/ObservationVariables/VariableList.md b/Specification/ObservationVariables/VariableList.md index d205d4d1..f688f85b 100644 --- a/Specification/ObservationVariables/VariableList.md +++ b/Specification/ObservationVariables/VariableList.md @@ -16,10 +16,10 @@ Call to retrieve a list of observationVariables available in the system. { "metadata": { "pagination": { - "pageSize": 2, + "pageSize": 1000, "currentPage": 0, - "totalCount": 300, - "totalPages": 100 + "totalCount": 2, + "totalPages": 1 }, "status": [], "datafiles": [] diff --git a/Specification/ObservationVariables/VariableOntologyList.md b/Specification/ObservationVariables/VariableOntologyList.md index 918595f6..4af38dfe 100644 --- a/Specification/ObservationVariables/VariableOntologyList.md +++ b/Specification/ObservationVariables/VariableOntologyList.md @@ -15,10 +15,10 @@ Call to retrieve a list of observation variable ontologies available in the syst { "metadata": { "pagination": { - "pageSize": 2, + "pageSize": 1000, "currentPage": 0, - "totalCount": 12, - "totalPages": 6 + "totalCount": 2, + "totalPages": 1 }, "status": [], "datafiles": [] diff --git a/Specification/ObservationVariables/VariableSearch.md b/Specification/ObservationVariables/VariableSearch.md index 994b540b..08099afe 100644 --- a/Specification/ObservationVariables/VariableSearch.md +++ b/Specification/ObservationVariables/VariableSearch.md @@ -29,7 +29,7 @@ Search observation variables. "pageSize": 2, "currentPage": 0, "totalCount": 300, - "totalPages": 100 + "totalPages": 150 }, "status": [], "datafiles": [] diff --git a/Specification/Phenotypes/PhenotypeSearch.md b/Specification/Phenotypes/PhenotypeSearch.md index 43b32920..12b61746 100644 --- a/Specification/Phenotypes/PhenotypeSearch.md +++ b/Specification/Phenotypes/PhenotypeSearch.md @@ -73,10 +73,10 @@ observationValue data type inferred from the ontology { "metadata": { "pagination": { - "pageSize": 10, - "currentPage": 0, - "totalCount": 10, - "totalPages": 1 + "pageSize": 100, + "currentPage": 1, + "totalCount": 102, + "totalPages": 2 }, "status": [], "datafiles": [] diff --git a/Specification/Programs/ListPrograms.md b/Specification/Programs/ListPrograms.md index 9437a862..54c09e91 100644 --- a/Specification/Programs/ListPrograms.md +++ b/Specification/Programs/ListPrograms.md @@ -1,4 +1,4 @@ -## Program list [/brapi/v1/programs?programName={programName}&abbreviation={abbreviation}&pageSize=&page=] +## Program list [/brapi/v1/programs?programName={programName}&abbreviation={abbreviation}&pageSize={pageSize}&page={page}] Call to retrieve a list of programs. Status: ACCEPTED @@ -17,9 +17,9 @@ Implemented By: { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/README.md b/Specification/README.md index 22d23ddc..42e39188 100644 --- a/Specification/README.md +++ b/Specification/README.md @@ -115,9 +115,9 @@ The BRAPI response payload, which is contained in the "result" key, allows for t { "metadata" : { "pagination" : { - "totalCount" : 0, - "pageSize" : 0, - "totalPages" : 0, + "totalCount" : 6, + "pageSize" : 1000, + "totalPages" : 1, "currentPage" : 0 }, "status" : [ ], diff --git a/Specification/Studies/GetObservationUnitsByObservationVariableIds.md b/Specification/Studies/GetObservationUnitsByObservationVariableIds.md index 622a819c..71f6999a 100644 --- a/Specification/Studies/GetObservationUnitsByObservationVariableIds.md +++ b/Specification/Studies/GetObservationUnitsByObservationVariableIds.md @@ -1,4 +1,4 @@ -## Get Observation Units by observation variable ids [/brapi/v1/studies/{studyDbId}/observations?observationVariableDbIds={observationVariableDbIds}] +## Get Observation Units by observation variable ids [/brapi/v1/studies/{studyDbId}/observations?observationVariableDbIds={observationVariableDbIds}&pageSize={pageSize}&page={page}] Scope: CORE. Status: ACCEPTED. Implementation target date: PAG2016 @@ -10,16 +10,18 @@ observationTimestamp should be ISO8601 format with timezone: YYYY-MM-DDThh:mm:ss ### Get Observation Units by observation variable ids [GET] + Parameters - + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. - + observationVariableDbId (required, number, `2` ... Numeric `id` of that variable (combination of trait, unit and method) + + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. + + observationVariableDbId (required, number, `2` ... Numeric `id` of that variable (combination of trait, unit and method) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination" : { - "pageSize":20, - "currentPage":1, + "pageSize": 1000, + "currentPage": 0, "totalCount": 1, "totalPages": 1 }, diff --git a/Specification/Studies/ListObservationLevels.md b/Specification/Studies/ListObservationLevels.md index 4f5a492d..7bb3aefe 100644 --- a/Specification/Studies/ListObservationLevels.md +++ b/Specification/Studies/ListObservationLevels.md @@ -1,17 +1,20 @@ -## List Observation Levels [/brapi/v1/observationLevels] +## List Observation Levels [/brapi/v1/observationLevels?&pageSize={pageSize}&page={page}] Call to retrieve the list of supported observation levels. Observation levels indicate the granularity level at which the measurements are taken. The values are used to supply the `observationLevel` parameter in the observation unit details call. ### List observation levels [GET] ++ Parameters + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, "totalCount": 2, "totalPages": 1 diff --git a/Specification/Studies/ListSeasons.md b/Specification/Studies/ListSeasons.md index 9f4ac80f..3c96fe8e 100644 --- a/Specification/Studies/ListSeasons.md +++ b/Specification/Studies/ListSeasons.md @@ -1,4 +1,4 @@ -## List Seasons [/brapi/v1/seasons?year=&pageSize=&page=] +## List Seasons [/brapi/v1/seasons?year={year}&pageSize={pageSize}&page={page}] Call to retrive all seasons (or years) in the database. (Added by Jan-Erik and Lukas 5/26/2016) Scope: PHENOTYPING. @@ -13,9 +13,9 @@ Scope: PHENOTYPING. { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/Studies/ListStudySummaries.md b/Specification/Studies/ListStudySummaries.md index e2acdf90..745276c6 100644 --- a/Specification/Studies/ListStudySummaries.md +++ b/Specification/Studies/ListStudySummaries.md @@ -31,10 +31,10 @@ StartDate and endDate should be ISO8601 format for dates: YYYY-MM-DD { "metadata": { "pagination": { - "pageSize": 2, + "pageSize": 1000, "currentPage": 0, - "totalCount": 100, - "totalPages": 50 + "totalCount": 2, + "totalPages": 1 }, "status" : [], "datafiles": [] diff --git a/Specification/Studies/ListStudyTypes.md b/Specification/Studies/ListStudyTypes.md index d3a17df1..14c4476d 100644 --- a/Specification/Studies/ListStudyTypes.md +++ b/Specification/Studies/ListStudyTypes.md @@ -1,4 +1,4 @@ -## List Study Types [/brapi/v1/studyTypes?pageSize=&page=] +## List Study Types [/brapi/v1/studyTypes?pageSize={pageSize}&page={page}] Call to retrieve the list of study types. @@ -15,9 +15,9 @@ Implementation target date: PAG2016 { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 3, "totalPages": 1 }, "status": [], diff --git a/Specification/Studies/ObservationUnitDetails.md b/Specification/Studies/ObservationUnitDetails.md index d714fb31..640ae0f8 100644 --- a/Specification/Studies/ObservationUnitDetails.md +++ b/Specification/Studies/ObservationUnitDetails.md @@ -1,4 +1,4 @@ -## Observation Unit Details [/brapi/v1/studies/{studyDbId}/observationunits?observationLevel={observationLevel}] +## Observation Unit Details [/brapi/v1/studies/{studyDbId}/observationunits?observationLevel={observationLevel}&pageSize={pageSize}&page={page}] The main API call for field data collection, to retrieve all the observation units within a study. @@ -7,15 +7,17 @@ Scope: PHENOTYPING ### Get all observation units [GET] + Parameters - + observationLevel (required, string, `plot`) ... The granularity level of observation units. + + observationLevel (required, string, `plot`) ... The granularity level of observation units. Either `plotNumber` or `plantNumber` fields will be relavant depending on whether granularity is plot or plant respectively. + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, "totalCount": 2, "totalPages": 1 diff --git a/Specification/Studies/PlotLayoutDetails.md b/Specification/Studies/PlotLayoutDetails.md index 1aed42d1..ae0f14f1 100644 --- a/Specification/Studies/PlotLayoutDetails.md +++ b/Specification/Studies/PlotLayoutDetails.md @@ -1,4 +1,4 @@ -## Plot Layout Details [/brapi/v1/studies/{studyDbId}/layout] +## Plot Layout Details [/brapi/v1/studies/{studyDbId}/layout?pageSize={pageSize}&page={page}] Scope: PHENOTYPING. Status: ACCEPTED. Implementation target date: PAG2016 @@ -9,14 +9,16 @@ Retrieve the plot layout of the study with id {id}. ### Retrieve plot layout details [GET] + Parameters - + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. + + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination": { - "pageSize": 1, + "pageSize": 1000, "currentPage": 0, "totalCount": 1, "totalPages": 1 diff --git a/Specification/Studies/SearchStudies.md b/Specification/Studies/SearchStudies.md index c444e318..3c52e63e 100644 --- a/Specification/Studies/SearchStudies.md +++ b/Specification/Studies/SearchStudies.md @@ -17,7 +17,9 @@ Scope: PHENOTYPING "observationVariableDbIds": ["CO-PH-123", "Var-123"] "active" : "true", "sortBy" : "studyDbId", - "sortOrder" : "desc" + "sortOrder" : "desc", + "pageSize": 1000, + "page": 0, } + Response 200 (application/json) @@ -25,10 +27,10 @@ Scope: PHENOTYPING { "metadata": { "pagination": { - "pageSize": 2, + "pageSize": 1000, "currentPage": 0, - "totalCount": 100, - "totalPages": 50 + "totalCount": 2, + "totalPages": 1 }, "status" : [], "datafiles": [] diff --git a/Specification/Studies/Seasons.md b/Specification/Studies/Seasons.md index 6e700c70..a6fb1859 100644 --- a/Specification/Studies/Seasons.md +++ b/Specification/Studies/Seasons.md @@ -1,4 +1,4 @@ -## Seasons [/brapi/v1/seasons?year=&pageSize=&page=] +## Seasons [/brapi/v1/seasons?year={year}&pageSize={pageSize}&page={page}] Call to retrive all seasons (or years) in the database. (Added by Jan-Erik and Lukas 5/26/2016) @@ -14,9 +14,9 @@ Scope: PHENOTYPING { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/Traits/ListAllTraits.md b/Specification/Traits/ListAllTraits.md index 9cb27d3a..251b8193 100644 --- a/Specification/Traits/ListAllTraits.md +++ b/Specification/Traits/ListAllTraits.md @@ -1,4 +1,4 @@ -## List all Traits [/brapi/v1/traits] +## List all Traits [/brapi/v1/traits?pageSize={pageSize}&page={page}] Scope: CORE. Status: ACCEPTED. @@ -7,15 +7,18 @@ Implemented by: Germinate, Cassavabase Call to retrieve a list of traits available in the system and their associated variables. ### List all traits [GET] ++ Parameters + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `10`) ... Which result page is requested + Response 200 (application/json) { "metadata" : { "pagination" : { - "pageSize": 3, + "pageSize": 1000, "currentPage": 0, - "totalCount": 300, - "totalPages": 100 + "totalCount": 2, + "totalPages": 1 } "status" : [], "datafiles": [] diff --git a/Specification/Trials/ListTrialSummaries.md b/Specification/Trials/ListTrialSummaries.md index 19c69732..3adc6f3b 100644 --- a/Specification/Trials/ListTrialSummaries.md +++ b/Specification/Trials/ListTrialSummaries.md @@ -37,10 +37,10 @@ Implementation target date: PAG2016. { "metadata": { "pagination": { - "pageSize": 2, + "pageSize": 1000, "currentPage": 0, - "totalCount": 100, - "totalPages": 50 + "totalCount": 1, + "totalPages": 1 }, "status" : [], "datafiles": [] From a29189cd28f5a23aa54e4d4880870ef0dab271ac Mon Sep 17 00:00:00 2001 From: Peter Selby Date: Tue, 24 Oct 2017 16:09:08 -0400 Subject: [PATCH 2/3] made page and pageSize descriptions consistent --- Specification/Calls/Calls.md | 2 +- Specification/Crops/ListCrops.md | 7 ++++--- Specification/GenomeMaps/GenomeMapData.md | 3 ++- .../GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md | 3 ++- Specification/GenomeMaps/ListOfGenomeMaps.md | 3 ++- Specification/Germplasm/GermplasmSearchGET.md | 3 ++- .../GermplasmAttributeValuesByGermplasmDbId.md | 4 ++-- .../GermplasmAttributes/ListAttributeCategories.md | 4 ++-- .../ListAttributesByAttributeCategoryDbId.md | 3 ++- Specification/Locations/ListLocations.md | 4 ++-- .../MarkerProfiles/MarkerProfileAlleleMatrix.md | 6 +++--- Specification/MarkerProfiles/MarkerProfileData.md | 2 +- Specification/MarkerProfiles/MarkerProfileSearch.md | 4 ++-- .../MarkerProfiles/MarkerProfileSearchPost.md | 4 ++-- Specification/Markers/MarkerSearch.md | 5 +++-- .../ObservationVariables/VariableDataTypeList.md | 5 +++-- Specification/ObservationVariables/VariableList.md | 4 ++-- .../ObservationVariables/VariableOntologyList.md | 4 ++-- Specification/Programs/ListPrograms.md | 4 ++-- Specification/Programs/ProgramSearch.md | 4 ++-- .../GetObservationUnitsByObservationVariableIds.md | 2 +- Specification/Studies/ListObservationLevels.md | 4 ++-- Specification/Studies/ListSeasons.md | 5 +++-- Specification/Studies/ListStudySummaries.md | 4 ++-- Specification/Studies/ListStudyTypes.md | 4 ++-- Specification/Studies/ObservationUnitDetails.md | 4 ++-- Specification/Studies/PlotLayoutDetails.md | 4 ++-- Specification/Studies/Seasons.md | 5 +++-- Specification/Studies/StudyGermplasmDetails.md | 12 ++++++------ .../Studies/StudyObservationUnitsAsTable.md | 6 +++--- Specification/Studies/StudyObservationVariables.md | 8 ++++---- Specification/Traits/ListAllTraits.md | 5 +++-- Specification/Trials/ListTrialSummaries.md | 12 ++++++------ 33 files changed, 82 insertions(+), 71 deletions(-) diff --git a/Specification/Calls/Calls.md b/Specification/Calls/Calls.md index b704cf58..7407223c 100644 --- a/Specification/Calls/Calls.md +++ b/Specification/Calls/Calls.md @@ -22,7 +22,7 @@ Used by: Flapjack + Parameters + datatype (optional, string, `tsv`) ... The data type supported by the call + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) { diff --git a/Specification/Crops/ListCrops.md b/Specification/Crops/ListCrops.md index 237a7a90..01998ac7 100644 --- a/Specification/Crops/ListCrops.md +++ b/Specification/Crops/ListCrops.md @@ -1,11 +1,12 @@ -## List supported crops [/brapi/v1/crops] +## List supported crops [/brapi/v1/crops?pageSize={pageSize}&page={page}] Scope: CORE. Status: ACCEPTED. ### List supported crops [GET] + Parameters - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/GenomeMaps/GenomeMapData.md b/Specification/GenomeMaps/GenomeMapData.md index e47660c6..31184143 100644 --- a/Specification/GenomeMaps/GenomeMapData.md +++ b/Specification/GenomeMaps/GenomeMapData.md @@ -14,7 +14,8 @@ markers ordered by linkageGroup and position + mapDbId (required, string, `6`) ... unique id of the map + linkageGroupId (optional, string, `123`) ... the linkage group id + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) diff --git a/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md b/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md index b589c460..86fd8b8b 100644 --- a/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md +++ b/Specification/GenomeMaps/GenomeMapDataByRangeOnLinkageGroup.md @@ -10,7 +10,8 @@ markers ordered by linkageGroup and position + min (optional) ... minimum position on linkage group + max (optional) ... maximumn position on linkage group + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) diff --git a/Specification/GenomeMaps/ListOfGenomeMaps.md b/Specification/GenomeMaps/ListOfGenomeMaps.md index c03f30f3..a5c48850 100644 --- a/Specification/GenomeMaps/ListOfGenomeMaps.md +++ b/Specification/GenomeMaps/ListOfGenomeMaps.md @@ -14,7 +14,8 @@ do we need list of parents and specify mapping population? + Parameters + species (optional, string, ``) ... Species + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/Germplasm/GermplasmSearchGET.md b/Specification/Germplasm/GermplasmSearchGET.md index c6095da1..6bc24020 100644 --- a/Specification/Germplasm/GermplasmSearchGET.md +++ b/Specification/Germplasm/GermplasmSearchGET.md @@ -50,7 +50,8 @@ Use GET when parameter size is less than 2K bytes. + germplasmDbId (optional, string, `986`) ... Internal database identifier + germplasmName (optional, string, `Pah`, `Pahang`) ... Name of the germplasm + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) diff --git a/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md b/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md index 4cb4f9fe..23c60650 100644 --- a/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md +++ b/Specification/GermplasmAttributes/GermplasmAttributeValuesByGermplasmDbId.md @@ -7,8 +7,8 @@ Values for all attributes by default. + Parameters + germplasmDbId (required, string, `993`) ... The germplasm characterized + attributeDbId (optional, string, `1`) ... Restrict the response to only the listed attributes. - + pageSize (optional, integer, `10000`) ... the number of attributes to return in one request, defaults to 1000. - + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The first page is 1, not 0. + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/GermplasmAttributes/ListAttributeCategories.md b/Specification/GermplasmAttributes/ListAttributeCategories.md index 36f3da4c..158ceb51 100644 --- a/Specification/GermplasmAttributes/ListAttributeCategories.md +++ b/Specification/GermplasmAttributes/ListAttributeCategories.md @@ -5,8 +5,8 @@ Implementation target date: PAG2016 ### Germplasm attribute categories [GET] List all available attribute categories. + Parameters - + pageSize (optional, integer, `10000`) Number of attributes to return in one response - + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The first page is 1, not 0. + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md b/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md index ff618428..12000e6c 100644 --- a/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md +++ b/Specification/GermplasmAttributes/ListAttributesByAttributeCategoryDbId.md @@ -19,7 +19,8 @@ List available attributes. + Parameters + attributeCategoryDbId (optional, string, `2`) ... filter for kind of attributes + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/Locations/ListLocations.md b/Specification/Locations/ListLocations.md index b2373e1c..d592b858 100644 --- a/Specification/Locations/ListLocations.md +++ b/Specification/Locations/ListLocations.md @@ -13,8 +13,8 @@ Get a list of locations. + Parameters + locationType (optional, string, `Breeding Locations`) - Filter by location type specified. - + page (optional, int, `2282`) - request a specific response page - + pageSize (optional, int, `5000`) - request a non-default page size (1000 is default) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md b/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md index 3ee99c5e..f4057f72 100644 --- a/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md +++ b/Specification/MarkerProfiles/MarkerProfileAlleleMatrix.md @@ -25,9 +25,9 @@ This method may support asynchronous processing. + expandHomozygotes (optional, boolean, `false`) ... Should homozygotes NOT be collapsed into a single occurence? + unknownString (optional, string, `-`) ... The string to use as a representation for missing data or the reserved word "empty_string". + sepPhased (optional, string, `|`) ... The string to use as a separator for phased allele calls or the reserved word "empty_string". - + sepUnphased (optional, string, `/`) ... The string to use as a separator for unphased allele calls or the reserved word "empty_string". - + pageSize (optional, integer, `1000`) ... the number of allele calls reported per response page. - + page (optional, integer, `10`) ... the requested response page + + sepUnphased (optional, string, `/`) ... The string to use as a separator for unphased allele calls or the reserved word "empty_string". + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/MarkerProfiles/MarkerProfileData.md b/Specification/MarkerProfiles/MarkerProfileData.md index 8e47b0cd..65dc6c2a 100644 --- a/Specification/MarkerProfiles/MarkerProfileData.md +++ b/Specification/MarkerProfiles/MarkerProfileData.md @@ -42,7 +42,7 @@ Alphabetically? + sepPhased (optional, string, `|`) ... The string to use as a separator for phased allele calls or the reserved word "empty_string". + sepUnphased (optional, string, `/`) ... The string to use as a separator for unphased allele calls or the reserved word "empty_string". + pageSize (optional, integer, `10000`) ... The number of allele call results (marker/allele pairs) to be returned in the response. If multiple experiments are requested, some responses will contain the last results from one experiment followed by the first results from the next. - + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The first page is 1, not 0. + + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The page indexing starts at 0 (the first page is 'page'=0) + Response 200 (application/json) diff --git a/Specification/MarkerProfiles/MarkerProfileSearch.md b/Specification/MarkerProfiles/MarkerProfileSearch.md index 06a5646c..0f8f17ba 100644 --- a/Specification/MarkerProfiles/MarkerProfileSearch.md +++ b/Specification/MarkerProfiles/MarkerProfileSearch.md @@ -1,4 +1,4 @@ -## Markerprofile search [/brapi/v1/markerprofiles?germplasm={germplasmDbId}&studyDbId={studyDbId}&sample={sampleDbId}&extract={extractDbId}&method={methodDbId}&pageSize=100&page=4] +## Markerprofile search [/brapi/v1/markerprofiles?germplasm={germplasmDbId}&studyDbId={studyDbId}&sample={sampleDbId}&extract={extractDbId}&method={methodDbId}&pageSize={pageSize}&page={page}] Scope: GENOTYPING. Status: ACCEPTED. @@ -16,7 +16,7 @@ For the requested Germplasm Id and/or Extract Id, returns the Markerprofile Id a + sampleDbId (optional, string, `184`) ... The server's internal id for the SampleDbId + extractDbId (optional, string, `84`) ... The server's internal id for the ExtractDbId + pageSize (optional, integer, `10000`) ... The number of allele call results (marker/allele pairs) to be returned in the response. If multiple experiments are requested, some responses will contain the last results from one experiment followed by the first results from the next. - + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The first page is 1, not 0. + + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The page indexing starts at 0 (the first page is 'page'=0) + Response 200 (application/json) { diff --git a/Specification/MarkerProfiles/MarkerProfileSearchPost.md b/Specification/MarkerProfiles/MarkerProfileSearchPost.md index e7f01094..592bb04c 100644 --- a/Specification/MarkerProfiles/MarkerProfileSearchPost.md +++ b/Specification/MarkerProfiles/MarkerProfileSearchPost.md @@ -1,4 +1,4 @@ -## Markerprofile search [/brapi/v1/markerprofiles-search?germplasm={germplasmDbId}&studyDbId={studyDbId}&sample={sampleDbId}&extract={extractDbId}&method={methodDbId}&pageSize=100&page=4] +## Markerprofile search [/brapi/v1/markerprofiles-search?germplasm={germplasmDbId}&studyDbId={studyDbId}&sample={sampleDbId}&extract={extractDbId}&method={methodDbId}&pageSize={pageSize}&page={page}] Scope: GENOTYPING. Status: ACCEPTED. @@ -12,7 +12,7 @@ For the requested Germplasm Ids and/or Extract Ids, returns the Markerprofile Id + sampleDbId (optional, string, `184`) ... The server's internal id for the SampleDbId + extractDbId (optional, string, `84`) ... The server's internal id for the ExtractDbId + pageSize (optional, integer, `10000`) ... The number of allele call results (marker/allele pairs) to be returned in the response. If multiple experiments are requested, some responses will contain the last results from one experiment followed by the first results from the next. - + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The first page is 1, not 0. + + page (optional, integer, `1`) ... Required if `pageSize` is given; and requires that `pageSize` be given. The page indexing starts at 0 (the first page is 'page'=0) + Response 200 (application/json) { diff --git a/Specification/Markers/MarkerSearch.md b/Specification/Markers/MarkerSearch.md index 925a2a07..5a5c7148 100644 --- a/Specification/Markers/MarkerSearch.md +++ b/Specification/Markers/MarkerSearch.md @@ -30,9 +30,10 @@ For the requested name or synonym, returns an array (possibly empty) of marker r (case sensitive), 'wildcard' (which is case insensitive). Wildcard uses both '*' and '%' for any number of characters and '?' for one character matching. Default is exact. + include (optional, string, `synonyms`) ... Whether to include synonyms in the output. - + type (optional, string, `SNP`) ... The type of the marker. + + type (optional, string, `SNP`) ... The type of the marker. + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/ObservationVariables/VariableDataTypeList.md b/Specification/ObservationVariables/VariableDataTypeList.md index e6b1fb23..d288832a 100644 --- a/Specification/ObservationVariables/VariableDataTypeList.md +++ b/Specification/ObservationVariables/VariableDataTypeList.md @@ -5,8 +5,9 @@ Call to retrieve a list of data types the variable can have. ### Variable data type list [GET] + Parameters - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/ObservationVariables/VariableList.md b/Specification/ObservationVariables/VariableList.md index f688f85b..33b2f77b 100644 --- a/Specification/ObservationVariables/VariableList.md +++ b/Specification/ObservationVariables/VariableList.md @@ -7,8 +7,8 @@ Call to retrieve a list of observationVariables available in the system. ### Variable list [GET] + Parameters - + pageSize (optional, integer, `100`) - + page (optional, integer, `0`) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + traitClass (optional, string, `Phenological`) ... Variable's trait class (phenological, physiological, morphological, etc.) + Response 200 (application/json) diff --git a/Specification/ObservationVariables/VariableOntologyList.md b/Specification/ObservationVariables/VariableOntologyList.md index 4af38dfe..4290614f 100644 --- a/Specification/ObservationVariables/VariableOntologyList.md +++ b/Specification/ObservationVariables/VariableOntologyList.md @@ -7,8 +7,8 @@ Call to retrieve a list of observation variable ontologies available in the syst ### Variable ontology list [GET] + Parameters - + pageSize (optional, integer, `1000`) - + page (optional, integer, `100`) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Programs/ListPrograms.md b/Specification/Programs/ListPrograms.md index 54c09e91..d80525ae 100644 --- a/Specification/Programs/ListPrograms.md +++ b/Specification/Programs/ListPrograms.md @@ -9,8 +9,8 @@ Implemented By: + Parameters + programName (optional, string, `Internation Yield Trial`) ... Filter by program name. Exact match. + abbreviation (optional, string, `IYT`) ... Filter by program abbreviation. Exact match. - + pageSize (optional, integer, `23`) ... the number of programs to be reported per request - + page (optional, integer, `292`) ... the response page requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Programs/ProgramSearch.md b/Specification/Programs/ProgramSearch.md index f98c5ce6..9753827e 100644 --- a/Specification/Programs/ProgramSearch.md +++ b/Specification/Programs/ProgramSearch.md @@ -18,9 +18,9 @@ Status: ACCEPTED. { "metadata" : { "pagination": { - "pageSize": 10, + "pageSize": 1000, "currentPage": 0, - "totalCount": 10, + "totalCount": 2, "totalPages": 1 }, "status": [], diff --git a/Specification/Studies/GetObservationUnitsByObservationVariableIds.md b/Specification/Studies/GetObservationUnitsByObservationVariableIds.md index fdb0d67b..0c7c64a3 100644 --- a/Specification/Studies/GetObservationUnitsByObservationVariableIds.md +++ b/Specification/Studies/GetObservationUnitsByObservationVariableIds.md @@ -13,7 +13,7 @@ observationTimestamp should be ISO8601 format with timezone: YYYY-MM-DDThh:mm:ss + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. + observationVariableDbId (required, string, `2` ... Numeric `id` of that variable (combination of trait, unit and method) + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Studies/ListObservationLevels.md b/Specification/Studies/ListObservationLevels.md index 7bb3aefe..efb0562c 100644 --- a/Specification/Studies/ListObservationLevels.md +++ b/Specification/Studies/ListObservationLevels.md @@ -6,8 +6,8 @@ The values are used to supply the `observationLevel` parameter in the observatio ### List observation levels [GET] + Parameters - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Studies/ListSeasons.md b/Specification/Studies/ListSeasons.md index 3c96fe8e..a1d3746e 100644 --- a/Specification/Studies/ListSeasons.md +++ b/Specification/Studies/ListSeasons.md @@ -6,8 +6,9 @@ Scope: PHENOTYPING. ### List seasons or years [GET] + Parameters + year (optional, String, `2015`) - + pageSize (optional, integer, `1`) - + page (optional, integer, `1`) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/Studies/ListStudySummaries.md b/Specification/Studies/ListStudySummaries.md index 72d852d8..2ab1df40 100644 --- a/Specification/Studies/ListStudySummaries.md +++ b/Specification/Studies/ListStudySummaries.md @@ -19,8 +19,8 @@ StartDate and endDate should be ISO8601 format for dates: YYYY-MM-DD + programDbId (optional, string, `1`) ... Program filter to only return studies associated with given program id. + locationDbId (optional, string, `212`) ... Filter by location + seasonDbId (optional, string, `2016E`) ... Filter by season or year - + pageSize (optional, integer, `1000`) - + page (optional, integer, `100`) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + germplasmDbIds (optional, array, `["CML123", "CML"]`) ... Filter studies where specified germplasm have been used/tested + observationVariableDbIds (optional, array, `["CO-PH-123" , "Var-123"]`) ... Filter studies where specified observation variables have been measured + active (optional, boolean, `true/false`) ... Filter active status true/false. diff --git a/Specification/Studies/ListStudyTypes.md b/Specification/Studies/ListStudyTypes.md index 14c4476d..8606a919 100644 --- a/Specification/Studies/ListStudyTypes.md +++ b/Specification/Studies/ListStudyTypes.md @@ -7,8 +7,8 @@ Implementation target date: PAG2016 ### List study types [GET] + Parameters - + pageSize (optional, integer, `1`) - + page (optional, integer, `1`) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Studies/ObservationUnitDetails.md b/Specification/Studies/ObservationUnitDetails.md index 640ae0f8..1de08d3f 100644 --- a/Specification/Studies/ObservationUnitDetails.md +++ b/Specification/Studies/ObservationUnitDetails.md @@ -9,8 +9,8 @@ Scope: PHENOTYPING + Parameters + observationLevel (required, string, `plot`) ... The granularity level of observation units. Either `plotNumber` or `plantNumber` fields will be relavant depending on whether granularity is plot or plant respectively. - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Studies/PlotLayoutDetails.md b/Specification/Studies/PlotLayoutDetails.md index ae0f14f1..7657a2e9 100644 --- a/Specification/Studies/PlotLayoutDetails.md +++ b/Specification/Studies/PlotLayoutDetails.md @@ -10,8 +10,8 @@ Retrieve the plot layout of the study with id {id}. + Parameters + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) diff --git a/Specification/Studies/Seasons.md b/Specification/Studies/Seasons.md index a6fb1859..536098c2 100644 --- a/Specification/Studies/Seasons.md +++ b/Specification/Studies/Seasons.md @@ -7,8 +7,9 @@ Scope: PHENOTYPING ### List seasons or years [GET] + Parameters + year (optional, String, `2015`) - + pageSize (optional, integer, `1`) - + page (optional, integer, `1`) + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/Studies/StudyGermplasmDetails.md b/Specification/Studies/StudyGermplasmDetails.md index fe04f2f8..bd39be86 100644 --- a/Specification/Studies/StudyGermplasmDetails.md +++ b/Specification/Studies/StudyGermplasmDetails.md @@ -5,18 +5,18 @@ Scope: PHENOTYPING ### Study Germplasm Details [GET] + Parameters + studyDbId (required, string, `1`) ... Identifier of the study. Usually a number, could be alphanumeric. - + pageSize (optional, integer, `1000`) ... the number of germplasm entries to be returned in the response - + page (optional, integer, `10`) ... the desired response page + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) { "metadata": { "pagination" : { - "pageSize":0, - "currentPage":0, - "totalCount":0, - "totalPages":0 + "pageSize": 1000, + "currentPage": 0, + "totalCount": 2, + "totalPages": 1 }, "status": [], "datafiles": [], diff --git a/Specification/Studies/StudyObservationUnitsAsTable.md b/Specification/Studies/StudyObservationUnitsAsTable.md index 2a5f2087..4447fffc 100644 --- a/Specification/Studies/StudyObservationUnitsAsTable.md +++ b/Specification/Studies/StudyObservationUnitsAsTable.md @@ -27,10 +27,10 @@ Retrieve the details of the study required for field data collection. Includes a { "metadata": { "pagination": { - "pageSize": 1, + "pageSize": 0, "currentPage": 0, - "totalCount": 1, - "totalPages": 1 + "totalCount": 0, + "totalPages": 0 }, "status": [], "datafiles": [] diff --git a/Specification/Studies/StudyObservationVariables.md b/Specification/Studies/StudyObservationVariables.md index 8e90184a..3f3471c3 100644 --- a/Specification/Studies/StudyObservationVariables.md +++ b/Specification/Studies/StudyObservationVariables.md @@ -16,10 +16,10 @@ Refer to the data type definition of variables in `/Specification/ObservationVar { "metadata": { "pagination" : { - "pageSize":2, - "currentPage":0, - "totalCount":10, - "totalPages":5 + "pageSize": 0, + "currentPage": 0, + "totalCount": 0, + "totalPages": 0 }, "status": [], "datafiles": [] diff --git a/Specification/Traits/ListAllTraits.md b/Specification/Traits/ListAllTraits.md index 251b8193..0f4bb3af 100644 --- a/Specification/Traits/ListAllTraits.md +++ b/Specification/Traits/ListAllTraits.md @@ -8,8 +8,9 @@ Call to retrieve a list of traits available in the system and their associated v ### List all traits [GET] + Parameters - + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. - + page (optional, integer, `10`) ... Which result page is requested + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + Response 200 (application/json) { diff --git a/Specification/Trials/ListTrialSummaries.md b/Specification/Trials/ListTrialSummaries.md index 6238b012..7a32605c 100644 --- a/Specification/Trials/ListTrialSummaries.md +++ b/Specification/Trials/ListTrialSummaries.md @@ -25,12 +25,12 @@ Implementation target date: PAG2016. + Parameters + programDbId (optional, string, `1`) ... Program filter to only return trials associated with given program id. - + locationDbId (optional, string, `212`) ... Filter by location - + pageSize (optional, integer, `1000`) - + page (optional, integer, `100`) - + active (optional, boolean, `true/false`) ... Filter active status true/false. - + sortBy (optional, string, `studyDbId`) ... Sort order. Name of the field to sorty by. - + sortOrder (optional, string, `asc/desc`) ... Sort order direction. Ascending/Descending. + + locationDbId (optional, string, `212`) ... Filter by location + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + + active (optional, boolean, `true/false`) ... Filter active status true/false. + + sortBy (optional, string, `studyDbId`) ... Sort order. Name of the field to sorty by. + + sortOrder (optional, string, `asc/desc`) ... Sort order direction. Ascending/Descending. + Response 200 (application/json) From 97367fce5ddaf452949e7735fbf59f9b0bf65b15 Mon Sep 17 00:00:00 2001 From: Peter Selby Date: Tue, 24 Oct 2017 16:15:58 -0400 Subject: [PATCH 3/3] made page and pageSize descriptions consistent --- Specification/GermplasmAttributes/ListAttributeCategories.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Specification/GermplasmAttributes/ListAttributeCategories.md b/Specification/GermplasmAttributes/ListAttributeCategories.md index 158ceb51..03e31e44 100644 --- a/Specification/GermplasmAttributes/ListAttributeCategories.md +++ b/Specification/GermplasmAttributes/ListAttributeCategories.md @@ -1,4 +1,4 @@ -## List attribute categories [/brapi/v1/attributes/categories/?pageSize={pageSize}&page={page}] +## List attribute categories [/brapi/v1/attributes/categories?pageSize={pageSize}&page={page}] Scope: OTHER. Status: ACCEPTED. Implementation target date: PAG2016