Skip to content

Commit 4bbba50

Browse files
committed
Align intent and application definition between schemas
Fixes #19 and #156
1 parent 0c13bf3 commit 4bbba50

File tree

3 files changed

+22
-40
lines changed

3 files changed

+22
-40
lines changed

src/api/interface.ts

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ enum ResolveError {
2222
* Intent descriptor
2323
*/
2424
interface IntentMetadata {
25+
/** The unique name of the intent that can be invoked by the raiseIntent call */
2526
name: string;
27+
28+
/** A friendly display name for the intent that should be used to render UI elements */
2629
displayName: string;
2730
}
2831

@@ -35,10 +38,27 @@ interface AppIntent {
3538
}
3639

3740
/**
38-
* App metadata is Desktop Agent specific - but should support a name property.
41+
* App definition as provided by the application directory
3942
*/
4043
interface AppMetadata {
44+
45+
/** The unique app name that can be used with the open and raiseIntent calls. */
4146
name: string;
47+
48+
/** A more user-friendly application title that can be used to render UI elements */
49+
title?: string;
50+
51+
/** A tooltip for the application that can be used to render UI elements */
52+
tooltip?: string;
53+
54+
/** A longer, multi-paragraph description for the application that could include markup */
55+
description?: string;
56+
57+
/** A list of icon URLs for the application that can be used to render UI elements */
58+
icons?: Array<string>;
59+
60+
/** A list of image URLs for the application that can be used to render UI elements */
61+
images?: Array<string>;
4262
}
4363

4464
/**

src/intents/Intent.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Intent:
2222
type: string
2323
description: The contexts the intent accepts. This will
2424
typically be a set of namespaced context types, e.g.
25-
"org.symphony.contact"
25+
"fdc3.contact"
2626
customConfig:
2727
type: object
2828
description: Custom configuration for the intent

src/intents/intent.ts

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)