p
swaggerblocks
package swaggerblocks
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- swaggerblocks
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- sealed trait Method extends AnyRef
- sealed trait ParameterIn extends AnyRef
- trait RenderingPackage extends AnyRef
Value Members
- def bodyParameter(name: String, required: Boolean, schema: ApiSchemaRef, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter
- def contact(name: Option[String] = None, url: Option[String] = None, email: Option[String] = None): Option[ApiContact]
- def externalDocs(url: String, description: Option[String] = None): Option[ApiExternalDocs]
- def formDataParameter[DefaultValue](name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String] = None, allowEmptyValue: Boolean = false, default: DefaultValue = PropertyValue.NullValue(), enum: List[String] = List.empty)(implicit arg0: SwaggerType[DefaultValue]): ApiParameter
- def headerParameter[DefaultValue](name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String] = None, default: DefaultValue = PropertyValue.NullValue(), enum: List[String] = List.empty)(implicit arg0: SwaggerType[DefaultValue]): ApiParameter
- def info(version: String, title: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[ApiContact] = None, license: Option[ApiLicense] = None): ApiInfo
- def license(name: String, url: Option[String] = None): Option[ApiLicense]
- def manyOf(propertyType: PropertyType): ApiSchemaRef
- def manyOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef
- def oneOf(propertyType: PropertyType): ApiSchemaRef
- def oneOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef
- def operation(method: Method)(description: Option[String] = None, summary: Option[String] = None, tags: List[String] = List.empty, parameters: List[ApiParameter] = List.empty, responses: List[ApiResponseDefinition] = List.empty): ApiOperationDefinition
- def operations(ops: ApiOperationDefinition*): List[ApiOperationDefinition]
- def parameters(ps: ApiParameter*): List[ApiParameter]
- def pathParameter(name: String, schema: ApiParameterSchema, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter
- def property(name: String)(schema: ApiSchemaRef, required: Boolean = true, description: Option[String] = None, enum: List[String] = List.empty): ApiPropertyDefinition
- def queryParameter[DefaultValue](name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String] = None, allowEmptyValue: Boolean = false, default: DefaultValue = PropertyValue.NullValue(), enum: List[String] = List.empty)(implicit arg0: SwaggerType[DefaultValue]): ApiParameter
- def response(statusCode: Int)(description: String, schema: Option[ApiSchemaRef] = None, headers: List[ApiResponseHeader] = List.empty): ApiResponseDefinition
- def responseHeader(name: String, schema: ApiParameterSchema, description: Option[String] = None, enum: List[String] = List.empty): ApiResponseHeader
- def responses(rs: ApiResponse*): List[ApiResponse]
- def swaggerPath(path: String)(operations: List[ApiOperationDefinition] = List.empty): ApiPathDefinition
- def swaggerRoot(swagger: String = "2.0")(host: Option[String] = None, basePath: Option[String] = None, info: ApiInfo, externalDocs: Option[ApiExternalDocs] = None): ApiRoot
- def swaggerSchema(name: String)(properties: ApiPropertyDefinition*): ApiSchemaDefinition
- object Body extends ParameterIn with Product with Serializable
- object DELETE extends Method with Product with Serializable
- object FormData extends ParameterIn with Product with Serializable
- object GET extends Method with Product with Serializable
- object Header extends ParameterIn with Product with Serializable
- object Implicits
- object PATCH extends Method with Product with Serializable
- object POST extends Method with Product with Serializable
- object PUT extends Method with Product with Serializable
- object Path extends ParameterIn with Product with Serializable
- object Query extends ParameterIn with Product with Serializable
- object parameter
- object t