swaggerblocks

Value Members

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

   

2. def contact(name: Option[String], url: Option[String], email: Option[String]): Option[ApiContact]

   

3. def externalDocs(url: String, description: Option[String]): Option[ApiExternalDocs]

   

4. def formDataParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String], allowEmptyValue: Boolean, enum: List[String]): ApiParameter

   

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

   

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

   

7. def license(name: String, url: Option[String]): 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], summary: Option[String], tags: List[String], parameters: List[ApiParameter], responses: List[ApiResponseDefinition]): 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], enum: List[String]): ApiParameter

    

16. def property(name: String)(schema: ApiSchemaRef, required: Boolean, description: Option[String], enum: List[String]): ApiPropertyDefinition

    

17. def queryParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String], allowEmptyValue: Boolean, enum: List[String]): ApiParameter

    

18. package rendering

    

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

    

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

    

21. def swaggerPath(path: String)(operations: List[ApiOperationDefinition]): ApiPathDefinition

    

22. def swaggerRoot(swagger: String)(host: Option[String], basePath: Option[String], info: ApiInfo, externalDocs: Option[ApiExternalDocs]): ApiRoot

    

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