From 1078ae8072dd0ac3748cd7a945b3021e6508a15b Mon Sep 17 00:00:00 2001 From: Yura Nosenko Date: Thu, 3 May 2018 14:32:06 +0300 Subject: [PATCH] snapshotCheckSkip javadoc enhancement (#634) --- docs/src/main/asciidoc/verifier_setup.adoc | 4 ++-- .../cloud/contract/stubrunner/StubRunnerOptions.java | 2 +- .../contract/stubrunner/junit/StubRunnerRuleOptions.java | 2 +- .../contract/stubrunner/spring/AutoConfigureStubRunner.java | 2 +- .../contract/stubrunner/spring/StubRunnerProperties.java | 2 +- .../contract/verifier/plugin/ContractVerifierExtension.groovy | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/src/main/asciidoc/verifier_setup.adoc b/docs/src/main/asciidoc/verifier_setup.adoc index 36fdb434c2..aca67ea259 100644 --- a/docs/src/main/asciidoc/verifier_setup.adoc +++ b/docs/src/main/asciidoc/verifier_setup.adoc @@ -261,7 +261,7 @@ closure to set it up. * *contractsMode*: Specifies the mode of downloading contracts (whether the JAR is available offline, remotely etc.) * *contractsSnapshotCheckSkip*: If set to `true` will not assert whether the -downloaded stubs / contract JAR was downloaded from a remote location or a local one +downloaded stubs / contract JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact). * *deleteStubsAfterTest*: If set to `false` will not remove any downloaded contracts from temporary directories @@ -1168,4 +1168,4 @@ will be executed against the running application under http://localhost:8081/artifactory/libs-release-local/com/example/bookstore/0.0.1.RELEASE/ . The stubs will be here http://localhost:8081/artifactory/libs-release-local/com/example/bookstore/0.0.1.RELEASE/bookstore-0.0.1.RELEASE-stubs.jar. -To see how the client side looks like check out the <> section. \ No newline at end of file +To see how the client side looks like check out the <> section. diff --git a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.java b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.java index e6024b8238..eb8511445f 100644 --- a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.java +++ b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.java @@ -103,7 +103,7 @@ public class StubRunnerOptions { /** * If set to {@code true} will not assert whether the downloaded stubs / contract - * JAR was downloaded from a remote location or a local one + * JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact) */ private boolean snapshotCheckSkip; diff --git a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleOptions.java b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleOptions.java index 2a28857197..90bc1fecc7 100644 --- a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleOptions.java +++ b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleOptions.java @@ -97,7 +97,7 @@ interface StubRunnerRuleOptions { /** * If set to {@code true} will not assert whether the downloaded stubs / contract - * JAR was downloaded from a remote location or a local one + * JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact) */ StubRunnerRule withSnapshotCheckSkip(boolean snapshotCheckSkip); diff --git a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/AutoConfigureStubRunner.java b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/AutoConfigureStubRunner.java index deba5b5666..6ea080971e 100644 --- a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/AutoConfigureStubRunner.java +++ b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/AutoConfigureStubRunner.java @@ -111,7 +111,7 @@ public @interface AutoConfigureStubRunner { /** * If set to {@code true} will not assert whether the downloaded stubs / contract - * JAR was downloaded from a remote location or a local one + * JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact) */ boolean snapshotCheckSkip() default false; diff --git a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/StubRunnerProperties.java b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/StubRunnerProperties.java index 0d09b7c6cc..9b6fcc6146 100644 --- a/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/StubRunnerProperties.java +++ b/spring-cloud-contract-stub-runner/src/main/java/org/springframework/cloud/contract/stubrunner/spring/StubRunnerProperties.java @@ -101,7 +101,7 @@ public class StubRunnerProperties { /** * If set to {@code true} will not assert whether the downloaded stubs / contract - * JAR was downloaded from a remote location or a local one + * JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact) */ private boolean snapshotCheckSkip; diff --git a/spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierExtension.groovy b/spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierExtension.groovy index 13517e1473..5cabf8516e 100644 --- a/spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierExtension.groovy +++ b/spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierExtension.groovy @@ -174,7 +174,7 @@ class ContractVerifierExtension { /** * If set to {@code true} will not assert whether the downloaded stubs / contract - * JAR was downloaded from a remote location or a local one + * JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact) */ boolean contractsSnapshotCheckSkip = false