de.codecentric.hikaku.reporters.MatchResult.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hikaku-core Show documentation

A library that tests if the implementation of a REST-API meets its specification. This module contains the core elements which can be used to create additional converters and reporters.

There is a newer version: 3.3.0

Show newest version

package de.codecentric.hikaku.reporters

import de.codecentric.hikaku.SupportedFeatures
import de.codecentric.hikaku.endpoints.Endpoint

/**
 * Contains the complete result.
 * @param supportedFeatures Contains all features which have been used for the match.
 * @param specificationEndpoints All [Endpoint]s extracted from the specification.
 * @param implementationEndpoints All [Endpoint]s extracted from the implementation.
 * @param notFound A [Set] of [Endpoint]s which were expected due to their existence in the specification, but which couldn't be found.
 * @param notExpected A [Set] of [Endpoint]s which have been found in the implementation, but which were unexpected, because they don't exist in the specification.
 */
data class MatchResult(
        val supportedFeatures: SupportedFeatures,
        val specificationEndpoints: Set,
        val implementationEndpoints: Set,
        val notFound: Set,
        val notExpected: Set
)