[PR #2382] [MERGED] Pages API #5987

New Issue

OVERLORD · 2026-02-05T10:21:55+03:00

OVERLORD commented

2026-02-05 10:21:55 +03:00

📋 Pull Request Information

Original PR: https://github.com/BookStackApp/BookStack/pull/2382
Author: @ssddanbrown
Created: 11/22/2020
Status: ✅ Merged
Merged: 11/28/2020
Merged by: @ssddanbrown

Base: master ← Head: pages_api

📝 Commits (5)

1c8102b Started pages API
53bcfe5 Added pages API doc examples
875a8bd Made docs sidebar a slight bit easier to scroll
8aedba1 Added page export API controller
57754c8 Added testing to cover the pages API

📊 Changes

27 files changed (+707 additions, -52 deletions)

View changed files

📝 app/Actions/Tag.php (+1 -1)
📝 app/Entities/Models/Book.php (+1 -1)
📝 app/Entities/Models/Bookshelf.php (+1 -1)
📝 app/Entities/Models/Chapter.php (+1 -1)
📝 app/Entities/Models/Page.php (+18 -1)
📝 app/Entities/Repos/PageRepo.php (+20 -16)
📝 app/Entities/Tools/PageContent.php (+22 -0)
📝 app/Http/Controllers/Api/ApiController.php (+1 -1)
📝 app/Http/Controllers/Api/BookApiController.php (+2 -1)
📝 app/Http/Controllers/Api/BookExportApiController.php (+1 -7)
📝 app/Http/Controllers/Api/BookshelfApiController.php (+2 -1)
📝 app/Http/Controllers/Api/ChapterApiController.php (+2 -1)
📝 app/Http/Controllers/Api/ChapterExportApiController.php (+1 -3)
➕ app/Http/Controllers/Api/PageApiController.php (+140 -0)
➕ app/Http/Controllers/Api/PageExportApiController.php (+47 -0)
➕ dev/api/requests/pages-create.json (+9 -0)
➕ dev/api/requests/pages-update.json (+9 -0)
📝 dev/api/responses/books-read.json (+1 -5)
📝 dev/api/responses/chapters-read.json (+5 -7)
➕ dev/api/responses/pages-create.json (+35 -0)

...and 7 more files

📄 Description

CRUD API
Export API
Testing
Docs

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/BookStackApp/BookStack/pull/2382 **Author:** [@ssddanbrown](https://github.com/ssddanbrown) **Created:** 11/22/2020 **Status:** ✅ Merged **Merged:** 11/28/2020 **Merged by:** [@ssddanbrown](https://github.com/ssddanbrown) **Base:** `master` ← **Head:** `pages_api` --- ### 📝 Commits (5) - [`1c8102b`](https://github.com/BookStackApp/BookStack/commit/1c8102bb897bc479abfcc3432353907d90654b1e) Started pages API - [`53bcfe5`](https://github.com/BookStackApp/BookStack/commit/53bcfe528d96938132eb168433ea1fee9b9fd935) Added pages API doc examples - [`875a8bd`](https://github.com/BookStackApp/BookStack/commit/875a8bdafffcf7641ec4f19c95dbaad03bce0138) Made docs sidebar a slight bit easier to scroll - [`8aedba1`](https://github.com/BookStackApp/BookStack/commit/8aedba14a3d75d26230cf9b7393bea72a1e70488) Added page export API controller - [`57754c8`](https://github.com/BookStackApp/BookStack/commit/57754c8211b0c76b9b5fb6046bfda0838660c289) Added testing to cover the pages API ### 📊 Changes **27 files changed** (+707 additions, -52 deletions) <details> <summary>View changed files</summary> 📝 `app/Actions/Tag.php` (+1 -1) 📝 `app/Entities/Models/Book.php` (+1 -1) 📝 `app/Entities/Models/Bookshelf.php` (+1 -1) 📝 `app/Entities/Models/Chapter.php` (+1 -1) 📝 `app/Entities/Models/Page.php` (+18 -1) 📝 `app/Entities/Repos/PageRepo.php` (+20 -16) 📝 `app/Entities/Tools/PageContent.php` (+22 -0) 📝 `app/Http/Controllers/Api/ApiController.php` (+1 -1) 📝 `app/Http/Controllers/Api/BookApiController.php` (+2 -1) 📝 `app/Http/Controllers/Api/BookExportApiController.php` (+1 -7) 📝 `app/Http/Controllers/Api/BookshelfApiController.php` (+2 -1) 📝 `app/Http/Controllers/Api/ChapterApiController.php` (+2 -1) 📝 `app/Http/Controllers/Api/ChapterExportApiController.php` (+1 -3) ➕ `app/Http/Controllers/Api/PageApiController.php` (+140 -0) ➕ `app/Http/Controllers/Api/PageExportApiController.php` (+47 -0) ➕ `dev/api/requests/pages-create.json` (+9 -0) ➕ `dev/api/requests/pages-update.json` (+9 -0) 📝 `dev/api/responses/books-read.json` (+1 -5) 📝 `dev/api/responses/chapters-read.json` (+5 -7) ➕ `dev/api/responses/pages-create.json` (+35 -0) _...and 7 more files_ </details> ### 📄 Description - [x] CRUD API - [x] Export API - [x] Testing - [x] Docs --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

OVERLORD added the pull-request label 2026-02-05 10:21:55 +03:00

OVERLORD closed this issue

2026-02-05 10:21:57 +03:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#5987