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

API Docs: Add User Slugs to Example Responses

Browse source
This commit is contained in:
Thomas Kuschan 2023-06-30 09:23:02 +02:00
parent e47870794d
commit ca2d2c97d4
6 changed files with 36 additions and 18 deletions

9
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": [
{ {

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

@ -9,15 +9,18 @@
"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"
}, },
"tags": [ "tags": [
{ {

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

@ -11,15 +11,18 @@
"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": "",

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

@ -11,15 +11,18 @@
"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)",

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

@ -11,15 +11,18 @@
"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": "",

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

@ -5,15 +5,18 @@
"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",