dashboard: show writer trees

1 files changed, 35 insertions, 0 deletions

diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 03f75d9..a15339a 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -799,6 +799,41 @@ paths:
       responses:
         '204':
           description: Done.
+  /admin/dashboard/tree:
+    get:
+      tags: [Admin]
+      summary: A writer's tree
+      description: |
+        The tree a writer's changes pass on along (`swarm::tree`), as this node computes
+        it from the member list and the links members report (whom each reaches; one
+        that reports none counts as reaching its neighbours by the member list): each
+        member's parent, `null` for one without (it gets the writer's changes by
+        announcement). Only with the `dashboard` cargo feature.
+      parameters:
+        - name: writer
+          in: query
+          required: true
+          schema:
+            type: string
+          description: The writer's node ID.
+      responses:
+        '200':
+          description: The tree.
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [writer, parents]
+                properties:
+                  writer:
+                    type: string
+                  parents:
+                    type: object
+                    description: By member's node ID, its parent's, or null.
+                    additionalProperties:
+                      type: [string, 'null']
+        '404':
+          description: The writer isn't in the member list (or it isn't known yet).
   /admin/dashboard/events:
     get:
       tags: [Admin]