package validation
Ordering
- Alphabetic
Visibility
- Public
- Protected
Type Members
- case class IncompatibleAllowEmptyValue(clientValue: Option[Boolean], serverValue: Option[Boolean]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleAllowReserved(clientValue: Option[Boolean], serverValue: Option[Boolean]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleContent(subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleContentType(clientValue: Option[String], serverValue: Option[String]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleEncoding(encodingName: String, subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleExplode(clientValue: Option[Boolean], serverValue: Option[Boolean]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleHeader(headerName: String, subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleMediaType(mediaType: String, subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleOperation(httpMethod: String, subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleParameter(name: String, subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatiblePath(pathName: String, subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleRequestBody(subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleRequiredValue(clientValue: Option[Boolean], serverValue: Option[Boolean]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleResponse(subIssues: List[OpenAPICompatibilityIssue]) extends OpenAPICompatibilitySubIssues with Product with Serializable
- case class IncompatibleSchema(schemaIssues: List[SchemaCompatibilityIssue]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleSecurityRequirement(securityRequirement: SecurityRequirement) extends OpenAPICompatibilityIssue with Product with Serializable
- case class IncompatibleStyle(clientValue: Option[ParameterStyle], serverValue: Option[ParameterStyle]) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingEncoding(encodingName: String) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingHeader(headerName: String) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingMediaType(mediaType: String) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingOperation(httpMethod: String) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingParameter(name: String) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingPath(pathName: String) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingRequestBody() extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingResponse(responsesKey: ResponsesKey) extends OpenAPICompatibilityIssue with Product with Serializable
- case class MissingSchema() extends OpenAPICompatibilityIssue with Product with Serializable
- class OpenAPIComparator extends AnyRef
A utility for comparing two OpenAPI specifications to validate their compatibility.
A utility for comparing two OpenAPI specifications to validate their compatibility.
The
OpenAPIComparatorclass compares the client's OpenAPI specification with the server's specification to detect and highlight compatibility issues. It evaluates various components including paths, operations, parameters, request bodies, responses, headers, schemas, content, and media types.Note: This comparator does not compare meta-data, such as the info object, server lists, or descriptions in properties.
- sealed abstract class OpenAPICompatibilityIssue extends AnyRef
- sealed abstract class OpenAPICompatibilitySubIssues extends OpenAPICompatibilityIssue
Value Members
- object OpenAPIComparator