Skip to content

Context Part does not explain use of schemas, schemas are missing key documentation #1032

@kriswest

Description

@kriswest

The Context Part of the FDC3 Standard makes use of JSON Schema definitions as the 'source of truth' for context definitions (supported by docs and examples on the reference pages). However, this is not explained anywhere in the Standard's documentation.

FDC3's use of schemas should be improved by:

  • Adding detail to the Context overview on:
    • How JSON schemas are used
    • What to include in a schema
  • Copying documentation from markdown pages into JSON Schemas

Making these changes would enable future changes to generate the docs pages from the schema files (reducing maintenance / making future contributions easier)

Area of Issue

[x] Context Data

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions