Skip to content

NOW MANAGED ON CODEBERG

Input WYSIWYG: Updated API examples to align with changes

Dan Brownfb3cfaf7c7cd
diff --git a/dev/api/requests/books-create.json b/dev/api/requests/books-create.json
index 2a38dba83..71dbdcc65 100644
--- a/dev/api/requests/books-create.json
+++ b/dev/api/requests/books-create.json
@@ -1,7 +1,7 @@
{
"name": "My own book",
- "description": "This is my own little book",
- "default_template_id": 12,
+ "description_html": "<p>This is <strong>my</strong> own little book created via the API</p>",
+ "default_template_id": 2427,
"tags": [
{"name": "Category", "value": "Top Content"},
{"name": "Rating", "value": "Highest"}
diff --git a/dev/api/requests/books-update.json b/dev/api/requests/books-update.json
index c026b7b49..30ce7e95a 100644
--- a/dev/api/requests/books-update.json
+++ b/dev/api/requests/books-update.json
@@ -1,7 +1,7 @@
{
"name": "My updated book",
- "description": "This is my book with updated details",
- "default_template_id": 12,
+ "description_html": "<p>This is my book with <em>updated</em> details</p>",
+ "default_template_id": 2427,
"tags": [
{"name": "Subject", "value": "Updates"}
]
diff --git a/dev/api/requests/chapters-create.json b/dev/api/requests/chapters-create.json
index a7a0e072c..e9d903387 100644
--- a/dev/api/requests/chapters-create.json
+++ b/dev/api/requests/chapters-create.json
@@ -1,7 +1,7 @@
{
"book_id": 1,
"name": "My fantastic new chapter",
- "description": "This is a great new chapter that I've created via the API",
+ "description_html": "<p>This is a <strong>great new chapter</strong> that I've created via the API</p>",
"priority": 15,
"tags": [
{"name": "Category", "value": "Top Content"},
diff --git a/dev/api/requests/chapters-update.json b/dev/api/requests/chapters-update.json
index 18c40301b..be675772b 100644
--- a/dev/api/requests/chapters-update.json
+++ b/dev/api/requests/chapters-update.json
@@ -1,7 +1,7 @@
{
"book_id": 1,
"name": "My fantastic updated chapter",
- "description": "This is an updated chapter that I've altered via the API",
+ "description_html": "<p>This is an <strong>updated chapter</strong> that I've altered via the API</p>",
"priority": 16,
"tags": [
{"name": "Category", "value": "Kinda Good Content"},
diff --git a/dev/api/requests/shelves-create.json b/dev/api/requests/shelves-create.json
index 39b88af7e..8f35340f6 100644
--- a/dev/api/requests/shelves-create.json
+++ b/dev/api/requests/shelves-create.json
@@ -1,5 +1,8 @@
{
"name": "My shelf",
- "description": "This is my shelf with some books",
- "books": [5,1,3]
+ "description_html": "<p>This is <strong>my shelf</strong> with some books</p>",
+ "books": [5,1,3],
+ "tags": [
+ {"name": "Category", "value": "Learning"}
+ ]
}
\ No newline at end of file
diff --git a/dev/api/requests/shelves-update.json b/dev/api/requests/shelves-update.json
index df5f5735d..081c8f4c1 100644
--- a/dev/api/requests/shelves-update.json
+++ b/dev/api/requests/shelves-update.json
@@ -1,5 +1,5 @@
{
"name": "My updated shelf",
- "description": "This is my update shelf with some books",
+ "description_html": "<p>This is my <em>updated shelf</em> with some books</p>",
"books": [5,1,3]
}
\ No newline at end of file
diff --git a/dev/api/responses/books-create.json b/dev/api/responses/books-create.json
index 773879125..8895fb854 100644
--- a/dev/api/responses/books-create.json
+++ b/dev/api/responses/books-create.json
@@ -1,12 +1,26 @@
{
- "id": 15,
- "name": "My new book",
- "slug": "my-new-book",
- "description": "This is a book created via the API",
+ "id": 226,
+ "name": "My own book",
+ "slug": "my-own-book",
+ "description": "This is my own little book created via the API",
+ "created_at": "2023-12-22T14:22:28.000000Z",
+ "updated_at": "2023-12-22T14:22:28.000000Z",
"created_by": 1,
"updated_by": 1,
"owned_by": 1,
- "default_template_id": 12,
- "updated_at": "2020-01-12T14:05:11.000000Z",
- "created_at": "2020-01-12T14:05:11.000000Z"
+ "default_template_id": 2427,
+ "description_html": "<p>This is <strong>my<\/strong> own little book created via the API<\/p>",
+ "tags": [
+ {
+ "name": "Category",
+ "value": "Top Content",
+ "order": 0
+ },
+ {
+ "name": "Rating",
+ "value": "Highest",
+ "order": 0
+ }
+ ],
+ "cover": null
}
\ No newline at end of file
diff --git a/dev/api/responses/books-update.json b/dev/api/responses/books-update.json
index f69677c4a..dafa2feb0 100644
--- a/dev/api/responses/books-update.json
+++ b/dev/api/responses/books-update.json
@@ -1,12 +1,21 @@
{
- "id": 16,
+ "id": 226,
"name": "My updated book",
"slug": "my-updated-book",
"description": "This is my book with updated details",
- "created_at": "2020-01-12T14:09:59.000000Z",
- "updated_at": "2020-01-12T14:16:10.000000Z",
+ "created_at": "2023-12-22T14:22:28.000000Z",
+ "updated_at": "2023-12-22T14:24:07.000000Z",
"created_by": 1,
"updated_by": 1,
"owned_by": 1,
- "default_template_id": 12
+ "default_template_id": 2427,
+ "description_html": "<p>This is my book with <em>updated<\/em> details<\/p>",
+ "tags": [
+ {
+ "name": "Subject",
+ "value": "Updates",
+ "order": 0
+ }
+ ],
+ "cover": null
}
\ No newline at end of file
diff --git a/dev/api/responses/chapters-create.json b/dev/api/responses/chapters-create.json
index cf47b123d..183186b0b 100644
--- a/dev/api/responses/chapters-create.json
+++ b/dev/api/responses/chapters-create.json
@@ -1,15 +1,16 @@
{
- "id": 74,
+ "id": 668,
"book_id": 1,
"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": 15,
+ "created_at": "2023-12-22T14:26:28.000000Z",
+ "updated_at": "2023-12-22T14:26:28.000000Z",
"created_by": 1,
"updated_by": 1,
"owned_by": 1,
- "updated_at": "2020-05-22T22:59:55.000000Z",
- "created_at": "2020-05-22T22:59:55.000000Z",
+ "description_html": "<p>This is a <strong>great new chapter<\/strong> that I've created via the API<\/p>",
"tags": [
{
"name": "Category",
@@ -19,7 +20,7 @@
{
"name": "Rating",
"value": "Highest",
- "order": 1
+ "order": 0
}
]
}
\ No newline at end of file
diff --git a/dev/api/responses/chapters-update.json b/dev/api/responses/chapters-update.json
index a4940af2d..5ac3c64c1 100644
--- a/dev/api/responses/chapters-update.json
+++ b/dev/api/responses/chapters-update.json
@@ -1,16 +1,16 @@
{
- "id": 75,
+ "id": 668,
"book_id": 1,
"slug": "my-fantastic-updated-chapter",
"name": "My fantastic updated chapter",
"description": "This is an updated chapter that I've altered via the API",
"priority": 16,
- "created_at": "2020-05-22T23:03:35.000000Z",
- "updated_at": "2020-05-22T23:07:20.000000Z",
+ "created_at": "2023-12-22T14:26:28.000000Z",
+ "updated_at": "2023-12-22T14:27:59.000000Z",
"created_by": 1,
"updated_by": 1,
"owned_by": 1,
- "book_slug": "bookstack-demo-site",
+ "description_html": "<p>This is an <strong>updated chapter<\/strong> that I've altered via the API<\/p>",
"tags": [
{
"name": "Category",
@@ -20,7 +20,7 @@
{
"name": "Rating",
"value": "Medium",
- "order": 1
+ "order": 0
}
]
}
\ No newline at end of file
diff --git a/dev/api/responses/shelves-create.json b/dev/api/responses/shelves-create.json
index 84caf8bdc..235557834 100644
--- a/dev/api/responses/shelves-create.json
+++ b/dev/api/responses/shelves-create.json
@@ -1,11 +1,20 @@
{
- "id": 14,
+ "id": 20,
"name": "My shelf",
"slug": "my-shelf",
"description": "This is my shelf with some books",
"created_by": 1,
"updated_by": 1,
+ "created_at": "2023-12-22T14:33:52.000000Z",
+ "updated_at": "2023-12-22T14:33:52.000000Z",
"owned_by": 1,
- "created_at": "2020-04-10T13:24:09.000000Z",
- "updated_at": "2020-04-10T13:24:09.000000Z"
+ "description_html": "<p>This is <strong>my shelf<\/strong> with some books<\/p>",
+ "tags": [
+ {
+ "name": "Category",
+ "value": "Learning",
+ "order": 0
+ }
+ ],
+ "cover": null
}
\ No newline at end of file
diff --git a/dev/api/responses/shelves-update.json b/dev/api/responses/shelves-update.json
index e199d8d68..3b3f0538e 100644
--- a/dev/api/responses/shelves-update.json
+++ b/dev/api/responses/shelves-update.json
@@ -1,11 +1,20 @@
{
- "id": 14,
+ "id": 20,
"name": "My updated shelf",
"slug": "my-updated-shelf",
- "description": "This is my update shelf with some books",
+ "description": "This is my updated shelf with some books",
"created_by": 1,
"updated_by": 1,
+ "created_at": "2023-12-22T14:33:52.000000Z",
+ "updated_at": "2023-12-22T14:35:00.000000Z",
"owned_by": 1,
- "created_at": "2020-04-10T13:24:09.000000Z",
- "updated_at": "2020-04-10T13:48:22.000000Z"
+ "description_html": "<p>This is my <em>updated shelf<\/em> with some books<\/p>",
+ "tags": [
+ {
+ "name": "Category",
+ "value": "Learning",
+ "order": 0
+ }
+ ],
+ "cover": null
}
\ No newline at end of file