Skip to content

New keywords datablock. #52

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.

Sign up for GitHub

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

Merged
struffel merged 2 commits into from
Mar 26, 2025
Merged

New keywords datablock. #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baff1f6
Add first version of keywords datablock
struffel Jan 23, 2025
5ddb7f4
Add json schema for keywords
struffel Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions json-schema/datablock/keywords.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Datablock: keywords",
"$id": "af.datablock.keywords",
"description": "Contains keywords or tags that the client MAY use for local asset organization.",
"type": "array",
"items": {
"type": "string"
}
}
3 changes: 3 additions & 0 deletions json-schema/endpoint/asset_list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@
},
"authors": {
"$ref": "../datablock/authors.json"
},
"keywords": {
"$ref": "../datablock/keywords.json"
}
},
"required": [
Expand Down
15 changes: 10 additions & 5 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ The AssetFetch Protocol aims to provide a standardized way for artists to browse
- [7.3.7. `preview_image_supplemental`](#737-preview_image_supplemental)
- [7.3.8. `preview_image_thumbnail`](#738-preview_image_thumbnail)
- [7.3.8.1. `uris` Structure](#7381-uris-structure)
- [7.3.9. `keywords`](#739-keywords)
- [7.4. Unlocking-related Datablocks](#74-unlocking-related-datablocks)
- [7.4.1. `unlock_balance`](#741-unlock_balance)
- [7.4.2. `unlock_queries`](#742-unlock_queries)
Expand Down Expand Up @@ -795,11 +796,11 @@ Clients MAY use the id as a display title, but SHOULD prefer the `title` field i

The following datablocks are to be included in the `data` field:

| Requirement | Datablocks |
| ----------- | --------------------------------------------------------------------------------- |
| MUST | `implementation_list_query` |
| SHOULD | `preview_image_thumbnail`, `text` |
| MAY | `preview_image_supplemental`, `license`, `authors`, `dimensions`,`web_references` |
| Requirement | Datablocks |
| ----------- | -------------------------------------------------------------------------------------------- |
| MUST | `implementation_list_query` |
| SHOULD | `preview_image_thumbnail`, `text` |
| MAY | `preview_image_supplemental`, `license`, `authors`, `dimensions`,`web_references`,`keywords` |


## 5.5. Endpoint: Implementation List (`implementation_list`)
Expand Down Expand Up @@ -1160,6 +1161,10 @@ If the image is not a square, its key SHOULD be set based on the pixel count of
The image's media type SHOULD be one of `image/png` or `image/jpeg`.
If the provider does not have insight into the dimensions of the thumbnail that it is referring the client to, it SHOULD use use the key `0` for the thumbnail url.

### 7.3.9. `keywords`
Contains keywords or tags that the client MAY use for local asset organization.

This datablock is **an array** consisting of type `string`.

## 7.4. Unlocking-related Datablocks

Expand Down
Loading