package swagger
- Source
- package.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- swagger
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- final case class ApiKeyParam[Param <: CanHoldApiKey, name, x](in: In) extends Product with Serializable
- final case class AsMultiOpenApiParam[T](fields: NonEmptyList[OpenApiParamField]) extends AsOpenApiParam[T] with Product with Serializable
- sealed trait AsOpenApiParam[T] extends AnyRef
- trait AsOpenParamInstances[TC[x] >: AsSingleOpenApiParam[x]] extends AnyRef
- final case class AsSingleOpenApiParam[T](typ: SwaggerType, required: Boolean = true) extends AsOpenApiParam[T] with OpenApiParamInfo with Product with Serializable
- sealed trait CirceSwaggerTypeableInstances extends AnyRef
- trait DescribeTypeable[T] extends AnyRef
- final case class DescribedType(typ: SwaggerType, description: Option[SwaggerDescription] = scala.None, title: Option[String] = scala.None) extends Product with Serializable
- trait GenericSwaggerTypeable[T] extends SwaggerTypeable[T]
- trait LowLevelSwaggerTypeable extends AnyRef
- type MediaType = String
- final case class MethodDeclare[method](method: Method) extends Product with Serializable
-
trait
MkSwagger[T] extends SwaggerBuilder
- Annotations
- @implicitNotFound( ... )
- final case class OpeApiLicense(name: String, url: Option[String] = scala.None) extends Product with Serializable
- final case class OpenApi(openapi: String = "3.0.0", info: OpenApiInfo = ..., servers: Vector[OpenApiServer] = ..., components: OpenApiComponents = ..., paths: PathMap = ..., tags: Vector[OpenApiTag] = ..., externalDocs: Option[OpenApiExternalDocs] = scala.None) extends Product with Serializable
- final case class OpenApiComponents(schemas: TreeMap[String, DescribedType] = ..., securitySchemes: TreeMap[String, OpenApiSecurity] = ...) extends Product with Serializable
- final case class OpenApiContact(name: Option[String] = scala.None, url: Option[String] = scala.None, email: Option[String] = scala.None) extends Product with Serializable
- final case class OpenApiExternalDocs(description: Option[SwaggerDescription] = scala.None, url: String) extends Product with Serializable
- sealed trait OpenApiFormat[T <: SwaggerValue] extends AnyRef
- final case class OpenApiInfo(title: String = "", description: Option[SwaggerDescription] = scala.None, termsOfService: Option[String] = scala.None, contact: Option[OpenApiContact] = scala.None, license: Option[OpeApiLicense] = scala.None, version: String = "") extends Product with Serializable
- final case class OpenApiMediaType(schema: Option[SwaggerType] = scala.None, example: Option[Json] = scala.None) extends Product with Serializable
- final case class OpenApiOp(tags: Vector[String] = ..., summary: Option[String] = scala.None, description: Option[SwaggerDescription] = scala.None, externalDocs: Option[OpenApiExternalDocs] = scala.None, operationId: Option[String] = scala.None, servers: Option[Vector[OpenApiServer]] = scala.None, parameters: Vector[OpenApiParam] = ..., requestBody: Option[OpenApiRequestBody] = scala.None, responses: OpenApiResponses = ..., security: Vector[Map[String, Vector[String]]] = ...) extends Product with Serializable
- final case class OpenApiParam(name: String, in: In, description: Option[SwaggerDescription] = scala.None, required: Boolean = true, schema: Option[SwaggerType] = scala.None, deprecated: Boolean = false, allowEmptyValue: Boolean = false) extends Product with Serializable
- final case class OpenApiParamField(name: String, typ: SwaggerType, required: Boolean) extends OpenApiParamInfo with Product with Serializable
- trait OpenApiParamInfo extends AnyRef
- final case class OpenApiRequestBody(description: Option[String] = scala.None, content: Map[MediaType, OpenApiMediaType] = ..., required: Boolean = true) extends Product with Serializable
- final case class OpenApiResponse(description: Option[SwaggerDescription] = scala.None, content: Map[MediaType, OpenApiMediaType], headers: Map[String, SwaggerValue] = ...) extends Product with Serializable
- final case class OpenApiResponses(default: Option[OpenApiResponse] = scala.None, codes: Map[StatusCode, OpenApiResponse] = ...) extends Product with Serializable
- final case class OpenApiSchema() extends Product with Serializable
- final case class OpenApiSecurity(type: OpenApiSecurityType, scheme: Option[OpenApiSecurityScheme] = scala.None, name: Option[String] = scala.None, in: Option[In] = scala.None, description: Option[SwaggerDescription] = scala.None) extends Product with Serializable
- sealed trait OpenApiSecurityScheme extends EnumEntry
- sealed trait OpenApiSecurityType extends EnumEntry
- final case class OpenApiServer(url: String, description: Option[String] = scala.None, variables: Map[String, OpenApiServerVariable] = ...) extends Product with Serializable
- final case class OpenApiServerVariable(enum: Vector[String], default: String, description: Option[String]) extends Product with Serializable
- final case class OpenApiTag(name: String, description: Option[SwaggerDescription] = scala.None, externalDocs: Option[OpenApiExternalDocs] = scala.None) extends Product with Serializable
- type StatusCode = Int
- final case class SwaggerArray(items: Eval[SwaggerType], minLength: Option[Int] = None, maxLength: Option[Int] = None) extends SwaggerType with Product with Serializable
- final case class SwaggerArrayValue(items: SwaggerValue, default: Option[Vector[Json]] = scala.None, collFormat: Option[CollectionFormat] = scala.None, minItems: Option[Int] = scala.None, maxItems: Option[Int] = scala.None) extends SwaggerValue with Product with Serializable
- final case class SwaggerBooleanValue(default: Option[Boolean] = scala.None) extends SwaggerValue with Product with Serializable
- trait SwaggerBuilder extends AnyRef
-
final
case class
SwaggerContent[T](types: List[SwaggerType]) extends Product with Serializable
- Annotations
- @implicitNotFound( ... )
- type SwaggerDescription = String
- final case class SwaggerEnumeration(alts: Vector[String]) extends SwaggerType with Product with Serializable
- final case class SwaggerIntValue(format: Option[OpenApiFormat[SwaggerIntValue]] = scala.None, default: Option[Int] = scala.None, maximum: Option[Int] = scala.None, exclusiveMaximum: Option[Boolean] = scala.None, minimum: Option[Int] = scala.None, exclusiveMinimum: Option[Boolean] = scala.None) extends SwaggerValue with Product with Serializable
- final case class SwaggerMap(value: Eval[SwaggerType]) extends SwaggerType with Product with Serializable
- class SwaggerMapKey[T] extends AnyRef
-
trait
SwaggerMapper[T] extends FunctionK[MkSwagger, MkSwagger]
- Annotations
- @implicitNotFound( ... )
- trait SwaggerMapperInstances1 extends AnyRef
- final case class SwaggerMedia(typ: SwaggerType, mediaType: MediaType) extends SwaggerType with Product with Serializable
- final case class SwaggerNumberValue(format: Option[OpenApiFormat[SwaggerNumberValue]] = scala.None, default: Option[BigDecimal] = scala.None, maximum: Option[BigDecimal] = scala.None, exclusiveMaximum: Boolean = false, minimum: Option[BigDecimal] = scala.None, exclusiveMinimum: Boolean = false) extends SwaggerValue with Product with Serializable
- final case class SwaggerObject(properties: Vector[SwaggerProperty] = ..., required: Eval[Vector[String]] = ...) extends SwaggerType with Product with Serializable
- final case class SwaggerOneOf(alts: Vector[(Option[String], Eval[SwaggerType])], discriminator: Option[String] = None) extends SwaggerType with Product with Serializable
- implicit class SwaggerOps[x] extends AnyRef
- class SwaggerPrimitive[Typ <: SwaggerValue] extends SwaggerType
- final case class SwaggerProperty(name: String, description: Option[String], typ: Eval[SwaggerType]) extends Product with Serializable
- final case class SwaggerRef(name: String, descr: Option[String], typ: Eval[SwaggerType]) extends SwaggerType with Product with Serializable
- final case class SwaggerStringValue(format: Option[OpenApiFormat[SwaggerStringValue]] = scala.None, default: Option[String] = scala.None, maxLength: Option[Int] = scala.None, minLength: Option[Int] = scala.None, pattern: Option[String] = scala.None, enum: Option[Vector[String]] = scala.None) extends SwaggerValue with Product with Serializable
- sealed trait SwaggerType extends AnyRef
- trait SwaggerTypeable[T] extends AnyRef
- trait SwaggerTypeableInstances extends LowLevelSwaggerTypeable with CirceSwaggerTypeableInstances
- sealed trait SwaggerValue extends AnyRef
- final case class SwaggerXML(typ: SwaggerType, options: SwaggerXMLOptions) extends SwaggerType with Product with Serializable
- case class SwaggerXMLOptions(name: Option[String] = None, attribute: @@[Boolean, Skippable] = false, prefix: Option[String] = None, namespace: Option[String] = None, wrapped: @@[Boolean, Skippable] = false) extends Product with Serializable
Value Members
- object ApiKeyParam extends Serializable
- object AsOpenApiParam extends AsOpenParamInstances[AsOpenApiParam]
- object AsSingleOpenApiParam extends AsOpenParamInstances[AsSingleOpenApiParam] with Serializable
- object DescribeTypeable
- object DescribedType extends Serializable
- object GenericSwaggerTypeable
- object MagnoliaSwagger
- object MethodDeclare extends Serializable
- object MkSwagger
- object OpeApiLicense extends Serializable
- object OpenApi extends Serializable
- object OpenApiComponents extends Serializable
- object OpenApiContact extends Serializable
- object OpenApiExternalDocs extends Serializable
- object OpenApiFormat
- object OpenApiInfo extends Serializable
- object OpenApiMediaType extends Serializable
- object OpenApiNumberValue
- object OpenApiOp extends Serializable
- object OpenApiParam extends Serializable
- object OpenApiRequestBody extends Serializable
- object OpenApiResponse extends Serializable
- object OpenApiResponses extends Serializable
- object OpenApiSchema extends Serializable
- object OpenApiSecurity extends Serializable
- object OpenApiSecurityScheme extends Enum[OpenApiSecurityScheme] with CirceEnum[OpenApiSecurityScheme]
- object OpenApiSecurityType extends Enum[OpenApiSecurityType] with CirceEnum[OpenApiSecurityType]
- object OpenApiServer extends Serializable
- object OpenApiServerVariable extends Serializable
- object OpenApiTag extends Serializable
- object PathDescription
- object SwaggerArrayValue extends Serializable
- object SwaggerBooleanValue extends Serializable
- object SwaggerBuilder
- object SwaggerContent extends Serializable
- object SwaggerFileValue extends SwaggerValue with Product with Serializable
- object SwaggerIntValue extends Serializable
- object SwaggerMapKey
- object SwaggerMapper extends SwaggerMapperInstances1 with Serializable
- object SwaggerMedia extends Serializable
- object SwaggerNumberValue extends Serializable
- object SwaggerObject extends Serializable
- object SwaggerPrimitive
- object SwaggerProperty extends Serializable
- object SwaggerRef extends Serializable
- object SwaggerStringValue extends Serializable
- object SwaggerType
- object SwaggerTypeable extends SwaggerTypeableInstances
- object SwaggerValue
- object SwaggerXML extends Serializable
- object SwaggerXMLOptions extends Serializable