Documentation
    Preparing search index...
    • Returns the OpenAPI document of the application in the requested version.

      The document is composed as OpenAPI 3.2 and converted to the configured older version; every analysis error is collected and thrown together.

      Parameters

      Returns Promise<IDocument | IDocument | IDocument | IDocument>

      contracts/common.md#principled-implementation Composition runs at the newest version and OpenApiConverter.downgradeDocument produces the older ones, so version differences live in one converter, and a failure of the analysis throws one error that lists every problem.

      contracts/common.md#clear-and-simple-design One function over the shared analyzers and the Swagger generator.

      contracts/common.md#prohibited-implementation-shortcuts No route is special-cased; the module graph is read through ConfigAnalyzer.application.

      contracts/common.md#meaningful-documentation The comment states the returned versions and the error behavior.

      contracts/portability.md#os-neutral-implementation The composer receives an existing application and writes no output file. Its delegated controller discovery obtains native source locations, and its report renders those locations through path.relative; initialize may read package metadata for default info.