aboutsummaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorMunyoki Kilyungi2023-10-24 17:12:05 +0300
committerMunyoki Kilyungi2023-10-24 17:12:05 +0300
commit11b331f0a22988cd252f023c973342e261444829 (patch)
tree03fbeee906186e56cebac894897e8fe3fe5cd627 /api
parent0c00a5f5153f6c3cf4199586bf7dfe6dd87850af (diff)
downloadgn-docs-11b331f0a22988cd252f023c973342e261444829.tar.gz
Update GN3 API documentation.
Signed-off-by: Munyoki Kilyungi <me@bonfacemunyoki.com>
Diffstat (limited to 'api')
-rw-r--r--api/GN3-REST-API-Implementation.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/api/GN3-REST-API-Implementation.md b/api/GN3-REST-API-Implementation.md
index d759e94..140037a 100644
--- a/api/GN3-REST-API-Implementation.md
+++ b/api/GN3-REST-API-Implementation.md
@@ -103,7 +103,7 @@ Fetch all groups.
curl "localhost:8080/api/metadata/groups"
```
-Example Results:
+Example Result:
```
{
@@ -151,7 +151,7 @@ Fetch information about a given group given a species' name.
curl "localhost:8080/api/metadata/groups/bat"
```
-Example Results:
+Example Result:
```
{
@@ -193,7 +193,7 @@ or
curl "localhost:8080/api/metadata/datasets/GN11"
```
-Example Results:
+Example Result:
```
{
@@ -265,7 +265,7 @@ List datasets that belong to a given group.
curl "localhost:8080/api/metadata/datasets/BXD/list"
```
-Example Results:
+Example Result:
```
{
@@ -315,7 +315,7 @@ Search datasets based of it's title.
curl "localhost:8080/api/metadata/datasets/search/BXD?page=2&limit=3"
```
-Example Results:
+Example Result:
```
{
@@ -377,7 +377,7 @@ Search datasets based of it's title.
curl "localhost:8080/api/metadata/datasets/search/BXD?page=2&limit=3"
```
-Example Result
+Example Result:
```
{
@@ -520,7 +520,7 @@ curl "localhost:8080/api/metadata/publications/search/BXD?page=0&limit=3"
```
-Example Results:
+Example Result:
```
{
@@ -759,7 +759,7 @@ Fetch metadata about a given genotype given it's name.
curl "localhost:8080/api/metadata/genotypes/D1Mit3"
```
-Example Result
+Example Result:
```
{
@@ -813,7 +813,7 @@ Get genewiki entries from Genetwork about a given symbol
curl "localhost:8080/api/metadata/genewikis/gn/Lpl"
```
-Example Result
+Example Result:
```
{
@@ -909,7 +909,7 @@ Get genewiki entries from NCBI about a given symbol
curl "localhost:8080/api/metadata/genewikis/ncbi/Lpl?per-page=3"
```
-Example Result
+Example Result:
```
{