diff options
Diffstat (limited to 'packages/open-api/karakeep-openapi-spec.json')
| -rw-r--r-- | packages/open-api/karakeep-openapi-spec.json | 152 |
1 files changed, 108 insertions, 44 deletions
diff --git a/packages/open-api/karakeep-openapi-spec.json b/packages/open-api/karakeep-openapi-spec.json index b525d39f..9132a4d9 100644 --- a/packages/open-api/karakeep-openapi-spec.json +++ b/packages/open-api/karakeep-openapi-spec.json @@ -349,6 +349,50 @@ "Cursor": { "type": "string" }, + "List": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "icon": { + "type": "string" + }, + "parentId": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "manual", + "smart" + ], + "default": "manual" + }, + "query": { + "type": "string", + "nullable": true + }, + "public": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "icon", + "parentId", + "public" + ] + }, "Highlight": { "type": "object", "properties": { @@ -400,50 +444,6 @@ "createdAt" ] }, - "List": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "icon": { - "type": "string" - }, - "parentId": { - "type": "string", - "nullable": true - }, - "type": { - "type": "string", - "enum": [ - "manual", - "smart" - ], - "default": "manual" - }, - "query": { - "type": "string", - "nullable": true - }, - "public": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "icon", - "parentId", - "public" - ] - }, "Tag": { "type": "object", "properties": { @@ -1472,6 +1472,70 @@ } } }, + "/bookmarks/{bookmarkId}/lists": { + "get": { + "description": "Get lists of a bookmark", + "summary": "Get lists of a bookmark", + "tags": [ + "Bookmarks" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "The list of highlights", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/List" + } + } + }, + "required": [ + "lists" + ] + } + } + } + }, + "404": { + "description": "Bookmark not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + } + } + } + } + } + } + }, "/bookmarks/{bookmarkId}/highlights": { "get": { "description": "Get highlights of a bookmark", |