summaryrefslogtreecommitdiff
path: root/issues/move-data-endpoint-from-gn2-to-gn3.gmi
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2023-11-03 11:37:11 +0300
committerFrederick Muriuki Muriithi2023-11-03 11:37:11 +0300
commitdcd6469156e8b5b43b9bb0af2d3f4f7fd2635b4d (patch)
tree4e9607183d145fc7d78ea672c638b88d6518da8f /issues/move-data-endpoint-from-gn2-to-gn3.gmi
parent9c8c7e70df47af0d7d7e5befc39086cbb0893017 (diff)
downloadgn-gemtext-dcd6469156e8b5b43b9bb0af2d3f4f7fd2635b4d.tar.gz
New Issue: API => Move Data Endpoints to GN3
Start issue to track the "moving" of the data APIs to GN3 -- it is not exactly moving the endpoints, since we will probably take the chance to rework the API structure to be clearer and cleaner.
Diffstat (limited to 'issues/move-data-endpoint-from-gn2-to-gn3.gmi')
-rw-r--r--issues/move-data-endpoint-from-gn2-to-gn3.gmi35
1 files changed, 35 insertions, 0 deletions
diff --git a/issues/move-data-endpoint-from-gn2-to-gn3.gmi b/issues/move-data-endpoint-from-gn2-to-gn3.gmi
new file mode 100644
index 0000000..82e66d7
--- /dev/null
+++ b/issues/move-data-endpoint-from-gn2-to-gn3.gmi
@@ -0,0 +1,35 @@
+# Move Data Endpoints from GN2 to GN3
+
+## Tags
+
+* assigned: fredm
+* priority: medium
+* type: feature-request
+* status: open
+* keywords: API
+
+## Description
+
+GN3 is the API server, but currently (as of Friday 03 November 2023 at 11:11AM +03:00UTC), it does not have endpoints where one can fetch data with, save for the menu. The endpoint that it does have are mostly compute endpoints.
+
+GN2, on the other hand, is mostly the UI. It is here that we find some data endpoints.
+
+We need to move the data endpoints from GN2 to GN3.
+
+When we speak of data endpoints, we are speaking of endpoints where we can fetch data from, such as:
+
+=> https://genenetwork.org/api/v_pre1/species
+=> https://genenetwork.org/api/v_pre1/species/mouse
+=> https://genenetwork.org/api/v_pre1/groups
+=> https://genenetwork.org/api/v_pre1/groups/BXD
+=> https://genenetwork.org/api/v_pre1/datasets/bxd
+
+etc.
+
+
+### Extra Documentation to Consider
+
+The *Alternative API Structure* seems to be particularly important.
+
+=> https://github.com/genenetwork/gn-docs/blob/master/api/alternative-API-structure.md Alternative API Structure
+=> https://github.com/genenetwork/gn-docs/blob/master/api/questions-to-ask-GN.md Questions to Ask GN