plus

operator fun OpenApiDoc.plus(routes: Sequence<Route>): OpenApiDoc(source)

Combines the current OpenApiDoc instance with a sequence of routes, resulting in a new OpenApiDoc containing the updated paths and components based on the provided routes.

Report a problem

Return

A new OpenApiDoc instance with the combined paths and components from the original instance and the provided routes.

Parameters

routes

A sequence of Routes whose information is used to resolve path items and schemas.


operator fun OpenApiDoc.plus(routes: Collection<Route>): OpenApiDoc(source)

Overload for OpenApiDoc.plus that accepts a Collection of Routes.

Report a problem

Return

A new OpenApiDoc instance with the combined paths and components from the original instance and the provided routes.

Parameters

routes

A collection of Routes whose information is used to resolve path items and schemas.


operator fun OpenApiDoc.plus(route: Route): OpenApiDoc(source)

Combines the current OpenApiDoc instance with a single Route.

Report a problem

Return

A new OpenApiDoc instance with the combined paths and components from the original instance and the provided route.

Parameters

route

An instance of Route that will be used to resolve path items and schemas.


operator fun OpenApiDoc.plus(securitySchemes: Map<String, ReferenceOr<SecurityScheme>>): OpenApiDoc(source)

Combines the current OpenApiDoc instance with additional security schemes.

This method updates the existing security schemes in the components section of the current instance by merging them with the provided securitySchemes. If there are no existing security schemes, the provided securitySchemes will be set as the new security schemes for the components.

Report a problem

Return

A new OpenApiDoc instance with the updated security schemes in the components section.

Parameters

securitySchemes

A map of additional security schemes to include, where the keys are the scheme names and the values are references or definitions of SecurityScheme objects.