OpenAPIDocumentConfig extension type

Configurable document root fields excluding generated paths.

on

Constructors

OpenAPIDocumentConfig({required OpenAPIInfo info, OpenAPIComponents? components, List<OpenAPIServer>? servers, Map<String, OpenAPIPathItem>? webhooks, List<OpenAPITag>? tags, List<OpenAPISecurityRequirement>? security, OpenAPIExternalDocs? externalDocs, String? jsonSchemaDialect, Map<String, Object?>? extensions})
Creates an OpenAPI document config seed.
factory
OpenAPIDocumentConfig.fromJson(Map<String, Object?> json)
Wraps decoded JSON.
factory

Properties

components → OpenAPIComponents?
Optional document components.
no setter
externalDocs → OpenAPIExternalDocs?
Optional external docs.
no setter
info → OpenAPIInfo
OpenAPI info object.
no setter
jsonSchemaDialect → String?
Optional schema dialect.
no setter
security → List<OpenAPISecurityRequirement>?
Optional document-level security requirements.
no setter
servers → List<OpenAPIServer>?
Optional servers list.
no setter
tags → List<OpenAPITag>?
Optional tags list.
no setter
webhooks → Map<String, OpenAPIPathItem>?
Optional webhook declarations.
no setter