Skip to content

Commit ab470cc

Browse files
struffelstruffel
authored
Merge pull request #33 from AssetFetch/update-dimensions-datablock
Update dimensions datablock
2 parents 6b83eb1 + 671a1b5 commit ab470cc

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

‎spec.md‎

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -872,16 +872,16 @@ This datablock has the following structure:
872872

873873
#### 7.1.1.1. `header` structure
874874

875-
| Field | Format | Requirement | Description |
876-
| -------------- | ------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
877-
| `name` | string | MUST | Name of the header |
878-
| `default` | string | MAY | Default value as a suggestion to the client. |
879-
| `is_required` | boolean | MUST | Indicates if this header is required. |
875+
| Field | Format | Requirement | Description |
876+
| -------------- | ------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
877+
| `name` | string | MUST | Name of the header |
878+
| `default` | string | MAY | Default value as a suggestion to the client. |
879+
| `is_required` | boolean | MUST | Indicates if this header is required. |
880880
| `is_sensitive` | boolean | MUST | Indicates if this header is sensitive and instructs the client to take appropriate measures to protect it. See [Storing Sensitive Headers](#91-storing-sensitive-headers) |
881-
| `prefix` | string | MAY | Prefix that the client should prepend to the value entered by the user when sending it to the provider. The prefix MUST match the regular expression `[a-zA-Z0-9-_\. ]*`. |
882-
| `suffix` | string | MAY | Suffix that the client should append to the value entered by the user when sending it to the provider.The suffix MUST match the regular expression `[a-zA-Z0-9-_\. ]*`. |
883-
| `title` | string | MAY | Title that the client SHOULD display to the user. |
884-
| `encoding` | string | MAY, default=`plain` | The encoding that the client MUST apply to the header value and the prefix/suffix. MUST be one of `plain` or `base64`. |
881+
| `prefix` | string | MAY | Prefix that the client should prepend to the value entered by the user when sending it to the provider. The prefix MUST match the regular expression `[a-zA-Z0-9-_\. ]*`. |
882+
| `suffix` | string | MAY | Suffix that the client should append to the value entered by the user when sending it to the provider.The suffix MUST match the regular expression `[a-zA-Z0-9-_\. ]*`. |
883+
| `title` | string | MAY | Title that the client SHOULD display to the user. |
884+
| `encoding` | string | MAY, default=`plain` | The encoding that the client MUST apply to the header value and the prefix/suffix. MUST be one of `plain` or `base64`. |
885885

886886
### 7.1.2. `provider_reconfiguration`
887887

@@ -990,26 +990,18 @@ Array of objects that MUST have this structure:
990990
| `uri` | string | MAY | A URI for this author, for example a profile link. |
991991
| `role` | string | MAY | The role that the author has had in the creation of this asset. |
992992

993-
### 7.3.6. `dimensions.3d`
994-
Contains general information about the physical dimensions of a three-dimensional asset. Primarily intended as metadata to be displayed to users, but MAY also be used by the client to scale mesh data.
993+
### 7.3.6. `dimensions`
994+
Contains general information about the physical dimensions of a three-dimensional asset. This is primarily intended for displaying to users, not for actually scaling meshes or textures.
995995

996-
An object that MUST conform to this format:
997-
998-
| Field | Format | Requirement | Description |
999-
| ---------- | ------ | ----------- | ------------------------------ |
1000-
| `width_m` | float | MUST | Width of the referenced asset |
1001-
| `height_m` | float | MUST | Height of the referenced asset |
1002-
| `depth_m` | float | MUST | Depth of the referenced asset |
1003-
1004-
### 7.3.7. `dimensions.2d`
1005-
Contains general information about the physical dimensions of a two-dimensional asset. Primarily intended as metadata to be displayed to users, but MAY also be used by the client to scale mesh-,texture-, or uv data.
996+
When using this datablock to describe two-dimensional assets, such as textures, providers MUST use the `width_m` and `height_m` fields and only add `depth_m` when dealing with three-dimensional data.
1006997

1007998
An object that MUST conform to this format:
1008999

10091000
| Field | Format | Requirement | Description |
10101001
| ---------- | ------ | ----------- | ------------------------------ |
1011-
| `width_m` | float | MUST | Width of the referenced asset |
1012-
| `height_m` | float | MUST | Height of the referenced asset |
1002+
| `width_m` | float | MAY | Width of the referenced asset |
1003+
| `height_m` | float | MAY | Height of the referenced asset |
1004+
| `depth_m` | float | MAY | Depth of the referenced asset |
10131005

10141006
### 7.3.8. `preview_image_supplemental`
10151007
Contains a list of preview images with `uri`s and `alt`-Strings associated to the asset.

0 commit comments

Comments
 (0)