Documentation for Cumments v0.31.0.
Cumments

    OpenAPI 3.2 status

    Cumments' contract now targets OpenAPI 3.2.0. The three read operations that use HTTP QUERY are modeled with the native query Path Item field, not a vendor extension.

    Contract features

    FeatureStatusNotes
    Native HTTP QUERYUsedComment list, operator site list and operator quarantine list.
    JSON Schema nullable typesUsedOAS 3.0 nullable has been replaced by JSON Schema 2020-12 forms.
    $selfUsedDeclares the canonical contract URL.
    SSE itemSchemaUsedDescribes each parsed Server-Sent Events frame.
    JSON-valued SSE dataUsedModeled with contentMediaType: application/json and contentSchema.
    Tag hierarchyNot usedFlat tags remain stable until renderer support matures.
    additionalOperationsNot usedNo non-standard HTTP methods are exposed.
    in: querystringNot usedExplicit query parameters remain more discoverable and validatable.

    Tool compatibility

    Last reviewed: 2026-08-25.

    Tool / libraryVersion tested or reviewedResult
    Redocly CLI2.47.0Lint and bundle pass for the Cumments contract, including native query and SSE itemSchema.
    Redocly Redoc2.5.3 reviewedRenderer support for all OpenAPI 3.2 features is still maturing; upstream issues remain open. We publish the raw contract and do not depend on Redoc rendering every new keyword.
    Swagger UI5.32.14 reviewedUpstream has partial/basic OpenAPI 3.2 work; additional-operation support is still in progress. Treat interactive rendering as best-effort.
    Scalaractive release line reviewedActive development; verify a specific deployment before relying on interactive QUERY support.
    OpenAPI Generator7.25.0 reviewedNo complete OpenAPI 3.2 support guarantee is claimed by the migration. Revalidate a target generator before adopting client generation.

    CI pins the Redocly CLI version and runs structural assertions so accidental downgrade or reintroduction of private QUERY extensions fails before merge.