RootDsl

This is the root DSL object for the Tegral OpenAPI DSL.

As such, it contains many of the required properties for the OpenAPI object, including:

(Items marked as embedded are separate DSL interfaces that are available in RootDsl and can be used directly).

Inheritors

Functions

Link copied to clipboard
abstract infix fun String.delete(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract infix fun String.get(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract infix fun String.head(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract operator fun String.invoke(path: PathDsl.() -> Unit)

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

Link copied to clipboard
abstract infix fun String.options(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract infix fun String.patch(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract infix fun String.post(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract infix fun String.put(path: OperationDsl.() -> Unit)

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

Link copied to clipboard
abstract infix 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.

Link copied to clipboard
abstract infix 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.

Link copied to clipboard
abstract infix fun String.tag(tagBuilder: TagDsl.() -> Unit)

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

Properties

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract var contactName: String?

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

Link copied to clipboard
abstract var contactUrl: String?

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

Link copied to clipboard
abstract var description: String?

A short summary of the API.

Link copied to clipboard

Description for additional external documentation for this API.

Link copied to clipboard
abstract var externalDocsUrl: String?

URL for additional external documentation for this API.

Link copied to clipboard
abstract var licenseIdentifier: String?

An SPDX license identifier for the API.

Link copied to clipboard
abstract var licenseName: String?

The license name used for the API.

Link copied to clipboard
abstract var licenseUrl: String?

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

Link copied to clipboard
abstract var summary: String?

A short summary of the API.

Link copied to clipboard
abstract var termsOfService: String?

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

Link copied to clipboard
abstract var title: String?

The title of the API.

Link copied to clipboard
abstract var version: String?

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