org.springframework.cloud.contract.verifier.util

Interface SpringCloudContractMetadata

All Known Implementing Classes:

AmqpMetadata, ContractVerifierHttpMetaData, ContractVerifierMessageMetadata, ContractVerifierMetadata, KafkaMetadata, StandaloneMetadata

public interface SpringCloudContractMetadata

Interface for metadata objects parsed from the metadata in a contract. Will be used to scan for implementations of the interface in order to build a schema of how metadata can look like.

Since:

3.0.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
default List<Class>	additionalClassesToLookAt() Collection of additional classes to look at if one is interested.
String	description() Short description of the metadata.
String	key() Name of the key under which this metadata entry will be present in contract's metadata.

Method Detail

key

String key()

Name of the key under which this metadata entry will be present in contract's metadata.

Returns:

key name

description

String description()

Short description of the metadata. Will be used in the generated documentation.

Returns:

description of the metadata.

additionalClassesToLookAt

default List<Class> additionalClassesToLookAt()

Collection of additional classes to look at if one is interested.

Returns:

additional classes