-
Notifications
You must be signed in to change notification settings - Fork 173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Structured datastore query endpoint #3248
Merged
Merged
Conversation
This file contains 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
dafeder
commented
Dec 8, 2020
@@ -13,7 +13,7 @@ trait JsonResponseTrait { | |||
* Private. | |||
*/ | |||
private function getResponse($message, int $code = 200): JsonResponse { | |||
return new JsonResponse($message, $code, ["Access-Control-Allow-Origin" => "*"]); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Document this change
dafeder
commented
Dec 8, 2020
6a3fe6b
to
f153233
Compare
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.
Introduces a new API endpoint for querying datastore tables using a JSON syntax. This need arose from a need for more functionality than the current SQL endpoint provides, including:
The decision to implement these first in a JSON endpoint rather than expanding the SQL endpoint came from these considerations:
This PR also brings in our new library for working with validate-able JSON data structures in DKAN, GetDKAN/RootedJsonData. We are hoping this finds its way into the rest of the DKAN codebase and provides a standardized way to pass JSON data around the system and ensure that it is always valid.
QA Steps
If this works, try different types of queries using the tests in this PR and the query.json schema for guidance.
Known issues
DatastoreQuery
and the core DKANQuery
. This is pretty redundant and adds a lot of complexity to translate from one to another. We should try to collapse or simplify this.Merge steps
Resolves #3073, resolves #3258