[PR #4332] [MERGED] API Docs: Allowed multi-paragraph descriptions #6349

New Issue

OVERLORD · 2026-02-05T10:30:00+03:00

OVERLORD commented

2026-02-05 10:30:00 +03:00

📋 Pull Request Information

Original PR: https://github.com/BookStackApp/BookStack/pull/4332
Author: @ssddanbrown
Created: 6/21/2023
Status: ✅ Merged
Merged: 6/21/2023
Merged by: @ssddanbrown

Base: development ← Head: api_docs_tweaks

📝 Commits (1)

38883e8 API Docs: Allowed multi-paragraph descriptions

📊 Changes

6 files changed (+27 additions, -17 deletions)

View changed files

📝 app/Api/ApiDocsGenerator.php (+5 -4)
📝 app/Entities/Controllers/PageApiController.php (+0 -1)
📝 app/Permissions/ContentPermissionApiController.php (+3 -0)
📝 app/Uploads/Controllers/ImageGalleryApiController.php (+2 -0)
📝 resources/views/api-docs/parts/endpoint.blade.php (+16 -11)
📝 tests/Api/ApiDocsTest.php (+1 -1)

📄 Description

Added support for mulit-line endpoint descriptions via blank intermediate lines in php controller method docblocks.

Also tweaks endpoint header design for better flexing and alignment.

_{🔄 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/4332 **Author:** [@ssddanbrown](https://github.com/ssddanbrown) **Created:** 6/21/2023 **Status:** ✅ Merged **Merged:** 6/21/2023 **Merged by:** [@ssddanbrown](https://github.com/ssddanbrown) **Base:** `development` ← **Head:** `api_docs_tweaks` --- ### 📝 Commits (1) - [`38883e8`](https://github.com/BookStackApp/BookStack/commit/38883e8d46b76616d9e84dfed35ba363dc30ee79) API Docs: Allowed multi-paragraph descriptions ### 📊 Changes **6 files changed** (+27 additions, -17 deletions) <details> <summary>View changed files</summary> 📝 `app/Api/ApiDocsGenerator.php` (+5 -4) 📝 `app/Entities/Controllers/PageApiController.php` (+0 -1) 📝 `app/Permissions/ContentPermissionApiController.php` (+3 -0) 📝 `app/Uploads/Controllers/ImageGalleryApiController.php` (+2 -0) 📝 `resources/views/api-docs/parts/endpoint.blade.php` (+16 -11) 📝 `tests/Api/ApiDocsTest.php` (+1 -1) </details> ### 📄 Description Added support for mulit-line endpoint descriptions via blank intermediate lines in php controller method docblocks. Also tweaks endpoint header design for better flexing and alignment. --- <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:30:00 +03:00

OVERLORD closed this issue

2026-02-05 10:30:04 +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#6349