Merge pull request #493 from ChartIQ/Add-icons-reference-to-metadata-…

…page Move icons property type definition into Types page in website
finos · Nov 12, 2021 · 37c66f1 · 37c66f1
2 parents 8cf99a9 + 398ed8e
commit 37c66f1
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 61 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Upgraded web access statements from SHOULD to MUST in the API specification ([#440](https://github.com/finos/FDC3/pull/440))
 * Updated copyright notices ([#467](https://github.com/finos/FDC3/pull/467))
 * Adjusted wording in API spec and documentation to acknowledge the possibility of methods of intent resolution other than a resolver UI ([#461](https://github.com/finos/FDC3/pull/461))
+* Moved the Icon type definition into the Types documentation page for consistency with other types. ([#493](https://github.com/finos/FDC3/pull/493)
 
 ### Deprecated
 ### Fixed

diff --git a/docs/api/ref/Icon.md b/docs/api/ref/Icon.md
diff --git a/docs/api/ref/Metadata.md b/docs/api/ref/Metadata.md
@@ -61,12 +61,7 @@ In situations where a desktop agent connects to multiple app directories or mult
 
 A desktop agent (typically for _system_ channels) may want to provide additional information about how a channel can be represented in a UI. A common use case is for color linking.
 
-#### See also
-
-* [`Channel`](Channel)
-* [`DesktopAgent.getSystemChannels`](DesktopAgent#getsystemchannels)
-
-### Properties
+#### Properties
 
 #### `name`
 
@@ -92,6 +87,11 @@ glyph: string;
 
 A URL of an image that can be used to display this channel.
 
+#### See also
+
+* [`Channel`](Channel)
+* [`DesktopAgent.getSystemChannels`](DesktopAgent#getsystemchannels)
+
 ## `ImplementationMetadata`
 
 ```typescript

diff --git a/docs/api/ref/Types.md b/docs/api/ref/Types.md
@@ -88,3 +88,52 @@ or pass full app metadata, giving the desktop agent more information about the t
 * [`DesktopAgent.raiseIntent`](DesktopAgent#raiseintent)
 * [`DesktopAgent.raiseIntentForContext`](DesktopAgent#raiseintentforcontext)
 * [`IntentResolution`](Metadata#intentresolution)
+
+
+## `Icon`
+
+```typescript
+interface Icon {
+  src: string;
+  size?: string;
+  type?: string;
+}
+```
+
+AppMetadata includes an icons property allowing multiple icon types to be specified. Various properties may be used by the Desktop Agent to decide which icon is the most suitable to be used considering the application chooser UI, device DPI and formats supported by the system.
+
+#### Example
+
+```js
+"icons": [
+  {
+    "src": "https://app.foo.icon/app_icons/lowres.webp",
+    "size": "48x48",
+    "type": "image/webp"
+  },
+  {
+    "src": "https://app.foo.icon/app_icons/hd_hi.svg",
+    "size": "72x72",
+    "type": "image/svg+xml"
+  }
+]
+```
+
+#### Properties
+
+#### `src`
+
+The fully qualified url to the icon.
+
+#### `size`
+
+The dimension of the icon using formatted as "<height>x<width>"
+
+#### `type`
+
+The media type of the icon. If not provided the Desktop agent may refer to the src file extension.
+
+
+
+#### See also
+* [`AppMetadata`](Metadata#appmetadata)