sttp.apispec.openapi.validation

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilitySubIssues

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: OpenAPIComparator.type

A utility for comparing two OpenAPI specifications to validate their compatibility.

The OpenAPIComparator class 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.

Value parameters

clientOpenAPI: the OpenAPI specification provided by the client.
serverOpenAPI: the OpenAPI specification provided by the server.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class IncompatibleAllowEmptyValue

class IncompatibleAllowReserved

class IncompatibleContentType

class IncompatibleEncoding

class IncompatibleExplode

class IncompatibleRequiredValue

class IncompatibleSchema

class IncompatibleSecurityRequirement

class IncompatibleStyle

class MissingEncoding

class MissingHeader

class MissingMediaType

class MissingOperation

class MissingParameter

class MissingPath

class MissingRequestBody

class MissingResponse

class MissingSchema

class OpenAPICompatibilitySubIssues

class IncompatibleContent

class IncompatibleHeader

class IncompatibleMediaType

class IncompatibleOperation

class IncompatibleParameter

class IncompatiblePath

class IncompatibleRequestBody

class IncompatibleResponse
Show all

Attributes

Supertypes: class OpenAPICompatibilityIssue

class Object

trait Matchable

class Any
Known subtypes: class IncompatibleContent

class IncompatibleHeader

class IncompatibleMediaType

class IncompatibleOperation

class IncompatibleParameter

class IncompatiblePath

class IncompatibleRequestBody

class IncompatibleResponse
Show all

sttp.apispec.openapi.validation

Members list

Type members

Classlikes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes