search

FDC3 / API

Open standards for the financial desktop.
https://fdc3.finos.org
Apache License 2.0
9 stars 9 forks source link

Suggestion: Better docs around this API and the context/intent repos #8

Closed bschwinn closed 5 years ago

bschwinn commented 6 years ago

Perhaps just starting with a README approach, where we link the repo docs together. Followed with some Typescript defs for contexts and intents we can reference here.

rikoe commented 6 years ago

Let's make sure this is done.

Instead of type Context = Object;, there should be a shared TypeScript definition of a context object with the Context Data repo.

Where an intent object is returned as a result of a lookup, it should share a TypeScript definition with the Intents repo, ideally matching Intent.yaml.

Where an application, or application metadata, is referenced, it should link to the App Directory repo, and ideally match appd.yaml.

nkolba commented 5 years ago

Will be reflected in v1 documentation