-
Notifications
You must be signed in to change notification settings - Fork 486
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
Search API results payload extension #10811
Merged
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
5831476
Added: collection properties to solr search API results
GPortas 270fb9f
Merge branch 'develop' of github.com:IQSS/dataverse into 10810-search…
GPortas 54d85ef
Removed: unused import
GPortas bbf6293
Added: releaseOrCreateDate field to Dataset and DataFile entities in …
GPortas 3a4bcf2
Refactor: getDateTimePublished
GPortas 3e0aae4
Changed: releaseOrCreateDate only used in DataFiles
GPortas 30dd260
Changed: minor comment tweak
GPortas 56cbdad
Changed: updated search.rst guides
GPortas 7832088
Fixed: search.rst json structure
GPortas bc673f0
Added: release notes for #10810
GPortas 8e384f0
Added: IT test cases
GPortas 21914c2
Changed: dataverse image_url Solr property set on SearchServiceBean
GPortas 7527073
Changed: do not modify existing JSF logic
GPortas 29056fb
Added: setting imageUrl in SearchServiceBean for datasets and files
GPortas 1c8543e
Merge branch 'develop' of github.com:IQSS/dataverse into 10810-search…
GPortas 906ff23
Update doc/release-notes/10810-search-api-payload-extensions.md
GPortas f05cb3a
Added: note about upcoming change to image_url field in docs
GPortas e517183
Merge branch '10810-search-api-payload-extensions' of github.com:IQSS…
GPortas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
Search API (/api/search) response will now include new fields for the different entities. | ||
|
||
For Dataverse: | ||
|
||
- "affiliation" | ||
- "parentDataverseName" | ||
- "parentDataverseIdentifier" | ||
- "image_url" (optional) | ||
|
||
```javascript | ||
"items": [ | ||
{ | ||
"name": "Darwin's Finches", | ||
... | ||
"affiliation": "Dataverse.org", | ||
"parentDataverseName": "Root", | ||
"parentDataverseIdentifier": "root", | ||
"image_url":"data:image/png;base64,iVBORw0..." | ||
(etc, etc) | ||
``` | ||
|
||
For DataFile: | ||
|
||
- "releaseOrCreateDate" | ||
- "image_url" (optional) | ||
|
||
```javascript | ||
"items": [ | ||
{ | ||
"name": "test.txt", | ||
... | ||
"releaseOrCreateDate": "2016-05-10T12:53:39Z", | ||
"image_url":"data:image/png;base64,iVBORw0..." | ||
(etc, etc) | ||
``` | ||
|
||
For Dataset: | ||
|
||
- "image_url" (optional) | ||
|
||
```javascript | ||
"items": [ | ||
{ | ||
... | ||
"image_url": "http://localhost:8080/api/datasets/2/logo" | ||
... | ||
(etc, etc) | ||
``` | ||
|
||
The image_url field was already part of the SolrSearchResult JSON (and incorrectly appeared in Search API documentation), but it wasn’t returned by the API because it was appended only after the Solr query was executed in the SearchIncludeFragment of JSF. Now, the field is set in SearchServiceBean, ensuring it is always returned by the API when an image is available. | ||
|
||
The schema.xml file for Solr has been updated to include a new field called dvParentAlias for supporting the new response field "parentDataverseIdentifier". So for the next Dataverse released version, a Solr reindex will be necessary to apply the new schema.xml version. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,25 +61,37 @@ https://demo.dataverse.org/api/search?q=trees | |
"name":"Trees", | ||
"type":"dataverse", | ||
"url":"https://demo.dataverse.org/dataverse/trees", | ||
"image_url":"https://demo.dataverse.org/api/access/dvCardImage/7", | ||
"image_url":"data:image/png;base64,iVBORw0...", | ||
"identifier":"trees", | ||
"description":"A tree dataverse with some birds", | ||
"published_at":"2016-05-10T12:53:38Z" | ||
"published_at":"2016-05-10T12:53:38Z", | ||
"publicationStatuses": [ | ||
"Published" | ||
], | ||
"affiliation": "Dataverse.org", | ||
"parentDataverseName": "Root", | ||
"parentDataverseIdentifier": "root" | ||
}, | ||
{ | ||
"name":"Chestnut Trees", | ||
"type":"dataverse", | ||
"url":"https://demo.dataverse.org/dataverse/chestnuttrees", | ||
"image_url":"https://demo.dataverse.org/api/access/dvCardImage/9", | ||
"image_url":"data:image/png;base64,iVBORw0...", | ||
"identifier":"chestnuttrees", | ||
"description":"A dataverse with chestnut trees and an oriole", | ||
"published_at":"2016-05-10T12:52:38Z" | ||
"published_at":"2016-05-10T12:52:38Z", | ||
"publicationStatuses": [ | ||
"Published" | ||
], | ||
"affiliation": "Dataverse.org", | ||
"parentDataverseName": "Root", | ||
"parentDataverseIdentifier": "root" | ||
}, | ||
{ | ||
"name":"trees.png", | ||
"type":"file", | ||
"url":"https://demo.dataverse.org/api/access/datafile/12", | ||
"image_url":"https://demo.dataverse.org/api/access/fileCardImage/12", | ||
"image_url":"data:image/png;base64,iVBORw0...", | ||
"file_id":"12", | ||
"description":"", | ||
"published_at":"2016-05-10T12:53:39Z", | ||
|
@@ -91,16 +103,26 @@ https://demo.dataverse.org/api/search?q=trees | |
"dataset_name": "Dataset One", | ||
"dataset_id": "32", | ||
"dataset_persistent_id": "doi:10.5072/FK2/XTT5BV", | ||
"dataset_citation":"Spruce, Sabrina, 2016, \"Spruce Goose\", http://dx.doi.org/10.5072/FK2/XTT5BV, Root Dataverse, V1" | ||
"dataset_citation":"Spruce, Sabrina, 2016, \"Spruce Goose\", http://dx.doi.org/10.5072/FK2/XTT5BV, Root Dataverse, V1", | ||
"publicationStatuses": [ | ||
"Published" | ||
], | ||
"releaseOrCreateDate": "2016-05-10T12:53:39Z" | ||
}, | ||
{ | ||
"name":"Birds", | ||
"type":"dataverse", | ||
"url":"https://demo.dataverse.org/dataverse/birds", | ||
"image_url":"https://demo.dataverse.org/api/access/dvCardImage/2", | ||
"image_url":"data:image/png;base64,iVBORw0...", | ||
"identifier":"birds", | ||
"description":"A bird Dataverse collection with some trees", | ||
"published_at":"2016-05-10T12:57:27Z" | ||
"published_at":"2016-05-10T12:57:27Z", | ||
"publicationStatuses": [ | ||
"Published" | ||
], | ||
"affiliation": "Dataverse.org", | ||
"parentDataverseName": "Root", | ||
"parentDataverseIdentifier": "root" | ||
}, | ||
{ | ||
"name":"Darwin's Finches", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Datasets can have There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes. parentDataverseIdentifier is only for Dataverses. |
||
|
@@ -151,6 +173,8 @@ https://demo.dataverse.org/api/search?q=trees | |
} | ||
} | ||
|
||
Note that the image_url field, if exists, will be returned as a regular URL for Datasets, while for Files and Dataverses, it will be returned as a Base64 URL. We plan to standardize this behavior so that the field always returns a regular URL. (See: https://github.com/IQSS/dataverse/issues/10831) | ||
|
||
.. _advancedsearch-example: | ||
|
||
Advanced Search Examples | ||
|
@@ -178,7 +202,7 @@ In this example, ``show_relevance=true`` matches per field are shown. Available | |
"name":"Finches", | ||
"type":"dataverse", | ||
"url":"https://demo.dataverse.org/dataverse/finches", | ||
"image_url":"https://demo.dataverse.org/api/access/dvCardImage/3", | ||
"image_url":"data:image/png;base64,iVBORw0...", | ||
"identifier":"finches", | ||
"description":"A Dataverse collection with finches", | ||
"published_at":"2016-05-10T12:57:38Z", | ||
|
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
Files do not get
parentDataverseIdentifier
, right?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.
Right! Just for Dataverses