Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
data class ApiSpec(val title: String, val version: String, val endpoints: List<Endpoint>, val schemas: List<SchemaModel>, val enums: List<EnumModel>, val securitySchemes: List<SecurityScheme>)
Link copied to clipboard
Link copied to clipboard
data class Discriminator(val propertyName: String, val mapping: Map<String, String>)
Link copied to clipboard
data class Endpoint(val path: String, val method: HttpMethod, val operationId: String, val summary: String?, val description: String?, val tags: List<String>, val parameters: List<Parameter>, val requestBody: RequestBody?, val responses: Map<String, Response>)
Link copied to clipboard
Link copied to clipboard
data class EnumModel(val name: String, val description: String?, val type: EnumBackingType, val values: List<EnumModel.Value>)
Link copied to clipboard
Link copied to clipboard
data class Parameter(val name: String, val location: ParameterLocation, val required: Boolean, val schema: TypeRef, val description: String?)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class PropertyModel(val name: String, val type: TypeRef, val description: String?, val nullable: Boolean, val defaultValue: Any? = null)
Link copied to clipboard
data class RequestBody(val required: Boolean, val contentType: ContentType, val schema: TypeRef)
Link copied to clipboard
data class Response(val statusCode: String, val description: String?, val schema: TypeRef?, val contentType: ContentType? = null)
Link copied to clipboard
data class SchemaModel(val name: String, val description: String?, val properties: List<PropertyModel>, val requiredProperties: Set<String>, val allOf: List<TypeRef>?, val oneOf: List<TypeRef>?, val anyOf: List<TypeRef>?, val discriminator: Discriminator?, val oneOfWrapperMapping: Map<String, String>? = null, val underlyingType: TypeRef? = null)
Link copied to clipboard
sealed interface SecurityScheme

Intermediate model representing a fully parsed OpenAPI specification.

Link copied to clipboard
sealed interface TypeRef