Issue 116 - allowing HAPI to serve images #166
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
initial take at new URI type for parameters
wording improvements; exploring a `uriInfo` keyword to house optional URI details.
still needs proofreading and tweaking; note that previous commit was a partial version
also rearranged some lines in the parameters attributes table to put all required items first; added vector elements to a mag field example
rweigel
reviewed
Mar 6, 2023
|
|
||
| The `stringType` attribute is a way to indicate that a string parameter is to be interpeted in a specific way. Currently, the only allowed special `stringType` is `uri`, and this allows a HAPI server to list pointers to other reources. | ||
|
|
||
| The value of the `stringType` attribute can either be the simple string `uri` or an object that is a dictionary with `uri` as the key and a value that is another object with two optional elements: `mediaType` and `scheme`. The media type (also referred to as MIME type) indicates what type of data each URI points to, and the `scheme` describes the access protocol. HAPI places no contraints on the values for `mediaType` or `scheme`, but servers should use standard values for these, such as `image/fits` or `image/png` or `application/x-cdf` for `mediaType` and `http` or `https` or `ftp` or `doi` or `s3` for `scheme`. |
There was a problem hiding this comment.
Is image/fits a standard? Or is it image/x-fits similar to x-cdf?
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 is ready for review.
We ended up only making a small change. No new type, just a new, optional
stringTypeattribute for astringparameter that allows the server to indicate that string values contains URIs.There is also warning language to tell people not just to make file listings available - the main intent of HAPI is still to make data content available.