Packages

p

swaggerblocks

package swaggerblocks

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. swaggerblocks
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait Method extends AnyRef
  2. sealed trait ParameterIn extends AnyRef
  3. trait RenderingPackage extends AnyRef

Value Members

  1. def bodyParameter(name: String, required: Boolean, schema: ApiSchemaRef, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter
  2. def contact(name: Option[String] = None, url: Option[String] = None, email: Option[String] = None): Option[ApiContact]
  3. def externalDocs(url: String, description: Option[String] = None): Option[ApiExternalDocs]
  4. 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
  5. 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
  6. def info(version: String, title: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[ApiContact] = None, license: Option[ApiLicense] = None): ApiInfo
  7. def license(name: String, url: Option[String] = None): Option[ApiLicense]
  8. def manyOf(propertyType: PropertyType): ApiSchemaRef
  9. def manyOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef
  10. def oneOf(propertyType: PropertyType): ApiSchemaRef
  11. def oneOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef
  12. 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
  13. def operations(ops: ApiOperationDefinition*): List[ApiOperationDefinition]
  14. def parameters(ps: ApiParameter*): List[ApiParameter]
  15. def pathParameter(name: String, schema: ApiParameterSchema, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter
  16. def property(name: String)(schema: ApiSchemaRef, required: Boolean = true, description: Option[String] = None, enum: List[String] = List.empty): ApiPropertyDefinition
  17. 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
  18. def response(statusCode: Int)(description: String, schema: Option[ApiSchemaRef] = None, headers: List[ApiResponseHeader] = List.empty): ApiResponseDefinition
  19. def responseHeader(name: String, schema: ApiParameterSchema, description: Option[String] = None, enum: List[String] = List.empty): ApiResponseHeader
  20. def responses(rs: ApiResponse*): List[ApiResponse]
  21. def swaggerPath(path: String)(operations: List[ApiOperationDefinition] = List.empty): ApiPathDefinition
  22. def swaggerRoot(swagger: String = "2.0")(host: Option[String] = None, basePath: Option[String] = None, info: ApiInfo, externalDocs: Option[ApiExternalDocs] = None): ApiRoot
  23. def swaggerSchema(name: String)(properties: ApiPropertyDefinition*): ApiSchemaDefinition
  24. object Body extends ParameterIn with Product with Serializable
  25. object DELETE extends Method with Product with Serializable
  26. object FormData extends ParameterIn with Product with Serializable
  27. object GET extends Method with Product with Serializable
  28. object Header extends ParameterIn with Product with Serializable
  29. object Implicits
  30. object PATCH extends Method with Product with Serializable
  31. object POST extends Method with Product with Serializable
  32. object PUT extends Method with Product with Serializable
  33. object Path extends ParameterIn with Product with Serializable
  34. object Query extends ParameterIn with Product with Serializable
  35. object parameter
  36. object t

Inherited from AnyRef

Inherited from Any

Ungrouped