Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Syndesi committed Oct 28, 2023
1 parent 332c2f5 commit b875f6c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
to #163.
### Changed
- Update readme and docker image labels.
- Increase reference dataset version to 0.0.15, skipped 0.0.14 due to erroneous release.
### Fixed
- Fix index endpoint to include elements which are directly owned or are accessible. Fixes #163.

Expand Down
19 changes: 14 additions & 5 deletions docs/api-endpoints/element/get-index/200-response-body.json
Original file line number Diff line number Diff line change
@@ -1,29 +1,38 @@
{
"type": "_PartialCollection",
"id": "/",
"totalNodes": 2,
"totalNodes": 3,
"links": {
"first": "/",
"previous": null,
"next": null,
"last": "/"
},
"nodes": [
{
"type": "Sphere",
"id": "56fda20c-b238-4034-b555-1df47c47e17a",
"data": {
"created": "2023-10-28T21:03:25+00:00",
"updated": "2023-10-28T21:03:25+00:00",
"name": "Tag"
}
},
{
"type": "Sphere",
"id": "7b80b203-2b82-40f5-accd-c7089fe6114e",
"data": {
"created": "2023-10-06T20:04:04+00:00",
"updated": "2023-10-06T20:04:04+00:00",
"created": "2023-10-28T21:03:25+00:00",
"updated": "2023-10-28T21:03:25+00:00",
"name": "Comment"
}
},
{
"type": "Token",
"id": "e3b81351-fe0c-4f8f-ad22-78b6157edde8",
"data": {
"created": "2023-10-06T20:04:04+00:00",
"updated": "2023-10-06T20:04:04+00:00",
"created": "2023-10-28T21:03:25+00:00",
"updated": "2023-10-28T21:03:25+00:00",
"note": "Token contains token only due to testing purposes."
}
}
Expand Down
2 changes: 1 addition & 1 deletion tests/ExampleGenerationController/Element/GetIndexTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class GetIndexTest extends BaseRequestTestCase
public function testGetIndexSuccess(): void
{
$response = $this->runGetRequest('/', self::TOKEN);
$this->assertIsCollectionResponse($response, 2);
$this->assertIsCollectionResponse($response, 3);
$documentationHeadersPath = 'docs/api-endpoints/element/get-index/200-response-header.txt';
$documentationBodyPath = 'docs/api-endpoints/element/get-index/200-response-body.json';
$this->assertHeadersInDocumentationAreIdenticalToHeadersFromRequest(
Expand Down

0 comments on commit b875f6c

Please sign in to comment.