swaggerblocks

Value Members

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

   

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

   

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

   

4. def license(name: Option[String], url: Option[String]): Option[ApiLicense]

   

5. def manyOf(propertyType: PropertyType): Option[MultipleInlineSchema]

   

6. def manyOf(schemaRef: ApiSchemaDefinition): Option[MultipleRef]

   

7. def oneOf(propertyType: PropertyType): Option[InlineSchema]

   

8. def oneOf(schemaRef: ApiSchemaDefinition): Option[SingleRef]

   

9. def operation(method: Method)(description: Option[String], summary: Option[String], tags: List[String], parameters: List[ApiParameter], responses: List[ApiResponseDefinition]): ApiOperationDefinition

   

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

    

11. def parameter(name: String, in: ParameterIn, required: Boolean, typ: PropertyType, description: Option[String], schema: Option[ApiSchemaRef]): ApiParameter

    

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

    

13. def property(name: String)(typ: PropertyType, required: Boolean, description: Option[String]): ApiPropertyDefinition

    

14. package rendering

    

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

    

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

    

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

    

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

    

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