p
swaggerblocks
package swaggerblocks
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- swaggerblocks
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Value Members
- def bodyParameter(name: String, required: Boolean, schema: ApiSchemaRef, description: Option[String], enum: List[String]): ApiParameter
- def contact(name: Option[String], url: Option[String], email: Option[String]): Option[ApiContact]
- def externalDocs(url: String, description: Option[String]): Option[ApiExternalDocs]
- def formDataParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String], allowEmptyValue: Boolean, enum: List[String]): ApiParameter
- def headerParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String], enum: List[String]): ApiParameter
- def info(version: String, title: String, description: Option[String], termsOfService: Option[String], contact: Option[ApiContact], license: Option[ApiLicense]): ApiInfo
- def license(name: String, url: Option[String]): Option[ApiLicense]
- def manyOf(propertyType: PropertyType): ApiSchemaRef
- def manyOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef
- def oneOf(propertyType: PropertyType): ApiSchemaRef
- def oneOf(schemaRef: ApiSchemaDefinition): ApiSchemaRef
- def operation(method: Method)(description: Option[String], summary: Option[String], tags: List[String], parameters: List[ApiParameter], responses: List[ApiResponseDefinition]): ApiOperationDefinition
- def operations(ops: ApiOperationDefinition*): List[ApiOperationDefinition]
- def parameters(ps: ApiParameter*): List[ApiParameter]
- def pathParameter(name: String, schema: ApiParameterSchema, description: Option[String], enum: List[String]): ApiParameter
- def property(name: String)(schema: ApiSchemaRef, required: Boolean, description: Option[String], enum: List[String]): ApiPropertyDefinition
- def queryParameter(name: String, required: Boolean, schema: ApiParameterSchema, description: Option[String], allowEmptyValue: Boolean, enum: List[String]): ApiParameter
- def response(statusCode: Int)(description: String, schema: Option[ApiSchemaRef], headers: List[ApiResponseHeader]): ApiResponseDefinition
- def responseHeader(name: String, schema: ApiParameterSchema, description: Option[String], enum: List[String]): ApiResponseHeader
- def responses(rs: ApiResponse*): List[ApiResponse]
- def swaggerPath(path: String)(operations: List[ApiOperationDefinition]): ApiPathDefinition
- def swaggerRoot(swagger: String)(host: Option[String], basePath: Option[String], info: ApiInfo, externalDocs: Option[ApiExternalDocs]): ApiRoot
- def swaggerSchema(name: String)(properties: ApiPropertyDefinition*): ApiSchemaDefinition