docs: add FDC3 v3 web guidance for route-scoped identity, context-only apps, and private context types#1969
Conversation
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…y apps, and private context types
Removed code example and simplified explanation for multiple FDC3-enabled applications on the same origin.
Removed section on multiple FDC3 apps on a single origin, including examples and usage notes regarding identity validation.
Removed privacy considerations and guidelines for context objects in User Channels. Updated conventions for context types and identifiers.
Updated the documentation to clarify naming conventions and the structure of private context types. Added sections on 'name' and 'id' properties, and emphasized avoiding union types in schemas.
| The specification does not define or make mandatory any authorizations or roles that a provider or enterprise can define. | ||
|
|
||
| A key concept in the App Directory is how applications are identified and referenced across different environments. Application identifiers are used both to uniquely describe apps within a directory and, in some cases, to locate the directory instance that hosts an application’s record. | ||
| ### Context-only Apps |
There was a problem hiding this comment.
Instead of this whole section on context only apps, instead please provide a single paragraph description of the purpose of the interop section of the AppD record, along with a link to the specification of this.
There was a problem hiding this comment.
Done — replaced the entire "Context-only Apps" section with a single ### Application \interop` Metadata` paragraph that describes the field's purpose and links to the App Directory specification. Commit: the latest push.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1969 +/- ##
=======================================
Coverage 95.32% 95.32%
=======================================
Files 85 85
Lines 6690 6690
Branches 932 895 -37
=======================================
Hits 6377 6377
Misses 313 313 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kriswest
left a comment
There was a problem hiding this comment.
Needs one paragraph restoring, then this should be good to merge
|
|
||
| ::: | ||
|
|
||
| Finally, if there is still no Desktop Agent available, or an issue prevents connection to it, the `getAgent()` function will reject its promise with a message from the [`AgentError`](./Errors#agenterror) enumeration. |
There was a problem hiding this comment.
This should not be removed when making the addition...
kriswest
left a comment
There was a problem hiding this comment.
LGTM - can another @finos/fdc3-maintainers team member review and merge, as I have last push on this after committing a suggestion.
|
Not sure why test check is stuck... |
Addresses three documentation gaps surfaced by implementer feedback (TraderX + Sail v3) when hosting multiple FDC3 apps on a single origin.
Changes
Route-scoped web app identity (
supported-platforms.md,GetAgent.md)identityUrlmatching that record'sdetails.urlwhen callinggetAgent()(e.g. for SPAs that have already navigated beforegetAgent()is called)Application
interopmetadata (app-directory/overview.md)interopfield in AppD records — intent resolution, catalog discovery, and channel interaction documentation — with links to both the rendered App Directory specification and the raw OpenAPI schemaPrivate/proprietary context types (
context/spec.md)id-vs-custom-fields guidance, privacy considerations for User Channel broadcasts, alternatives for richer point-to-point data sharing, and AppD declaration notesRelated Issue
Resolves #1943
Contributor License Agreement
Review Checklist
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?JSDoc comments on interfaces and types should be matched to the main documentation in /docs
Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
npm run build) run and the results checked in?Generated code will be found at
/src/api/BrowserTypes.tsand/or/src/bridging/BridgingTypes.tsBaseContextschema applied viaallOf(as it is in existing types)?titleanddescriptionprovided for all properties defined in the schema?npm run build) run and the results checked in?Generated code will be found at
/src/context/ContextTypes.ts