-
Notifications
You must be signed in to change notification settings - Fork 11
Add variant
to file references.
#227
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
Open
niemela
wants to merge
4
commits into
master
Choose a base branch
from
variant-files
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -264,14 +264,15 @@ Properties for geographic location objects: | |
|
||
Properties for file reference objects: | ||
|
||
| Name | Type | Description | ||
| -------- | --------- | ----------- | ||
| href | string | URL where the resource can be found. Relative URLs are relative to the `baseurl`. Must point to a file of intended mime-type. Resource must be accessible using the exact same (possibly none) authentication as the call that returned this data. (Note: this is actually optional inside a [Contest Package](contest_package)). | ||
| filename | string | POSIX compliant filename. Filenames must be unique within the endpoint object where they are used. I.e. an organization can have (multiple) `logo` and `country_flag` file references, they must all have a different filename, but different organizations may have files with the same filename. | ||
| hash | string ? | MD5 hash of the file referenced. | ||
| mime | string | Mime type of resource. | ||
| width | integer ? | Width of the image. Required for files with mime type image/\*. | ||
| height | integer ? | Height of the image. Required for files with mime type image/\*. | ||
| Name | Type | Description | ||
| -------- | --------------- | ----------- | ||
| href | string | URL where the resource can be found. Relative URLs are relative to the `baseurl`. Must point to a file of intended mime-type. Resource must be accessible using the exact same (possibly none) authentication as the call that returned this data. (Note: this is actually optional inside a [Contest Package](contest_package)). | ||
| filename | string | POSIX compliant filename. Filenames must be unique within the endpoint object where they are used. I.e. an organization can have (multiple) `logo` and `country_flag` file references, they must all have a different filename, but different organizations may have files with the same filename. | ||
| hash | string ? | MD5 hash of the file referenced. | ||
| mime | string | Mime type of resource. | ||
| width | integer ? | Width of the image. Required for files with mime type image/\*. | ||
| height | integer ? | Height of the image. Required for files with mime type image/\*. | ||
| variant | array of string | Intended usage hints (e.g. `light`, `dark` for images). | ||
|
||
The `href` property may be an [absolute or relative | ||
URL](https://datatracker.ietf.org/doc/html/rfc3986); relative URLs must be | ||
|
@@ -292,6 +293,13 @@ the values of `width` and `height` should be the viewport width and height in pi | |
when possible, but otherwise the actual values don't matter as long as they | ||
are positive and represent the correct aspect ratio. | ||
|
||
Known values of variant include: | ||
|
||
- `light`: an image intended for use on white or light backgrounds. | ||
- `dark`: an image intended for use on black or dark backgrounds. | ||
|
||
An image may list both values if it is suitable for multiple contexts. | ||
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. nit: 'multiple contexts' -> 'both backgrounds' simpler? |
||
|
||
If implementing support for uploading files pointed to by resource | ||
links, substitute the href property with a data property with a base64 | ||
encoded string of the associated file contents as the value. | ||
|
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.
Maybe I'm the only one, but I don't think
variant
is a good name here as to me it suggests that the options are mutually exclusive. Also, given that this is a list of options, I'd go for a plural terms, so for lack of better, I'd saytags
.