docs(api): add Bruno collection for Jetstream API

Excludes docs/ from deno fmt and deno lint so the Bruno files don't break formatting and lint checks in CI.
2026-06-07 12:04:37 +02:00
parent a6f1a96c4a
commit 4ff3ea6644
24 changed files with 1516 additions and 0 deletions
--- a/API/notes/List
+++ b/API/notes/List
@@ -0,0 +1,69 @@
+meta {
+  name: List discoverable notes for a single DID
+  type: http
+  seq: 2
+}
+
+get {
+  url: {{baseUrl}}/:did/notes
+  body: none
+  auth: inherit
+}
+
+params:query {
+  ~cursor: 
+  ~limit: 
+}
+
+params:path {
+  did: 
+}
+
+example {
+  name: 200 Response
+  description: A page of notes for the given DID.
+  
+  request: {
+    url: {{baseUrl}}/:did/notes
+    method: GET
+    mode: none
+    params:query: {
+      ~cursor: 
+      ~limit: 
+    }
+  
+    params:path: {
+      did: 
+    }
+  }
+  
+  response: {
+    headers: {
+      Content-Type: application/json
+    }
+  
+    status: {
+      code: 200
+      text: OK
+    }
+  
+    body: {
+      type: json
+      content: '''
+        {
+          "notes": [
+            {
+              "did": "",
+              "rkey": "",
+              "title": "",
+              "publishedAt": "",
+              "createdAt": "",
+              "language": ""
+            }
+          ],
+          "cursor": ""
+        }
+      '''
+    }
+  }
+}