swaggerblocks

Value Members

1. object Body extends ParameterIn with Product with Serializable

   

2. object DELETE extends Method with Product with Serializable

   

3. object FormData extends ParameterIn with Product with Serializable

   

4. object GET extends Method with Product with Serializable

   

5. object Header extends ParameterIn with Product with Serializable

   

6. object Implicits

   

7. object PATCH extends Method with Product with Serializable

   

8. object POST extends Method with Product with Serializable

   

9. object PUT extends Method with Product with Serializable

   

10. object Path extends ParameterIn with Product with Serializable

    

11. object Query extends ParameterIn with Product with Serializable

    

12. def bodyParameter(name: String, required: Boolean, schema: ApiSchemaRef, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter

    

13. def contact(name: Option[String] = None, url: Option[String] = None, email: Option[String] = None): Option[ApiContact]

    

14. def externalDocs(url: String, description: Option[String] = None): Option[ApiExternalDocs]

    

15. def formDataParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String] = None, allowEmptyValue: Boolean = false, enum: List[String] = List.empty): ApiParameter

    

16. def headerParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter

    

17. def info(version: String, title: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[ApiContact] = None, license: Option[ApiLicense] = None): ApiInfo

    

18. def license(name: String, url: Option[String] = None): Option[ApiLicense]

    

19. def manyOf(propertyType: PropertyType): ApiSchemaRef

    

20. def manyOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef

    

21. def oneOf(propertyType: PropertyType): ApiSchemaRef

    

22. def oneOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef

    

23. 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

    

24. def operations(ops: ApiOperationDefinition*): List[ApiOperationDefinition]

    

25. object parameter

    

26. def parameters(ps: ApiParameter*): List[ApiParameter]

    

27. def pathParameter(name: String, schema: ApiParameterSchema, description: Option[String] = None, enum: List[String] = List.empty): ApiParameter

    

28. def property(name: String)(schema: ApiSchemaRef, required: Boolean = true, description: Option[String] = None, enum: List[String] = List.empty): ApiPropertyDefinition

    

29. def queryParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String] = None, allowEmptyValue: Boolean = false, enum: List[String] = List.empty): ApiParameter

    

30. def response(statusCode: Int)(description: String, schema: Option[ApiSchemaRef] = None): ApiResponseDefinition

    

31. def responses(rs: ApiResponse*): List[ApiResponse]

    

32. def swaggerPath(path: String)(operations: List[ApiOperationDefinition] = List.empty): ApiPathDefinition

    

33. def swaggerRoot(swagger: String = "2.0")(host: Option[String] = None, basePath: Option[String] = None, info: ApiInfo, externalDocs: Option[ApiExternalDocs] = None): ApiRoot

    

34. def swaggerSchema(name: String)(properties: ApiPropertyDefinition*): ApiSchemaDefinition

    

35. object t