BookStack/dev/api/responses
Dan Brown 4c7d6420ee
Some checks failed
analyse-php / build (push) Has been cancelled
lint-js / build (push) Has been cancelled
lint-php / build (push) Has been cancelled
test-js / build (push) Has been cancelled
test-migrations / build (8.2) (push) Has been cancelled
test-migrations / build (8.3) (push) Has been cancelled
test-migrations / build (8.4) (push) Has been cancelled
test-php / build (8.2) (push) Has been cancelled
test-php / build (8.3) (push) Has been cancelled
test-php / build (8.4) (push) Has been cancelled
DB: Aligned entity structure to a common table
As per PR #5800

* DB: Planned out new entity table format via migrations

* DB: Created entity migration logic

Made some other tweaks/fixes while testing.

* DB: Added change of entity relation columns to suit new entities table

* DB: Got most view queries working for new structure

* Entities: Started logic change to new structure

Updated base entity class, and worked through BaseRepo.
Need to go through other repos next.

Removed a couple of redundant interfaces as part of this since we can
move the logic onto the shared ContainerData model as needed.

* Entities: Been through repos to update for new format

* Entities: Updated repos to act on refreshed clones

Changes to core entity models are now done on clones to ensure clean
state before save, and those clones are returned back if changes are
needed after that action.

* Entities: Updated model classes & relations for changes

* Entities: Changed from *Data to a common "contents" system

Added smart loading from builder instances which should hydrate with
"contents()" loaded via join, while keeping the core model original.

* Entities: Moved entity description/covers to own non-model classes

Added back some interfaces.

* Entities: Removed use of contents system for data access

* Entities: Got most queries back to working order

* Entities: Reverted back to data from contents, fixed various issues

* Entities: Started addressing issues from tests

* Entities: Addressed further tests/issues

* Entities: Been through tests to get all passing in dev

Fixed issues and needed test changes along the way.

* Entities: Addressed phpstan errors

* Entities: Reviewed TODO notes

* Entities: Ensured book/shelf relation data removed on destroy

* Entities: Been through API responses & adjusted field visibility

* Entities: Added type index to massively improve query speed
2025-10-18 13:14:30 +01:00
..
attachments-create.json Updated API examples with date format changes 2021-11-04 22:02:21 +00:00
attachments-list.json Updated API examples with date format changes 2021-11-04 22:02:21 +00:00
attachments-read.json Updated API examples with date format changes 2021-11-04 22:02:21 +00:00
attachments-update.json Updated API examples with date format changes 2021-11-04 22:02:21 +00:00
audit-log-list.json API: Added audit log list endpoint 2024-05-04 16:28:18 +01:00
books-create.json Input WYSIWYG: Updated API examples to align with changes 2023-12-22 14:37:48 +00:00
books-list.json API: Added cover to book/shelf list endpoints 2024-12-13 14:21:04 +00:00
books-read.json DB: Aligned entity structure to a common table 2025-10-18 13:14:30 +01:00
books-update.json Input WYSIWYG: Updated API examples to align with changes 2023-12-22 14:37:48 +00:00
chapters-create.json Merge branch 'chapter-templates' into development 2024-02-01 12:55:38 +00:00
chapters-list.json API Docs: Add book_slug to Example Responses 2023-06-30 09:33:53 +02:00
chapters-read.json Default chapter templates: Updated api docs and tests 2024-02-01 12:22:16 +00:00
chapters-update.json Merge branch 'chapter-templates' into development 2024-02-01 12:55:38 +00:00
content-permissions-read.json Added content-perms API examples and docs tweaks 2023-03-13 20:41:32 +00:00
content-permissions-update.json Added content-perms API examples and docs tweaks 2023-03-13 20:41:32 +00:00
image-gallery-create.json API: Fixed misaligned image datetime format 2023-06-10 10:54:56 +01:00
image-gallery-list.json Added examples, updated docs for image gallery api endpoints 2023-03-15 11:37:03 +00:00
image-gallery-read.json API: Fixed misaligned image datetime format 2023-06-10 10:54:56 +01:00
image-gallery-update.json API: Fixed misaligned image datetime format 2023-06-10 10:54:56 +01:00
imports-create.json ZIP Imports: Added API examples, finished testing 2025-07-18 16:19:14 +01:00
imports-list.json ZIP Imports: Added API examples, finished testing 2025-07-18 16:19:14 +01:00
imports-read.json ZIP Imports: Added API examples, finished testing 2025-07-18 16:19:14 +01:00
imports-run.json ZIP Imports: Added API examples, finished testing 2025-07-18 16:19:14 +01:00
pages-create.json DB: Aligned entity structure to a common table 2025-10-18 13:14:30 +01:00
pages-list.json API Docs: Add Missing Fields in Example Responses 2023-06-30 09:36:46 +02:00
pages-read.json DB: Aligned entity structure to a common table 2025-10-18 13:14:30 +01:00
pages-update.json API Docs: Add Missing editor fields in Example Responses 2023-06-30 09:35:47 +02:00
recycle-bin-destroy.json Reviewed recycle bin API PR and made changes 2022-04-25 17:54:59 +01:00
recycle-bin-list.json DB: Aligned entity structure to a common table 2025-10-18 13:14:30 +01:00
recycle-bin-restore.json Reviewed recycle bin API PR and made changes 2022-04-25 17:54:59 +01:00
roles-create.json Added role API responses & requests 2023-02-19 15:58:29 +00:00
roles-list.json Added role API responses & requests 2023-02-19 15:58:29 +00:00
roles-read.json Added role API responses & requests 2023-02-19 15:58:29 +00:00
roles-update.json Added role API responses & requests 2023-02-19 15:58:29 +00:00
search-all.json Search API: Updated handling of parent detail, added testing 2024-12-03 13:51:46 +00:00
shelves-create.json Input WYSIWYG: Updated API examples to align with changes 2023-12-22 14:37:48 +00:00
shelves-list.json API: Added cover to book/shelf list endpoints 2024-12-13 14:21:04 +00:00
shelves-read.json Input WYSIWYG: Updated API to show/accept html descriptions 2023-12-21 13:23:52 +00:00
shelves-update.json Input WYSIWYG: Updated API examples to align with changes 2023-12-22 14:37:48 +00:00
system-read.json API: Added system read endpoint 2025-05-13 20:38:08 +01:00
users-create.json Added user API examples 2022-02-04 00:44:56 +00:00
users-list.json API: Updated docs with consistent types, fixed users response example 2024-08-27 12:23:36 +01:00
users-read.json Added user API examples 2022-02-04 00:44:56 +00:00
users-update.json Added user API examples 2022-02-04 00:44:56 +00:00