models

Type Members

1. case class ApiBodyParameter(name: String, required: Boolean, schema: ApiSchemaRef, description: Option[String], enum: List[String]) extends ApiParameter with Product with Serializable

   

2. case class ApiContact(name: Option[String], url: Option[String], email: Option[String]) extends Product with Serializable

   

3. case class ApiExternalDocs(url: String, description: Option[String]) extends Product with Serializable

   

4. case class ApiInfo(version: String, title: String, description: Option[String], termsOfService: Option[String], contact: Option[ApiContact], license: Option[ApiLicense]) extends Product with Serializable

   

5. case class ApiLicense(name: String, url: Option[String]) extends Product with Serializable

   

6. case class ApiObjectSchema(properties: List[ApiPropertyDefinition], example: Option[String] = None) extends ApiSchema with Product with Serializable

   

7. case class ApiOperation(description: Option[String], summary: Option[String], tags: List[String], parameters: List[ApiParameter], responses: Map[String, ApiResponse]) extends Product with Serializable

   

8. case class ApiOperationDefinition(method: Method, operation: ApiOperation) extends Product with Serializable

   

9. case class ApiOtherParameter(name: String, in: ParameterIn, required: Boolean, schema: ApiParameterSchema, description: Option[String], default: PropertyValue, enum: List[String]) extends ApiParameter with Product with Serializable

   

10. sealed trait ApiParameter extends AnyRef

    

11. case class ApiParameterArraySchema(itemsSchema: ApiParameterSchema) extends ApiParameterSchema with Product with Serializable

    

12. sealed trait ApiParameterSchema extends AnyRef

    

13. case class ApiParameterValueSchema(typ: PropertyType) extends ApiParameterSchema with Product with Serializable

    

14. case class ApiPath(operations: Map[Method, ApiOperation]) extends Product with Serializable

    

15. case class ApiPathDefinition(path: String, metadata: ApiPath) extends Product with Serializable

    

16. case class ApiPropertyDefinition(name: String, prop: ApiSchemaRef, required: Boolean, description: Option[String]) extends Product with Serializable

    

17. case class ApiResponse(description: String, schema: Option[ApiSchemaRef], headers: List[ApiResponseHeader]) extends Product with Serializable

    

18. case class ApiResponseDefinition(status: String, response: ApiResponse) extends Product with Serializable

    

19. case class ApiResponseHeader(name: String, schema: ApiParameterSchema, description: Option[String], enum: List[String]) extends Product with Serializable

    

20. case class ApiRoot(swagger: String, host: Option[String], basePath: Option[String], info: ApiInfo, externalDocs: Option[ApiExternalDocs]) extends Product with Serializable

    

21. sealed trait ApiSchema extends AnyRef

    

22. case class ApiSchemaDefinition(name: String, schema: ApiSchema) extends Product with Serializable

    

23. sealed trait ApiSchemaRef extends AnyRef

    

24. case class ApiSpec(root: ApiRoot, paths: List[ApiPathDefinition], schemata: List[ApiSchemaDefinition]) extends Product with Serializable

    

25. case class ApiValueSchema(typ: PropertyType, description: Option[String] = None, enum: List[String] = List.empty) extends ApiSchema with Product with Serializable

    

26. case class InlineSchema(schema: ApiSchema) extends ApiSchemaRef with Product with Serializable

    

27. case class MultipleInlineSchema(schema: ApiSchema) extends ApiSchemaRef with Product with Serializable

    

28. case class MultipleRef(schema: ApiSchemaDefinition) extends ApiSchemaRef with Product with Serializable

    

29. case class SingleRef(schema: ApiSchemaDefinition) extends ApiSchemaRef with Product with Serializable