luisgulo/BookStack
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Chapters API: Added missing book_slug field

Browse source 
Was removed during previous changes, but reflected in response examples.
This adds into all standard single chapter responses.
For #4765
This commit is contained in:
Dan Brown 2024-01-16 12:06:13 +00:00
parent afbbcafd44
commit adf1806fea
No known key found for this signature in database
GPG key ID: 46D9F943C24A2EF9
4 changed files with 13 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
app/Entities/Controllers/ChapterApiController.php
View file

@ -134,8 +134,9 @@ class ChapterApiController extends ApiController
$chapter->unsetRelations()->refresh();
$chapter->load(['tags']);
$chapter->makeVisible('description_html')
->setAttribute('description_html', $chapter->descriptionHtml());
$chapter->makeVisible('description_html');
$chapter->setAttribute('description_html', $chapter->descriptionHtml());
$chapter->setAttribute('book_slug', $chapter->book()->first()->slug);
return $chapter;
}

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

@ -11,6 +11,7 @@
"updated_by": 1,
"owned_by": 1,
"description_html": "<p>This is a <strong>great new chapter<\/strong> that I've created via the API<\/p>",
"book_slug": "example-book",
"tags": [
{
"name": "Category",

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

@ -11,6 +11,7 @@
"updated_by": 1,
"owned_by": 1,
"description_html": "<p>This is an <strong>updated chapter<\/strong> that I've altered via the API<\/p>",
"book_slug": "example-book",
"tags": [
{
"name": "Category",

13
tests/Api/ChaptersApiTest.php
View file

@ -22,11 +22,12 @@ class ChaptersApiTest extends TestCase
$resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');
$resp->assertJson(['data' => [
[
'id' => $firstChapter->id,
'name' => $firstChapter->name,
'slug' => $firstChapter->slug,
'book_id' => $firstChapter->book->id,
'priority' => $firstChapter->priority,
'id' => $firstChapter->id,
'name' => $firstChapter->name,
'slug' => $firstChapter->slug,
'book_id' => $firstChapter->book->id,
'priority' => $firstChapter->priority,
'book_slug' => $firstChapter->book->slug,
],
]]);
}
@ -130,6 +131,7 @@ class ChaptersApiTest extends TestCase
$resp->assertJson([
'id' => $chapter->id,
'slug' => $chapter->slug,
'book_slug' => $chapter->book->slug,
'created_by' => [
'name' => $chapter->createdBy->name,
],
@ -148,6 +150,7 @@ class ChaptersApiTest extends TestCase
],
],
]);
$resp->assertJsonMissingPath('book');
$resp->assertJsonCount($chapter->pages()->count(), 'pages');
}