Merge pull request #157 from rikoe/align-intent-app-metadata

Align intent and application definition between schemas

Author: nkolba

docs/api/DesktopAgent.md

@@ -254,10 +254,20 @@ The Interface used to describe an Intent within the platform.
 ```typescript
 interface AppMetadata {
   name: string;
+  title?: string;
+  tooltip?: string;
+  description?: string;
+  icons?: Array<string>;
+  images?: Array<string>;
 }
 ```
 
-App metadata is Desktop Agent specific - but should always support a name property.
+App metadata is provided by the FDC3 App Directory that the desktop agent connects to. 
+
+It always includes at least a `name` property, which can be used with [`open`](#open) and [`raiseIntent`](#raiseIntent).
+
+Optionally, extra information from the app directory can be returned, to aid in rendering UI elements, e.g. a context menu.
+This includes a title, description, tooltip and icon and image URLs.
 
 ### `IntentResolution`
 

src/api/interface.ts

@@ -28,7 +28,10 @@ enum ChannelError {
 * Intent descriptor
 */
 interface IntentMetadata {
+  /** The unique name of the intent that can be invoked by the raiseIntent call */
   name: string;
+
+  /** A friendly display name for the intent that should be used to render UI elements */
   displayName: string;
 }
 
@@ -42,10 +45,27 @@ interface AppIntent {
 
 
 /**
- * App metadata is Desktop Agent specific - but should support a name property.
+ * App definition as provided by the application directory
  */
 interface AppMetadata {
+
+  /** The unique app name that can be used with the open and raiseIntent calls. */
   name: string;
+
+  /** A more user-friendly application title that can be used to render UI elements  */
+  title?: string;
+
+  /**  A tooltip for the application that can be used to render UI elements */
+  tooltip?: string;
+
+  /** A longer, multi-paragraph description for the application that could include markup */
+  description?: string;
+
+  /** A list of icon URLs for the application that can be used to render UI elements */
+  icons?: Array<string>;
+
+  /** A list of image URLs for the application that can be used to render UI elements */
+  images?: Array<string>;
 }
 
 /**

src/intents/Intent.yaml

@@ -22,7 +22,7 @@ Intent:
         type: string
       description: The contexts the intent accepts. This will
         typically be a set of namespaced context types, e.g. 
-        "org.symphony.contact"
+        "fdc3.contact"
     customConfig:
         type: object
         description: Custom configuration for the intent