tegral-openapi-dsl/guru.zoroark.tegral.openapi.dsl/RootBuilder

RootBuilder

class RootBuilder( context: OpenApiDslContext, infoBuilder: InfoBuilder = InfoBuilder(), paths: PathsBuilder = PathsBuilder(context), securitySchemes: MutableMap<String, SecuritySchemeBuilder> = mutableMapOf()) : RootDsl, InfoDsl, PathsDsl, Builder<OpenAPI>

Builder for the RootDsl.

Constructors

RootBuilder

fun RootBuilder( context: OpenApiDslContext, infoBuilder: InfoBuilder = InfoBuilder(), paths: PathsBuilder = PathsBuilder(context), securitySchemes: MutableMap<String, SecuritySchemeBuilder> = mutableMapOf())

Functions

build

open override fun build(): OpenAPI

Build the object.

delete

open infix override fun String.delete(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "DELETE" operation on it.

get

open infix override fun String.get(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "GET" operation on it.

head

open infix override fun String.head(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "HEAD" operation on it.

invoke

open operator override fun String.invoke(path: PathDsl.() -> Unit)

Adds a path with the given string and registers any operations defined in the block.

options

open infix override fun String.options(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "OPTIONS" operation on it.

patch

open infix override fun String.patch(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "PATCH" operation on it.

post

open infix override fun String.post(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "POST" operation on it.

put

open infix override fun String.put(path: OperationDsl.() -> Unit)

Adds a path with the given string and creates a "PUT" operation on it.

securityScheme

open infix override fun String.securityScheme(scheme: SecuritySchemeDsl.() -> Unit)

Adds a security scheme to this OpenAPI document with the given string as the name, using the lambda to configure further options.

server

open infix override fun String.server(server: ServerDsl.() -> Unit)

Adds a server to this OpenAPI document with the given string as the URL, using the lambda to configure further options.

tag

open infix override fun String.tag(tagBuilder: TagDsl.() -> Unit)

Add a tag with the given string with a lambda to further configure the tag.

Properties

contactEmail

open override var contactEmail: String?

The email address of the contact person/organization for the exposed API. THis must be in the form of an email address.

contactName

open override var contactName: String?

The identifying name of the contact person/organization for the exposed API.

contactUrl

open override var contactUrl: String?

The URL pointing to the contact information for the exposed API. This must be in the form of a URL.

description

open override var description: String?

A short summary of the API.

externalDocsDescription

open override var externalDocsDescription: String? = null

Description for additional external documentation for this API.

externalDocsUrl

open override var externalDocsUrl: String? = null

URL for additional external documentation for this API.

licenseIdentifier

open override var licenseIdentifier: String?

An SPDX license identifier for the API.

licenseName

open override var licenseName: String?

The license name used for the API.

licenseUrl

open override var licenseUrl: String?

A URL to the license used for the API. This must be in the form of a URL.

summary

open override var summary: String?

A short summary of the API.

termsOfService

open override var termsOfService: String?

A URL to the Terms of Service for the API. This must be in the form of a URL.

title

open override var title: String?

The title of the API.

version

open override var version: String?

The version of the OpenAPI document. This is not the same as the version of the OpenAPI specification this document follows.