Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. A YAML (or similar) format to define object structure, relations between objects and (fine-grained) documentation (#1)
  2. language-specific binding generation process - continuously invoked - that reads the format and generates language-specific bindings; this can be achieved in different ways:
    1. Using TypeScript as reference implementation; other language bindings will be added when requested. This approach probably doesn’t satisfy entirely requirement #3
    2. Translating YAML to JSON first, then use QuickType to generate language-specific bundles; the main objective of QuickType seems to fit well with FO requirements, but needs some further testing using real specifications and testing integration with FDC3 definitions
    3. Using language-specific libraries, for example jsonschema2pojo for Java Beans, MakeTypes for Typescript definitions and JsonCSharpClassGenerator for .NET classes
  3. A YAML to HTML generation to produce (HTML or MarkDown) generation to produce documentation content