Skip to content

Reference

Most of this section is generated from the JSON field metadata in src/main/java/json/schema/ and the ASN.1 blocks extracted from tcg.credential.* Javadoc. The generated pages are meant to answer the practical questions quickly: which JSON names are accepted, which aliases still work, which OIDs or tag values they map to, and which Java/ASN.1 type ultimately receives the data.

Specifications

Content generated from source code

These pages are generated based on annotations and notes within the code base.

  • CLI Commands — root command, subcommands, usage patterns, and option descriptions.
  • Signing Algorithms — supported --sig-profile values, signing families, and detached-signature encodings.
  • Output Snapshots — first-pass examples of envelope, validation, and view output to help readers orient quickly.
  • Field Sets — every documented JSON field set, path, alias, ASN.1 mapping, description, and Mermaid graph.
  • Vocabularies — enumerated value sets for specific fields.
  • Global ASN.1 Types — JSON acceptance rules for ASN.1-backed Java types.
  • JSON Schemas — generated Draft 2020-12 schemas for the main JSON helpers.
  • Javadocs — generated Java API documentation.

Adjacent reference

How to regenerate

./gradlew generateDocs

That task runs the ASN.1 extractor and schema generator in docs/doc-tools/, renders the reference Markdown fragments, stages the output under docs/reference/_generated/, and stages Javadocs under docs/reference/javadocs/ for MkDocs to include.