From 0f6af484a8b2f5966fa3e3b1e9e3412b5a4aaee5 Mon Sep 17 00:00:00 2001
From: librelois <c@elo.tf>
Date: Sun, 30 May 2021 01:18:32 +0200
Subject: [PATCH] doc(api):gva: precise three endpoints types
---
doc/api/gva.md | 27 +++++++++++++++++++++------
1 file changed, 21 insertions(+), 6 deletions(-)
diff --git a/doc/api/gva.md b/doc/api/gva.md
index a1e841657..fef196b22 100644
--- a/doc/api/gva.md
+++ b/doc/api/gva.md
@@ -2,12 +2,26 @@
GVA is a [graphql] API.
-## Schema
+## Endpoints
+
+Each Duniter node with GVA enabled have three endpoints :
+
+| Prefix in peer card | Default path | Usage |
+|:-:|:-:|:-:|
+| `GVA` | `/gva` | for graphql queries and mutations |
+| `GVASUB` | `/gva` | for graphql subscriptions |
+| n/a | `/gva-playground` | for [graphql playground] |
-See the playground of a GVA node:
+To learn how to use the GVA API, we recommend you to use the playground, which provides you with a documentation of all requests in the DOCS tab on the right of the screen.
-* https://g1.librelois.fr/gva
-* https://duniter-g1.p2p.legal/gva
+## List of known GVA playgrounds
+
+* https://g1.librelois.fr/gva-playground
+* https://duniter-g1.p2p.legal/gva-playground
+
+## Schema
+
+See the tab SCHEMA of a GVA playground.
## Batch support
@@ -25,8 +39,6 @@ These limitations apply only to non-whitelisted IPs:
* The size of a batch is limited to 5 requests.
* For paged requests, the pageSize parameter must be between 1 and 1000.
-[graphql]: https://graphql.org/
-
## Examples
### Send a transaction
@@ -91,3 +103,6 @@ query {
}"}
]
```
+
+[graphql]: https://graphql.org/
+[graphql playground]: https://github.com/graphql/graphql-playground
--
GitLab