Class OpenApiGenerator

java.lang.Object
zeroecho.apispec.OpenApiGenerator
public final class OpenApiGenerator extends Object
Build-time OpenAPI 3.1 specification generator for the ZeroEcho PKI administrative API.

This program projects the validated OperationDescriptorCatalog into an OpenAPI 3.1 YAML document, including unavailable operations with an explicit availability annotation.

Human-readable descriptions for each operation and field are taken from an openapi-supplement.yaml file. The generator validates that every operation present in the registry has a supplement entry and lists missing entries on standard error before exiting with code 1.

Usage: OpenApiGenerator <version> <supplement.yaml> <output.yaml>

Supplement YAML format

operations:
  ca.create:
    summary: "Creates a root CA authority"
    description: "..."
    arguments:
      formatId:
        description: "Encoding format identifier"
Since:
1.0

  • Constructor Details

    • OpenApiGenerator

      public OpenApiGenerator()
      Creates a build-time generator without loading the catalog or writing output.

  • Method Details

    • main

      public static void main(String[] args) throws IOException
      Program entry point.
      Parameters:
      args - [version, supplement-yaml-path, output-yaml-path]
      Throws:
      IOException - if supplement validation or output writing fails