Skip to content

Commit 30fe9bd

Browse files
julianna-ciqkriswest
authored andcommitted
Add jsdocs to ContextMetadata.ts
1 parent 73816ba commit 30fe9bd

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

packages/fdc3-standard/src/api/ContextMetadata.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,17 @@ export interface ContextMetadata {
2020
}
2121

2222
export interface AppProvidableContextMetadata {
23-
signature?: string;
23+
/** A unique identifier for tracing the flow of context or intent messages across applications.
24+
* This is useful for debugging and monitoring message flow in complex interop scenarios.
25+
* If a traceId is provided by the app, the Desktop Agent SHOULD forward it.
26+
* If no traceId is provided by the app, the Desktop Agent SHOULD generate a new one.
27+
* */
2428
traceId?: string;
29+
30+
/** A cryptographic signature that can be used to verify the authenticity and integrity
31+
* of the context or intent message. This is useful for security-sensitive applications.
32+
* If a signature is provided by an app, it MAY be verified by the Desktop Agent. */
33+
signature?: string;
2534
}
2635

2736
export interface DesktopAgentProvidableContextMetadata {
@@ -33,7 +42,10 @@ export interface DesktopAgentProvidableContextMetadata {
3342
source?: AppIdentifier;
3443

3544
/** A unique identifier for tracing the flow of context or intent messages across applications.
36-
* This is useful for debugging and monitoring message flow in complex interop scenarios. */
45+
* This is useful for debugging and monitoring message flow in complex interop scenarios.
46+
* If a traceId is provided by the app, the Desktop Agent SHOULD forward it.
47+
* If no traceId is provided by the app, the Desktop Agent SHOULD generate a new one.
48+
* */
3749
traceId?: string;
3850

3951
/** A cryptographic signature that can be used to verify the authenticity and integrity

0 commit comments

Comments
 (0)