Skip to content

Commit fb3cfaf

Browse files
ssddanbrownssddanbrown
committed
Input WYSIWYG: Updated API examples to align with changes
1 parent 2a7a81e commit fb3cfaf

12 files changed

+81
-36
lines changed

‎dev/api/requests/books-create.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "My own book",
3-
"description": "This is my own little book",
4-
"default_template_id": 12,
3+
"description_html": "<p>This is <strong>my</strong> own little book created via the API</p>",
4+
"default_template_id": 2427,
55
"tags": [
66
{"name": "Category", "value": "Top Content"},
77
{"name": "Rating", "value": "Highest"}

‎dev/api/requests/books-update.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "My updated book",
3-
"description": "This is my book with updated details",
4-
"default_template_id": 12,
3+
"description_html": "<p>This is my book with <em>updated</em> details</p>",
4+
"default_template_id": 2427,
55
"tags": [
66
{"name": "Subject", "value": "Updates"}
77
]

‎dev/api/requests/chapters-create.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"book_id": 1,
33
"name": "My fantastic new chapter",
4-
"description": "This is a great new chapter that I've created via the API",
4+
"description_html": "<p>This is a <strong>great new chapter</strong> that I've created via the API</p>",
55
"priority": 15,
66
"tags": [
77
{"name": "Category", "value": "Top Content"},

‎dev/api/requests/chapters-update.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"book_id": 1,
33
"name": "My fantastic updated chapter",
4-
"description": "This is an updated chapter that I've altered via the API",
4+
"description_html": "<p>This is an <strong>updated chapter</strong> that I've altered via the API</p>",
55
"priority": 16,
66
"tags": [
77
{"name": "Category", "value": "Kinda Good Content"},

‎dev/api/requests/shelves-create.json‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
{
22
"name": "My shelf",
3-
"description": "This is my shelf with some books",
4-
"books": [5,1,3]
3+
"description_html": "<p>This is <strong>my shelf</strong> with some books</p>",
4+
"books": [5,1,3],
5+
"tags": [
6+
{"name": "Category", "value": "Learning"}
7+
]
58
}

‎dev/api/requests/shelves-update.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"name": "My updated shelf",
3-
"description": "This is my update shelf with some books",
3+
"description_html": "<p>This is my <em>updated shelf</em> with some books</p>",
44
"books": [5,1,3]
55
}

‎dev/api/responses/books-create.json‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
11
{
2-
"id": 15,
3-
"name": "My new book",
4-
"slug": "my-new-book",
5-
"description": "This is a book created via the API",
2+
"id": 226,
3+
"name": "My own book",
4+
"slug": "my-own-book",
5+
"description": "This is my own little book created via the API",
6+
"created_at": "2023-12-22T14:22:28.000000Z",
7+
"updated_at": "2023-12-22T14:22:28.000000Z",
68
"created_by": 1,
79
"updated_by": 1,
810
"owned_by": 1,
9-
"default_template_id": 12,
10-
"updated_at": "2020-01-12T14:05:11.000000Z",
11-
"created_at": "2020-01-12T14:05:11.000000Z"
11+
"default_template_id": 2427,
12+
"description_html": "<p>This is <strong>my<\/strong> own little book created via the API<\/p>",
13+
"tags": [
14+
{
15+
"name": "Category",
16+
"value": "Top Content",
17+
"order": 0
18+
},
19+
{
20+
"name": "Rating",
21+
"value": "Highest",
22+
"order": 0
23+
}
24+
],
25+
"cover": null
1226
}

‎dev/api/responses/books-update.json‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
{
2-
"id": 16,
2+
"id": 226,
33
"name": "My updated book",
44
"slug": "my-updated-book",
55
"description": "This is my book with updated details",
6-
"created_at": "2020-01-12T14:09:59.000000Z",
7-
"updated_at": "2020-01-12T14:16:10.000000Z",
6+
"created_at": "2023-12-22T14:22:28.000000Z",
7+
"updated_at": "2023-12-22T14:24:07.000000Z",
88
"created_by": 1,
99
"updated_by": 1,
1010
"owned_by": 1,
11-
"default_template_id": 12
11+
"default_template_id": 2427,
12+
"description_html": "<p>This is my book with <em>updated<\/em> details<\/p>",
13+
"tags": [
14+
{
15+
"name": "Subject",
16+
"value": "Updates",
17+
"order": 0
18+
}
19+
],
20+
"cover": null
1221
}

‎dev/api/responses/chapters-create.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
{
2-
"id": 74,
2+
"id": 668,
33
"book_id": 1,
44
"slug": "my-fantastic-new-chapter",
55
"name": "My fantastic new chapter",
66
"description": "This is a great new chapter that I've created via the API",
77
"priority": 15,
8+
"created_at": "2023-12-22T14:26:28.000000Z",
9+
"updated_at": "2023-12-22T14:26:28.000000Z",
810
"created_by": 1,
911
"updated_by": 1,
1012
"owned_by": 1,
11-
"updated_at": "2020-05-22T22:59:55.000000Z",
12-
"created_at": "2020-05-22T22:59:55.000000Z",
13+
"description_html": "<p>This is a <strong>great new chapter<\/strong> that I've created via the API<\/p>",
1314
"tags": [
1415
{
1516
"name": "Category",
@@ -19,7 +20,7 @@
1920
{
2021
"name": "Rating",
2122
"value": "Highest",
22-
"order": 1
23+
"order": 0
2324
}
2425
]
2526
}

‎dev/api/responses/chapters-update.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
{
2-
"id": 75,
2+
"id": 668,
33
"book_id": 1,
44
"slug": "my-fantastic-updated-chapter",
55
"name": "My fantastic updated chapter",
66
"description": "This is an updated chapter that I've altered via the API",
77
"priority": 16,
8-
"created_at": "2020-05-22T23:03:35.000000Z",
9-
"updated_at": "2020-05-22T23:07:20.000000Z",
8+
"created_at": "2023-12-22T14:26:28.000000Z",
9+
"updated_at": "2023-12-22T14:27:59.000000Z",
1010
"created_by": 1,
1111
"updated_by": 1,
1212
"owned_by": 1,
13-
"book_slug": "bookstack-demo-site",
13+
"description_html": "<p>This is an <strong>updated chapter<\/strong> that I've altered via the API<\/p>",
1414
"tags": [
1515
{
1616
"name": "Category",
@@ -20,7 +20,7 @@
2020
{
2121
"name": "Rating",
2222
"value": "Medium",
23-
"order": 1
23+
"order": 0
2424
}
2525
]
2626
}

0 commit comments

Comments
 (0)