From e43d85b8016df9214f45d820231eba642fec1d0f Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Mon, 26 Jun 2023 10:13:02 +0200 Subject: [PATCH 1/8] API Docs: Remove id from Tag in Response --- dev/api/responses/books-read.json | 1 - dev/api/responses/shelves-read.json | 1 - 2 files changed, 2 deletions(-) diff --git a/dev/api/responses/books-read.json b/dev/api/responses/books-read.json index 8d584f597..34c7d8adf 100644 --- a/dev/api/responses/books-read.json +++ b/dev/api/responses/books-read.json @@ -57,7 +57,6 @@ ], "tags": [ { - "id": 13, "name": "Category", "value": "Guide", "order": 0 diff --git a/dev/api/responses/shelves-read.json b/dev/api/responses/shelves-read.json index f2afcdac0..bf1b13669 100644 --- a/dev/api/responses/shelves-read.json +++ b/dev/api/responses/shelves-read.json @@ -19,7 +19,6 @@ "updated_at": "2020-04-10T13:31:04.000000Z", "tags": [ { - "id": 16, "name": "Category", "value": "Guide", "order": 0 From e47870794df04590d5f5122f0cef8c10d9a97f81 Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Mon, 26 Jun 2023 10:13:47 +0200 Subject: [PATCH 2/8] API Docs: Add Missing Type in Response Type is always returned when pages/chapters are in a contents array. --- dev/api/responses/books-read.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dev/api/responses/books-read.json b/dev/api/responses/books-read.json index 34c7d8adf..8208b21aa 100644 --- a/dev/api/responses/books-read.json +++ b/dev/api/responses/books-read.json @@ -52,7 +52,8 @@ "template": false, "created_at": "2021-12-19T18:22:11.000000Z", "updated_at": "2022-07-29T13:44:15.000000Z", - "url": "https://example.com/books/my-own-book/page/cool-animals" + "url": "https://example.com/books/my-own-book/page/cool-animals", + "type": "page" } ], "tags": [ From ca2d2c97d443588e0eaee312788700806c57ace3 Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Fri, 30 Jun 2023 09:23:02 +0200 Subject: [PATCH 3/8] API Docs: Add User Slugs to Example Responses --- dev/api/responses/books-read.json | 9 ++++++--- dev/api/responses/chapters-read.json | 9 ++++++--- dev/api/responses/pages-create.json | 9 ++++++--- dev/api/responses/pages-read.json | 9 ++++++--- dev/api/responses/pages-update.json | 9 ++++++--- dev/api/responses/shelves-read.json | 9 ++++++--- 6 files changed, 36 insertions(+), 18 deletions(-) diff --git a/dev/api/responses/books-read.json b/dev/api/responses/books-read.json index 8208b21aa..3744445d0 100644 --- a/dev/api/responses/books-read.json +++ b/dev/api/responses/books-read.json @@ -7,15 +7,18 @@ "updated_at": "2020-01-12T14:11:51.000000Z", "created_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "updated_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "owned_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "contents": [ { diff --git a/dev/api/responses/chapters-read.json b/dev/api/responses/chapters-read.json index a51b406c7..7e629fee8 100644 --- a/dev/api/responses/chapters-read.json +++ b/dev/api/responses/chapters-read.json @@ -9,15 +9,18 @@ "updated_at": "2019-09-28T11:24:23.000000Z", "created_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "updated_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "owned_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "tags": [ { diff --git a/dev/api/responses/pages-create.json b/dev/api/responses/pages-create.json index 5c3d80215..7ba6a8272 100644 --- a/dev/api/responses/pages-create.json +++ b/dev/api/responses/pages-create.json @@ -11,15 +11,18 @@ "updated_at": "2020-11-28T15:01:39.000000Z", "created_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "updated_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "owned_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "draft": false, "markdown": "", diff --git a/dev/api/responses/pages-read.json b/dev/api/responses/pages-read.json index a47990cc6..59b2f8b74 100644 --- a/dev/api/responses/pages-read.json +++ b/dev/api/responses/pages-read.json @@ -11,15 +11,18 @@ "updated_at": "2020-11-28T14:43:20.000000Z", "created_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "updated_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "owned_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "draft": false, "markdown": "# How this is built\r\n\r\nThis page is written in markdown. BookStack stores the page data in HTML.\r\n\r\nHere's a cute picture of my cat:\r\n\r\n[](http://example.com/uploads/images/gallery/2020-04/yXSrubes.jpg)", diff --git a/dev/api/responses/pages-update.json b/dev/api/responses/pages-update.json index e91b74661..26d0f4d3c 100644 --- a/dev/api/responses/pages-update.json +++ b/dev/api/responses/pages-update.json @@ -11,15 +11,18 @@ "updated_at": "2020-11-28T15:13:03.000000Z", "created_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "updated_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "owned_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "draft": false, "markdown": "", diff --git a/dev/api/responses/shelves-read.json b/dev/api/responses/shelves-read.json index bf1b13669..8debaae72 100644 --- a/dev/api/responses/shelves-read.json +++ b/dev/api/responses/shelves-read.json @@ -5,15 +5,18 @@ "description": "This is my shelf with some books", "created_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "updated_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "owned_by": { "id": 1, - "name": "Admin" + "name": "Admin", + "slug": "admin" }, "created_at": "2020-04-10T13:24:09.000000Z", "updated_at": "2020-04-10T13:31:04.000000Z", From 3a39f13420f8ff754d23743a199faff786650b51 Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Fri, 30 Jun 2023 09:24:46 +0200 Subject: [PATCH 4/8] API Docs: Remove Dates from Tags in Example Responses --- dev/api/responses/chapters-create.json | 8 ++------ dev/api/responses/chapters-update.json | 8 ++------ 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/dev/api/responses/chapters-create.json b/dev/api/responses/chapters-create.json index 81b422c25..1e6932962 100644 --- a/dev/api/responses/chapters-create.json +++ b/dev/api/responses/chapters-create.json @@ -24,16 +24,12 @@ { "name": "Category", "value": "Top Content", - "order": 0, - "created_at": "2020-05-22T22:59:55.000000Z", - "updated_at": "2020-05-22T22:59:55.000000Z" + "order": 0 }, { "name": "Rating", "value": "Highest", - "order": 0, - "created_at": "2020-05-22T22:59:55.000000Z", - "updated_at": "2020-05-22T22:59:55.000000Z" + "order": 1 } ] } \ No newline at end of file diff --git a/dev/api/responses/chapters-update.json b/dev/api/responses/chapters-update.json index 9ce88dab2..b470249be 100644 --- a/dev/api/responses/chapters-update.json +++ b/dev/api/responses/chapters-update.json @@ -24,16 +24,12 @@ { "name": "Category", "value": "Kinda Good Content", - "order": 0, - "created_at": "2020-05-22T23:07:20.000000Z", - "updated_at": "2020-05-22T23:07:20.000000Z" + "order": 0 }, { "name": "Rating", "value": "Medium", - "order": 0, - "created_at": "2020-05-22T23:07:20.000000Z", - "updated_at": "2020-05-22T23:07:20.000000Z" + "order": 1 } ] } \ No newline at end of file From 23ae332c1b226bc21bea9b23f38228a8267c4f88 Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Fri, 30 Jun 2023 09:26:22 +0200 Subject: [PATCH 5/8] API Docs: Sort a few example responses --- dev/api/responses/books-create.json | 6 +++--- dev/api/responses/chapters-create.json | 5 +++-- dev/api/responses/shelves-create.json | 6 +++--- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/dev/api/responses/books-create.json b/dev/api/responses/books-create.json index ede6fcc8e..12a3e9e9f 100644 --- a/dev/api/responses/books-create.json +++ b/dev/api/responses/books-create.json @@ -1,11 +1,11 @@ { + "id": 15, "name": "My new book", + "slug": "my-new-book", "description": "This is a book created via the API", "created_by": 1, "updated_by": 1, "owned_by": 1, - "slug": "my-new-book", "updated_at": "2020-01-12T14:05:11.000000Z", - "created_at": "2020-01-12T14:05:11.000000Z", - "id": 15 + "created_at": "2020-01-12T14:05:11.000000Z" } \ No newline at end of file diff --git a/dev/api/responses/chapters-create.json b/dev/api/responses/chapters-create.json index 1e6932962..aff2f4238 100644 --- a/dev/api/responses/chapters-create.json +++ b/dev/api/responses/chapters-create.json @@ -1,12 +1,13 @@ { + "id": 74, "book_id": 1, - "priority": 6, + "slug": "my-fantastic-new-chapter", "name": "My fantastic new chapter", "description": "This is a great new chapter that I've created via the API", + "priority": 6, "created_by": 1, "updated_by": 1, "owned_by": 1, - "slug": "my-fantastic-new-chapter", "updated_at": "2020-05-22T22:59:55.000000Z", "created_at": "2020-05-22T22:59:55.000000Z", "id": 74, diff --git a/dev/api/responses/shelves-create.json b/dev/api/responses/shelves-create.json index 9988c782c..84caf8bdc 100644 --- a/dev/api/responses/shelves-create.json +++ b/dev/api/responses/shelves-create.json @@ -1,11 +1,11 @@ { + "id": 14, "name": "My shelf", + "slug": "my-shelf", "description": "This is my shelf with some books", "created_by": 1, "updated_by": 1, "owned_by": 1, - "slug": "my-shelf", - "updated_at": "2020-04-10T13:24:09.000000Z", "created_at": "2020-04-10T13:24:09.000000Z", - "id": 14 + "updated_at": "2020-04-10T13:24:09.000000Z" } \ No newline at end of file From ccfe38e9637dcc6fb86b7a450ebc79aa81567cc7 Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Fri, 30 Jun 2023 09:33:53 +0200 Subject: [PATCH 6/8] API Docs: Add book_slug to Example Responses Remove the book attribute in responses because it is never returned by the API. Currently, Chapters Create does not return book_slug! (The example response is consistent with the inconsistent API behavior) --- dev/api/responses/chapters-create.json | 11 ----------- dev/api/responses/chapters-list.json | 6 ++++-- dev/api/responses/chapters-read.json | 7 +++++-- dev/api/responses/chapters-update.json | 11 +---------- dev/api/responses/pages-list.json | 9 ++++++--- 5 files changed, 16 insertions(+), 28 deletions(-) diff --git a/dev/api/responses/chapters-create.json b/dev/api/responses/chapters-create.json index aff2f4238..4dbc764b1 100644 --- a/dev/api/responses/chapters-create.json +++ b/dev/api/responses/chapters-create.json @@ -10,17 +10,6 @@ "owned_by": 1, "updated_at": "2020-05-22T22:59:55.000000Z", "created_at": "2020-05-22T22:59:55.000000Z", - "id": 74, - "book": { - "id": 1, - "name": "BookStack User Guide", - "slug": "bookstack-user-guide", - "description": "This is a general guide on using BookStack on a day-to-day basis.", - "created_at": "2019-05-05T21:48:46.000000Z", - "updated_at": "2019-12-11T20:57:31.000000Z", - "created_by": 1, - "updated_by": 1 - }, "tags": [ { "name": "Category", diff --git a/dev/api/responses/chapters-list.json b/dev/api/responses/chapters-list.json index dc6dde100..c3dc98b9c 100644 --- a/dev/api/responses/chapters-list.json +++ b/dev/api/responses/chapters-list.json @@ -11,7 +11,8 @@ "updated_at": "2019-09-28T11:24:23.000000Z", "created_by": 1, "updated_by": 1, - "owned_by": 1 + "owned_by": 1, + "book_slug": "example-book" }, { "id": 2, @@ -24,7 +25,8 @@ "updated_at": "2019-10-17T15:05:34.000000Z", "created_by": 3, "updated_by": 3, - "owned_by": 3 + "owned_by": 3, + "book_slug": "example-book" } ], "total": 40 diff --git a/dev/api/responses/chapters-read.json b/dev/api/responses/chapters-read.json index 7e629fee8..75c324a61 100644 --- a/dev/api/responses/chapters-read.json +++ b/dev/api/responses/chapters-read.json @@ -22,6 +22,7 @@ "name": "Admin", "slug": "admin" }, + "book_slug": "example-book", "tags": [ { "name": "Category", @@ -43,7 +44,8 @@ "updated_by": 1, "draft": false, "revision_count": 2, - "template": false + "template": false, + "book_slug": "example-book" }, { "id": 7, @@ -58,7 +60,8 @@ "updated_by": 3, "draft": false, "revision_count": 1, - "template": false + "template": false, + "book_slug": "example-book" } ] } \ No newline at end of file diff --git a/dev/api/responses/chapters-update.json b/dev/api/responses/chapters-update.json index b470249be..cc454d740 100644 --- a/dev/api/responses/chapters-update.json +++ b/dev/api/responses/chapters-update.json @@ -10,16 +10,7 @@ "created_by": 1, "updated_by": 1, "owned_by": 1, - "book": { - "id": 1, - "name": "BookStack User Guide", - "slug": "bookstack-user-guide", - "description": "This is a general guide on using BookStack on a day-to-day basis.", - "created_at": "2019-05-05T21:48:46.000000Z", - "updated_at": "2019-12-11T20:57:31.000000Z", - "created_by": 1, - "updated_by": 1 - }, + "book_slug": "bookstack-demo-site", "tags": [ { "name": "Category", diff --git a/dev/api/responses/pages-list.json b/dev/api/responses/pages-list.json index 2ff4aeb3a..2b465c978 100644 --- a/dev/api/responses/pages-list.json +++ b/dev/api/responses/pages-list.json @@ -13,7 +13,8 @@ "updated_at": "2020-07-04T15:50:58.000000Z", "created_by": 1, "updated_by": 1, - "owned_by": 1 + "owned_by": 1, + "book_slug": "example-book" }, { "id": 2, @@ -28,7 +29,8 @@ "updated_at": "2019-06-06T12:03:04.000000Z", "created_by": 1, "updated_by": 1, - "owned_by": 1 + "owned_by": 1, + "book_slug": "example-book" }, { "id": 3, @@ -43,7 +45,8 @@ "updated_at": "2019-12-18T21:56:52.000000Z", "created_by": 1, "updated_by": 1, - "owned_by": 1 + "owned_by": 1, + "book_slug": "example-book" } ], "total": 322 From 174cd5a89343463d73707af5928a8ce97f4285ce Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Fri, 30 Jun 2023 09:35:19 +0200 Subject: [PATCH 7/8] API Docs: Add Missing editor fields in Example Responses --- dev/api/responses/chapters-read.json | 2 ++ dev/api/responses/pages-create.json | 1 + dev/api/responses/pages-list.json | 3 +++ dev/api/responses/pages-read.json | 1 + dev/api/responses/pages-update.json | 1 + 5 files changed, 8 insertions(+) diff --git a/dev/api/responses/chapters-read.json b/dev/api/responses/chapters-read.json index 75c324a61..9565c3989 100644 --- a/dev/api/responses/chapters-read.json +++ b/dev/api/responses/chapters-read.json @@ -45,6 +45,7 @@ "draft": false, "revision_count": 2, "template": false, + "editor": "wysiwyg", "book_slug": "example-book" }, { @@ -61,6 +62,7 @@ "draft": false, "revision_count": 1, "template": false, + "editor": "wysiwyg", "book_slug": "example-book" } ] diff --git a/dev/api/responses/pages-create.json b/dev/api/responses/pages-create.json index 7ba6a8272..385d5384e 100644 --- a/dev/api/responses/pages-create.json +++ b/dev/api/responses/pages-create.json @@ -28,6 +28,7 @@ "markdown": "", "revision_count": 1, "template": false, + "editor": "wysiwyg", "tags": [ { "name": "Category", diff --git a/dev/api/responses/pages-list.json b/dev/api/responses/pages-list.json index 2b465c978..8615294d3 100644 --- a/dev/api/responses/pages-list.json +++ b/dev/api/responses/pages-list.json @@ -14,6 +14,7 @@ "created_by": 1, "updated_by": 1, "owned_by": 1, + "editor": "wysiwyg", "book_slug": "example-book" }, { @@ -30,6 +31,7 @@ "created_by": 1, "updated_by": 1, "owned_by": 1, + "editor": "wysiwyg", "book_slug": "example-book" }, { @@ -46,6 +48,7 @@ "created_by": 1, "updated_by": 1, "owned_by": 1, + "editor": "wysiwyg", "book_slug": "example-book" } ], diff --git a/dev/api/responses/pages-read.json b/dev/api/responses/pages-read.json index 59b2f8b74..2f3538964 100644 --- a/dev/api/responses/pages-read.json +++ b/dev/api/responses/pages-read.json @@ -28,6 +28,7 @@ "markdown": "# How this is built\r\n\r\nThis page is written in markdown. BookStack stores the page data in HTML.\r\n\r\nHere's a cute picture of my cat:\r\n\r\n[](http://example.com/uploads/images/gallery/2020-04/yXSrubes.jpg)", "revision_count": 5, "template": false, + "editor": "wysiwyg", "tags": [ { "name": "Category", diff --git a/dev/api/responses/pages-update.json b/dev/api/responses/pages-update.json index 26d0f4d3c..eb1c5bd85 100644 --- a/dev/api/responses/pages-update.json +++ b/dev/api/responses/pages-update.json @@ -28,6 +28,7 @@ "markdown": "", "revision_count": 5, "template": false, + "editor": "wysiwyg", "tags": [ { "name": "Category", From d293171da2dce020298308b0f1a6f455966bb8bb Mon Sep 17 00:00:00 2001 From: Thomas Kuschan <mail@thomaskuschan.de> Date: Fri, 30 Jun 2023 09:36:46 +0200 Subject: [PATCH 8/8] API Docs: Add Missing Fields in Example Responses --- dev/api/responses/chapters-read.json | 2 ++ dev/api/responses/pages-list.json | 3 +++ dev/api/responses/shelves-read.json | 24 +++++++++++++++++++++--- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/dev/api/responses/chapters-read.json b/dev/api/responses/chapters-read.json index 9565c3989..5f4de85f1 100644 --- a/dev/api/responses/chapters-read.json +++ b/dev/api/responses/chapters-read.json @@ -42,6 +42,7 @@ "updated_at": "2019-08-26T14:32:59.000000Z", "created_by": 1, "updated_by": 1, + "owned_by": 1, "draft": false, "revision_count": 2, "template": false, @@ -59,6 +60,7 @@ "updated_at": "2019-06-06T12:03:04.000000Z", "created_by": 3, "updated_by": 3, + "owned_by": 1, "draft": false, "revision_count": 1, "template": false, diff --git a/dev/api/responses/pages-list.json b/dev/api/responses/pages-list.json index 8615294d3..8f95c4985 100644 --- a/dev/api/responses/pages-list.json +++ b/dev/api/responses/pages-list.json @@ -8,6 +8,7 @@ "slug": "how-to-create-page-content", "priority": 0, "draft": false, + "revision_count": 3, "template": false, "created_at": "2019-05-05T21:49:58.000000Z", "updated_at": "2020-07-04T15:50:58.000000Z", @@ -25,6 +26,7 @@ "slug": "how-to-use-images", "priority": 2, "draft": false, + "revision_count": 3, "template": false, "created_at": "2019-05-05T21:53:30.000000Z", "updated_at": "2019-06-06T12:03:04.000000Z", @@ -42,6 +44,7 @@ "slug": "drawings-via-drawio", "priority": 3, "draft": false, + "revision_count": 3, "template": false, "created_at": "2019-05-05T21:53:49.000000Z", "updated_at": "2019-12-18T21:56:52.000000Z", diff --git a/dev/api/responses/shelves-read.json b/dev/api/responses/shelves-read.json index 8debaae72..802045bd8 100644 --- a/dev/api/responses/shelves-read.json +++ b/dev/api/responses/shelves-read.json @@ -43,17 +43,35 @@ { "id": 5, "name": "Sint explicabo alias sunt.", - "slug": "jbsQrzuaXe" + "slug": "jbsQrzuaXe", + "description": "Hic forum est.", + "created_at": "2020-04-10T13:31:04.000000Z", + "updated_at": "2020-04-10T13:31:04.000000Z", + "created_by": 1, + "updated_by": 1, + "owned_by": 1 }, { "id": 1, "name": "BookStack User Guide", - "slug": "bookstack-user-guide" + "slug": "bookstack-user-guide", + "description": "The Bookstack User Guide Book.", + "created_at": "2020-04-10T15:30:32.000000Z", + "updated_at": "2020-04-13T09:01:04.000000Z", + "created_by": 1, + "updated_by": 2, + "owned_by": 1 }, { "id": 3, "name": "Molestiae doloribus sint velit suscipit dolorem.", - "slug": "H99QxALaoG" + "slug": "H99QxALaoG", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", + "created_at": "2020-04-10T13:31:04.000000Z", + "updated_at": "2020-04-10T13:31:04.000000Z", + "created_by": 1, + "updated_by": 1, + "owned_by": 1 } ] } \ No newline at end of file