openapi-merge
    Preparing search index...

    Type Alias OpenApiDocument

    OpenApiDocument: Omit<
        Swagger.SwaggerV3,
        "paths"
        | "components"
        | "tags"
        | "servers",
    > & {
        $self?: string;
        components?: Components31;
        jsonSchemaDialect?: string;
        paths?: PathItemMap;
        servers?: Server32[];
        tags?: Tag32[];
        webhooks?: PathItemMap;
    }

    An OpenAPI document this library can merge: 3.0 or 3.1.

    Differences from Swagger.SwaggerV3, all of them 3.1 additions:

    • paths is optional. 3.1 allows a document that describes only webhooks, which has no paths member at all. This is the change that cannot be expressed by extension alone, hence the Omit.
    • webhooks is a map of Path Items, structurally identical to paths.
    • jsonSchemaDialect names the default JSON Schema dialect for Schema Objects in the document.
    • components may carry pathItems.

    Type Declaration

    • Optional$self?: string

      3.2: the document's own identity URI. See the merge policy in oas32 tests.

    • Optionalcomponents?: Components31
    • OptionaljsonSchemaDialect?: string
    • Optionalpaths?: PathItemMap
    • Optionalservers?: Server32[]
    • Optionaltags?: Tag32[]
    • Optionalwebhooks?: PathItemMap

    Settings
    Member Visibility