@epilot/sdk 2.8.0-rc.0 → 2.8.1

package/definitions/notes-runtime.json

@@ -1 +1 @@
-{"s":"https://notes.sls.epilot.io","o":[["createNote","post","/v1/note",null,1],["getNote","get","/v1/note/{id}",[["id","p",true],["hydrate","q"]]],["patchNote","patch","/v1/note/{id}",[["id","p",true]],1],["updateNote","put","/v1/note/{id}",[["id","p",true]],1],["deleteNote","delete","/v1/note/{id}",[["id","p",true]]],["searchNotesByContext","post","/v1/notes:search",null,1],["getNotesByContext","get","/v1/notes/{entity_id}",[["entity_id","p",true],["contexts","q"],["from","q"],["size","q"]]],["pinNote","post","/v1/note/{id}/pin",[["id","p",true]]],["getNoteContexts","get","/v1/note/{id}/context",[["id","p",true]]],["addNoteReaction","post","/v1/note/{id}/reaction",[["id","p",true]],1],["removeNoteReaction","delete","/v1/note/{id}/reaction/{emoji_shortcode}",[["id","p",true],["emoji_shortcode","p",true]]],["toggleNoteReactions","post","/v1/note/{id}/reactions/toggle",[["id","p",true]],1]]}
+{"s":"https://notes.sls.epilot.io","o":[["createNote","post","/v1/note",null,1],["getNote","get","/v1/note/{id}",[["id","p",true],["hydrate","q"]]],["patchNote","patch","/v1/note/{id}",[["id","p",true]],1],["updateNote","put","/v1/note/{id}",[["id","p",true]],1],["deleteNote","delete","/v1/note/{id}",[["id","p",true]]],["searchNotesByContext","post","/v1/notes:search",null,1],["getNotesByContext","get","/v1/notes/{entity_id}",[["entity_id","p",true],["contexts","q"],["filter","q"],["from","q"],["size","q"]]],["pinNote","post","/v1/note/{id}/pin",[["id","p",true]]],["archiveNote","post","/v1/note/{id}/archive",[["id","p",true]]],["unarchiveNote","post","/v1/note/{id}/unarchive",[["id","p",true]]],["getNoteContexts","get","/v1/note/{id}/context",[["id","p",true]]],["addNoteReaction","post","/v1/note/{id}/reaction",[["id","p",true]],1],["removeNoteReaction","delete","/v1/note/{id}/reaction/{emoji_shortcode}",[["id","p",true],["emoji_shortcode","p",true]]],["toggleNoteReactions","post","/v1/note/{id}/reactions/toggle",[["id","p",true]],1]]}

package/definitions/notes.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.2",
   "info": {
-    "version": "2.4.0",
+    "version": "2.6.0",
     "title": "Notes API",
     "description": "Facade API Backend for Epilot Notes feature",
     "contact": {
@@ -23,6 +23,9 @@
     },
     {
       "name": "Reactions"
+    },
+    {
+      "name": "Archive"
     }
   ],
   "security": [
@@ -285,6 +288,14 @@
               }
             }
           },
+          {
+            "in": "query",
+            "name": "filter",
+            "description": "Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both.",
+            "schema": {
+              "$ref": "#/components/schemas/NotesListFilter"
+            }
+          },
           {
             "in": "query",
             "name": "from",
@@ -347,6 +358,74 @@
         }
       }
     },
+    "/v1/note/{id}/archive": {
+      "post": {
+        "operationId": "archiveNote",
+        "summary": "archiveNote",
+        "description": "Archives a root Note entry by setting its `_archived_at` timestamp to the current server time. The same timestamp is cascaded to every comment under the note so the entire thread is hidden from default listings. Returns 400 if the supplied id is a comment.",
+        "tags": [
+          "Archive"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "description": "The Entity ID of the Note entry to archive",
+            "schema": {
+              "type": "string",
+              "description": "The Entity ID of the Note entry to archive"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response with the archived Note entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NoteEntity"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/note/{id}/unarchive": {
+      "post": {
+        "operationId": "unarchiveNote",
+        "summary": "unarchiveNote",
+        "description": "Unarchives a root Note entry by clearing its `_archived_at` value. The clear cascades to every comment under the note so the entire thread returns to the active view. Returns 400 if the supplied id is a comment.",
+        "tags": [
+          "Archive"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "description": "The Entity ID of the Note entry to unarchive",
+            "schema": {
+              "type": "string",
+              "description": "The Entity ID of the Note entry to unarchive"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response with the unarchived Note entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NoteEntity"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/note/{id}/context": {
       "get": {
         "operationId": "getNoteContexts",
@@ -726,6 +805,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         },
         "description": "A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place."
@@ -927,6 +1012,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         }
       },
@@ -1051,6 +1142,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         }
       },
@@ -1194,6 +1291,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         },
         "required": [
@@ -1422,6 +1525,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         }
       },
@@ -1454,6 +1563,9 @@
             },
             "description": "When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results."
           },
+          "filter": {
+            "$ref": "#/components/schemas/NotesListFilter"
+          },
           "from": {
             "type": "number",
             "default": 0,
@@ -1469,6 +1581,16 @@
           "contexts"
         ]
       },
+      "NotesListFilter": {
+        "type": "string",
+        "enum": [
+          "all",
+          "active",
+          "archived"
+        ],
+        "default": "active",
+        "description": "Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both."
+      },
       "NotesSearchRequestResponse": {
         "type": "object",
         "properties": {