archive/BookStackApp_BookStack
0
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-05-02 07:20:05 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request from devdot/update-api-docs

Browse source 
Update API Docs
This commit is contained in:
Dan Brown 2023-07-05 12:08:51 +01:00 • committed by GitHub
commit e04a1af444
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 101 additions and 72 deletions

6
dev/api/responses/books-create.json
View file

@ -1,11 +1,11 @@
{ {
"id": 15,
"name": "My new book", "name": "My new book",
"slug": "my-new-book",
"description": "This is a book created via the API", "description": "This is a book created via the API",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1, "owned_by": 1,
"slug": "my-new-book",
"updated_at": "2020-01-12T14:05:11.000000Z", "updated_at": "2020-01-12T14:05:11.000000Z",
"created_at": "2020-01-12T14:05:11.000000Z", "created_at": "2020-01-12T14:05:11.000000Z"
"id": 15
} }

13
dev/api/responses/books-read.json
View file

@ -7,15 +7,18 @@
"updated_at": "2020-01-12T14:11:51.000000Z", "updated_at": "2020-01-12T14:11:51.000000Z",
"created_by": { "created_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"updated_by": { "updated_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"owned_by": { "owned_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"contents": [ "contents": [
{ {
@ -52,12 +55,12 @@
"template": false, "template": false,
"created_at": "2021-12-19T18:22:11.000000Z", "created_at": "2021-12-19T18:22:11.000000Z",
"updated_at": "2022-07-29T13:44:15.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": [ "tags": [
{ {
"id": 13,
"name": "Category", "name": "Category",
"value": "Guide", "value": "Guide",
"order": 0 "order": 0

24
dev/api/responses/chapters-create.json
View file

@ -1,39 +1,25 @@
{ {
"id": 74,
"book_id": 1, "book_id": 1,
"priority": 6, "slug": "my-fantastic-new-chapter",
"name": "My fantastic new chapter", "name": "My fantastic new chapter",
"description": "This is a great new chapter that I've created via the API", "description": "This is a great new chapter that I've created via the API",
"priority": 6,
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1, "owned_by": 1,
"slug": "my-fantastic-new-chapter",
"updated_at": "2020-05-22T22:59:55.000000Z", "updated_at": "2020-05-22T22:59:55.000000Z",
"created_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": [ "tags": [
{ {
"name": "Category", "name": "Category",
"value": "Top Content", "value": "Top Content",
"order": 0, "order": 0
"created_at": "2020-05-22T22:59:55.000000Z",
"updated_at": "2020-05-22T22:59:55.000000Z"
}, },
{ {
"name": "Rating", "name": "Rating",
"value": "Highest", "value": "Highest",
"order": 0, "order": 1
"created_at": "2020-05-22T22:59:55.000000Z",
"updated_at": "2020-05-22T22:59:55.000000Z"
} }
] ]
} }

6
dev/api/responses/chapters-list.json
View file

@ -11,7 +11,8 @@
"updated_at": "2019-09-28T11:24:23.000000Z", "updated_at": "2019-09-28T11:24:23.000000Z",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1 "owned_by": 1,
"book_slug": "example-book"
}, },
{ {
"id": 2, "id": 2,
@ -24,7 +25,8 @@
"updated_at": "2019-10-17T15:05:34.000000Z", "updated_at": "2019-10-17T15:05:34.000000Z",
"created_by": 3, "created_by": 3,
"updated_by": 3, "updated_by": 3,
"owned_by": 3 "owned_by": 3,
"book_slug": "example-book"
} }
], ],
"total": 40 "total": 40

20
dev/api/responses/chapters-read.json
View file

@ -9,16 +9,20 @@
"updated_at": "2019-09-28T11:24:23.000000Z", "updated_at": "2019-09-28T11:24:23.000000Z",
"created_by": { "created_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"updated_by": { "updated_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"owned_by": { "owned_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"book_slug": "example-book",
"tags": [ "tags": [
{ {
"name": "Category", "name": "Category",
@ -38,9 +42,12 @@
"updated_at": "2019-08-26T14:32:59.000000Z", "updated_at": "2019-08-26T14:32:59.000000Z",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1,
"draft": false, "draft": false,
"revision_count": 2, "revision_count": 2,
"template": false "template": false,
"editor": "wysiwyg",
"book_slug": "example-book"
}, },
{ {
"id": 7, "id": 7,
@ -53,9 +60,12 @@
"updated_at": "2019-06-06T12:03:04.000000Z", "updated_at": "2019-06-06T12:03:04.000000Z",
"created_by": 3, "created_by": 3,
"updated_by": 3, "updated_by": 3,
"owned_by": 1,
"draft": false, "draft": false,
"revision_count": 1, "revision_count": 1,
"template": false "template": false,
"editor": "wysiwyg",
"book_slug": "example-book"
} }
] ]
} }

19
dev/api/responses/chapters-update.json
View file

@ -10,30 +10,17 @@
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1, "owned_by": 1,
"book": { "book_slug": "bookstack-demo-site",
"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": [ "tags": [
{ {
"name": "Category", "name": "Category",
"value": "Kinda Good Content", "value": "Kinda Good Content",
"order": 0, "order": 0
"created_at": "2020-05-22T23:07:20.000000Z",
"updated_at": "2020-05-22T23:07:20.000000Z"
}, },
{ {
"name": "Rating", "name": "Rating",
"value": "Medium", "value": "Medium",
"order": 0, "order": 1
"created_at": "2020-05-22T23:07:20.000000Z",
"updated_at": "2020-05-22T23:07:20.000000Z"
} }
] ]
} }

10
dev/api/responses/pages-create.json
View file

@ -11,20 +11,24 @@
"updated_at": "2020-11-28T15:01:39.000000Z", "updated_at": "2020-11-28T15:01:39.000000Z",
"created_by": { "created_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"updated_by": { "updated_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"owned_by": { "owned_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"draft": false, "draft": false,
"markdown": "", "markdown": "",
"revision_count": 1, "revision_count": 1,
"template": false, "template": false,
"editor": "wysiwyg",
"tags": [ "tags": [
{ {
"name": "Category", "name": "Category",

15
dev/api/responses/pages-list.json
View file

@ -8,12 +8,15 @@
"slug": "how-to-create-page-content", "slug": "how-to-create-page-content",
"priority": 0, "priority": 0,
"draft": false, "draft": false,
"revision_count": 3,
"template": false, "template": false,
"created_at": "2019-05-05T21:49:58.000000Z", "created_at": "2019-05-05T21:49:58.000000Z",
"updated_at": "2020-07-04T15:50:58.000000Z", "updated_at": "2020-07-04T15:50:58.000000Z",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1 "owned_by": 1,
"editor": "wysiwyg",
"book_slug": "example-book"
}, },
{ {
"id": 2, "id": 2,
@ -23,12 +26,15 @@
"slug": "how-to-use-images", "slug": "how-to-use-images",
"priority": 2, "priority": 2,
"draft": false, "draft": false,
"revision_count": 3,
"template": false, "template": false,
"created_at": "2019-05-05T21:53:30.000000Z", "created_at": "2019-05-05T21:53:30.000000Z",
"updated_at": "2019-06-06T12:03:04.000000Z", "updated_at": "2019-06-06T12:03:04.000000Z",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1 "owned_by": 1,
"editor": "wysiwyg",
"book_slug": "example-book"
}, },
{ {
"id": 3, "id": 3,
@ -38,12 +44,15 @@
"slug": "drawings-via-drawio", "slug": "drawings-via-drawio",
"priority": 3, "priority": 3,
"draft": false, "draft": false,
"revision_count": 3,
"template": false, "template": false,
"created_at": "2019-05-05T21:53:49.000000Z", "created_at": "2019-05-05T21:53:49.000000Z",
"updated_at": "2019-12-18T21:56:52.000000Z", "updated_at": "2019-12-18T21:56:52.000000Z",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1 "owned_by": 1,
"editor": "wysiwyg",
"book_slug": "example-book"
} }
], ],
"total": 322 "total": 322

10
dev/api/responses/pages-read.json
View file

@ -11,20 +11,24 @@
"updated_at": "2020-11-28T14:43:20.000000Z", "updated_at": "2020-11-28T14:43:20.000000Z",
"created_by": { "created_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"updated_by": { "updated_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"owned_by": { "owned_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"draft": false, "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[![yXSrubes.jpg](http://example.com/uploads/images/gallery/2020-04/scaled-1680-/yXSrubes.jpg)](http://example.com/uploads/images/gallery/2020-04/yXSrubes.jpg)", "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[![yXSrubes.jpg](http://example.com/uploads/images/gallery/2020-04/scaled-1680-/yXSrubes.jpg)](http://example.com/uploads/images/gallery/2020-04/yXSrubes.jpg)",
"revision_count": 5, "revision_count": 5,
"template": false, "template": false,
"editor": "wysiwyg",
"tags": [ "tags": [
{ {
"name": "Category", "name": "Category",

10
dev/api/responses/pages-update.json
View file

@ -11,20 +11,24 @@
"updated_at": "2020-11-28T15:13:03.000000Z", "updated_at": "2020-11-28T15:13:03.000000Z",
"created_by": { "created_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"updated_by": { "updated_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"owned_by": { "owned_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"draft": false, "draft": false,
"markdown": "", "markdown": "",
"revision_count": 5, "revision_count": 5,
"template": false, "template": false,
"editor": "wysiwyg",
"tags": [ "tags": [
{ {
"name": "Category", "name": "Category",

6
dev/api/responses/shelves-create.json
View file

@ -1,11 +1,11 @@
{ {
"id": 14,
"name": "My shelf", "name": "My shelf",
"slug": "my-shelf",
"description": "This is my shelf with some books", "description": "This is my shelf with some books",
"created_by": 1, "created_by": 1,
"updated_by": 1, "updated_by": 1,
"owned_by": 1, "owned_by": 1,
"slug": "my-shelf",
"updated_at": "2020-04-10T13:24:09.000000Z",
"created_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"
} }

34
dev/api/responses/shelves-read.json
View file

@ -5,21 +5,23 @@
"description": "This is my shelf with some books", "description": "This is my shelf with some books",
"created_by": { "created_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"updated_by": { "updated_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"owned_by": { "owned_by": {
"id": 1, "id": 1,
"name": "Admin" "name": "Admin",
"slug": "admin"
}, },
"created_at": "2020-04-10T13:24:09.000000Z", "created_at": "2020-04-10T13:24:09.000000Z",
"updated_at": "2020-04-10T13:31:04.000000Z", "updated_at": "2020-04-10T13:31:04.000000Z",
"tags": [ "tags": [
{ {
"id": 16,
"name": "Category", "name": "Category",
"value": "Guide", "value": "Guide",
"order": 0 "order": 0
@ -41,17 +43,35 @@
{ {
"id": 5, "id": 5,
"name": "Sint explicabo alias sunt.", "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, "id": 1,
"name": "BookStack User Guide", "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, "id": 3,
"name": "Molestiae doloribus sint velit suscipit dolorem.", "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
} }
] ]
} }