From 15d4ae9c9fe40b60b619e05f5564ebe3c205b22e Mon Sep 17 00:00:00 2001 From: Ronald Holshausen Date: Mon, 18 Dec 2023 11:26:28 +1100 Subject: [PATCH] chore: Correct Javadoc for @Pact annotation #1739 --- .../au/com/dius/pact/core/model/annotations/Pact.kt | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/core/model/src/main/kotlin/au/com/dius/pact/core/model/annotations/Pact.kt b/core/model/src/main/kotlin/au/com/dius/pact/core/model/annotations/Pact.kt index 56da43d697..b440ee2484 100644 --- a/core/model/src/main/kotlin/au/com/dius/pact/core/model/annotations/Pact.kt +++ b/core/model/src/main/kotlin/au/com/dius/pact/core/model/annotations/Pact.kt @@ -2,10 +2,17 @@ package au.com.dius.pact.core.model.annotations /** * describes the interactions between a provider and a consumer used in JUnit tests. - * The annotated method has to be of following signature: + * The annotated method has to be one of following signatures: * + * For legacy DSL classes and request/response interactions: * public RequestResponsePact providerDef1(PactDslWithProvider builder) {...} * + * For message interactions: + * public MessagePact providerDef1(MessagePactBuilder builder) + * + * For V4 DSL classes and any interaction type: + * public V4Pact providerDef1(PactBuilder builder) {...} + * * @author pmucha */ @Retention(AnnotationRetention.RUNTIME)