-
Notifications
You must be signed in to change notification settings - Fork 495
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
standardize image url #10855
Merged
+129
−11
Merged
standardize image url #10855
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
695709c
standardize image url
stevenwinship c80a3df
doc changes
stevenwinship b923814
doc changes
stevenwinship 18c9211
doc changes
stevenwinship 47a2233
doc changes
stevenwinship 48f9f72
dont return image_url if there is none
stevenwinship d215221
adding fix from review comment
stevenwinship 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
28 changes: 28 additions & 0 deletions
28
doc/release-notes/10831-standardize-image-url-of-search-api.md
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,28 @@ | ||
Search API (/api/search) response will now include new image_url format for the Datafile and Dataverse logo. | ||
Note to release note writer: this supersedes the release note 10810-search-api-payload-extensions.md | ||
|
||
For Dataverse: | ||
|
||
- "image_url" (optional) | ||
|
||
```javascript | ||
"items": [ | ||
{ | ||
"name": "Darwin's Finches", | ||
... | ||
"image_url":"/api/access/dvCardImage/{identifier}" | ||
(etc, etc) | ||
``` | ||
For DataFile: | ||
- "image_url" (optional) | ||
```javascript | ||
"items": [ | ||
{ | ||
"name": "test.txt", | ||
... | ||
"image_url":"/api/access/datafile/{identifier}?imageThumb=true" | ||
(etc, etc) | ||
``` |
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
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.
If the image_url is always returned, even though the URL returns a 404 for files and a 204 for collections, then it is not an optional field. Anyway, check my final review comment, where I suggest not adding the fields to the payload in these cases.
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.
@GPortas what if when no image is available the endpoint just returns
image_url: null
?In that way we will know that
image_url
could be either astring
(image exists) ornull
.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.
removed image_url if none exists