Repository navigation
GET container endpoints with optional paging - #1025
Draft
dennisvang wants to merge 6 commits into
Draft
dennisvang wants to merge 6 commits into
dennisvang wants to merge 6 commits into
Conversation
…tainer>/ endpoints this controller has optional paging also re-use the controller method for getMetadataChildren
…esources) instead of a single method with multiple patterns and optional path parameters
actually not sure if they are even required, but we'll keep them because they are also in getMetadataChildren
Contributor
Author
|
Now blocked by uncertainty w.r.t. the desired behavior for container endpoints. |
Contributor
Author
|
In addition, the custom openapi config is broken, because e.g. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This enables GET requests to container endpoints, such as
/catalog/,/dataset/,/catalog/<id>/dataset/, and so on.Paging is optional, depending on the presence of query parameters
pageandsize.getMetadataChildrenmethod:"/{urlPrefix}/""/{urlPrefix}/{recordId}/{childPrefix}/"/page/endpoints (getMetadataChildren) now delegate to the new methodsImportant
The original
/page/endpoints are now deprecated for removal. We keep them around until the next major version, for backward compatibility.Note
The
urlPrefixis actually the resource type and represents the LDP container.The
recordIdis actually the resource Id.The
childPrefixis actually the child resource type, representing the name of another LDP container.I would like to rename these variables accordingly, but that would require a major refactor, because this terminology is used throughout the code base, even down to the database level.
So, we'll stick to the existing terminology, to remain consistent with the rest of the code.
fixes #842
todo:
Assisted-by: copilot
AI disclosure: Copilot was used for guidance about best practices regarding path patterns and optional path variables. Copilot (free) was also used to review the PR, due to absence of human reviewers.