Merge pull request #1520 from alliance-genome/release/v0.32.0

SCRUM-3723: deploy beta to production - release/v0.32.0

FIND.md

@@ -0,0 +1,64 @@
+# Find payload for /find endpoints
+
+## Endpoints
+
+Endpoints are in the following structure
+
+POST /api/{object}/find
+
+{object} will be any of the objects that we have tables for in the UI and the database
+
+## Query Parameters
+
+### Page
+
+This will be a zero based page of results that is pulled from the database. 
+
+### Limit 
+
+This will be the size of the page that comes back. 
+
+## POST Search Payload Example
+
+```javascript
+{
+    "vocabulary.vocabularyLabel": "disease_qualifier",
+    "debug": "true"
+}
+```
+
+### Fields (required)
+
+Fields are just a list of fields and their values to search the datgabase. All are exact matches and they are all ANDed together.
+
+### Debug (optional)
+
+Debug true will turn on some extra debugging in order to see the query getting sent to ElasticSearch and some duration statistics. Default value is false.
+
+## Return Object "SearchResults"
+
+```javascript
+{
+    "results": [
+    ],
+    "totalResults": 7,
+    "returnedRecords": 7,
+    "dbQuery": "select alias_1764182562 from org.alliancegenome.curation_api.model.entities.VocabularyTerm alias_1764182562 where alias_1764182562.vocabulary.vocabularyLabel = disease_qualifier order by alias_1764182562.id asc nulls last"
+}
+```
+
+### Results
+
+This is the list of objects coming back from the system.
+
+### Total Results
+
+This is the count of the total results found on the whole query.
+
+### Returned Results
+
+This is the count of the page of results, for each page should be the count that is in the result set. May be smaller then limit on the last page.
+
+### DB Query
+
+This is the JQL query that will be run against the database.

README.md

@@ -33,6 +33,9 @@ These instructions will get you a copy of the project and the API up and running
    *  [Database](#database)
 -  [Loading Data](#loading-data)
 -  [Submitting Data](#submitting-data)
+-  [Querying Data](#querying-data)
+   *  [Elastic Search](#search)
+   *  [Database Search](#find)
 
 ## Developing
 Before you start coding for a new feature or making a bugfix,
@@ -668,6 +671,16 @@ The LinkML version for which the file is being submitted now needs to be added t
   "disease_agm_ingest_set" : [ {
 ```
 
+## Querying Data
+
+### Search
+
+Documentation to use the [API search endpoints](SEARCH.md).
+
+### Find
+
+Documentation to use the [API find endpoints](FIND.md).
+
 ## EB Deployment (beta)
 This section is WIP.
 

RELEASE-NOTES.md

@@ -3,6 +3,27 @@
 https://agr-jira.atlassian.net/wiki/spaces/ATEAM/overview
 
 
+## v0.32.0
+* New features
+  * Loading Gene phenotype annotations from the FMS (SCRUM-3686)
+  * Loading Gene molecular interactions from the FMS - phase 1 (SCRUM-3806)
+  * Lading Allele phenotype annotations from the FMS (SCRUM-3711)
+  * Enable MOD-specific required fields for new disease annotations and editing existing annotations (SCRUM-2755)
+  * GraphQL-like mechanism to trim unnecessary fields from API responses (SCRUM-3800)
+  * Added functionality to OR filters in search
+* Fixes and maintenance
+  * In search documentation
+  * In display after clicking on save and add on the New annotation form
+  * Change default number of rows rendered for each curation data table to 10 (SCRUM-3857)
+  * Refactor Species Table Templates into Components (SCRUM-3765)
+  * Refactor Allele Table Templates into Components (SCRUM-3753)
+  * Vocabulary term lookup when creating experiments
+  * Changed the mod related setting specifically to ZFIN
+  * Changed the data tables items into alphabetical order
+  * Increase reporting interval for bulk loads
+  * Hardcode the RGD publication ID for OMIM and ORPHA ID cross references for Human gene phenotype annotations from the FMS(SCRUM-3883)
+  * ATP:0000035 not showing up in ATP ontology Tree View (SCRUM-3884)
+
 ## v0.31.0
 * New features
   * Replaced Negated column/field with NOT in disease annotation table and new annotation form (SCRUM-3794)