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

RootDsl

interface RootDsl : InfoDsl, TagsDsl, PathsDsl

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:

Security schemes
Servers
Info (embedded)
Tags (embedded)
Paths (embedded)
External documentation (description and url)

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

Inheritors

RootBuilder

Functions

delete

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

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

get

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

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

head

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

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

invoke

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

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

options

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

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

patch

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

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

post

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

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

put

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

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

securityScheme

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.

server

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.

tag

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

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

Properties

contactEmail

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.

contactName

abstract var contactName: String?

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

contactUrl

abstract var contactUrl: String?

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

description

abstract var description: String?

A short summary of the API.

externalDocsDescription

abstract var externalDocsDescription: String?

Description for additional external documentation for this API.

externalDocsUrl

abstract var externalDocsUrl: String?

URL for additional external documentation for this API.

licenseIdentifier

abstract var licenseIdentifier: String?

An SPDX license identifier for the API.

licenseName

abstract var licenseName: String?

The license name used for the API.

licenseUrl

abstract var licenseUrl: String?

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

summary

abstract var summary: String?

A short summary of the API.

termsOfService

abstract var termsOfService: String?

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

title

abstract var title: String?

The title of the API.

version

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.