Sync docs from master to gh-pages

This commit is contained in:
buildmaster
2018-02-16 15:52:38 +00:00
parent a5e58c43dc
commit 98f4c2d3dd
30 changed files with 276 additions and 312 deletions

View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2018-02-11
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2018-02-16
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20180211" />
<meta name="Date-Revision-yyyymmdd" content="20180216" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Maven Plugin &#x2013; spring-cloud-contract:convert</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -146,7 +146,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2018-02-11
<li id="publishDate">Last Published: 2018-02-16
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 2.0.0.BUILD-SNAPSHOT
@@ -321,6 +321,17 @@ written using the GroovyDSL<br /><b>Default value is</b>: <tt>${project.basedir}
<tr class="b">
<td><b><a href="#contractsMode">contractsMode</a></b></td>
<td><tt>StubRunnerProperties$StubsMode</tt></td>
<td><tt>-</tt></td>
<td>Picks the mode in which stubs will be found and registered<br /><b>Default value is</b>: <tt>CLASSPATH</tt>.<br /><b>User property is</b>: <tt>contractsMode</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#contractsPath">contractsPath</a></b></td>
<td><tt>String</tt></td>
@@ -336,7 +347,7 @@ particular service lay. If not provided will be resolved to
path will be <tt>/com/example/artifactid</tt><br /><b>User property is</b>: <tt>contractsPath</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#contractsRepositoryPassword">contractsRepositoryPassword</a></b></td>
@@ -347,7 +358,7 @@ path will be <tt>/com/example/artifactid</tt><br /><b>User property is</b>: <tt>
<td>The password to be used to connect to the repo with contracts.<br /><b>User property is</b>: <tt>contractsRepositoryPassword</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#contractsRepositoryProxyHost">contractsRepositoryProxyHost</a></b></td>
@@ -358,7 +369,7 @@ path will be <tt>/com/example/artifactid</tt><br /><b>User property is</b>: <tt>
<td>The proxy host to be used to connect to the repo with contracts.<br /><b>User property is</b>: <tt>contractsRepositoryProxyHost</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#contractsRepositoryProxyPort">contractsRepositoryProxyPort</a></b></td>
@@ -369,7 +380,7 @@ path will be <tt>/com/example/artifactid</tt><br /><b>User property is</b>: <tt>
<td>The proxy port to be used to connect to the repo with contracts.<br /><b>User property is</b>: <tt>contractsRepositoryProxyPort</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#contractsRepositoryUrl">contractsRepositoryUrl</a></b></td>
@@ -383,7 +394,7 @@ was provided then the current Maven's build repositories will be
taken into consideration<br /><b>User property is</b>: <tt>contractsRepositoryUrl</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#contractsRepositoryUsername">contractsRepositoryUsername</a></b></td>
@@ -394,6 +405,18 @@ taken into consideration<br /><b>User property is</b>: <tt>contractsRepositoryUr
<td>The user name to be used to connect to the repo with contracts.<br /><b>User property is</b>: <tt>contractsRepositoryUsername</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#contractsSnapshotCheckSkip">contractsSnapshotCheckSkip</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>If <tt>true</tt> then will not assert whether a stub / contract
JAR was downloaded from local or remote location<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>contractsSnapshotCheckSkip</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#destination">destination</a></b></td>
@@ -455,17 +478,6 @@ maven project.</p><br /><b>Default value is</b>: <tt>${basedir}</tt>.<br /><b>Us
be placed. You can then mention them in your packaging task to
create jar with stubs<br /><b>Default value is</b>: <tt>${project.build.directory}/stubs/</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#stubsMode">stubsMode</a></b></td>
<td><tt>StubRunnerProperties$StubsMode</tt></td>
<td><tt>-</tt></td>
<td>Picks the mode in which stubs will be found and registered<br /><b>Default value is</b>: <tt>CLASSPATH</tt>.<br /><b>User property is</b>: <tt>stubsMode</tt>.<br /></td>
</tr>
</table>
</div>
@@ -499,6 +511,20 @@ written using the GroovyDSL</div>
<li><b>Default</b>: <tt>${project.basedir}/src/test/resources/contracts</tt></li>
</ul><hr />
<p><b><a name="contractsMode">contractsMode</a>:</b></p>
<div>Picks the mode in which stubs will be found and registered</div>
<ul>
<li><b>Type</b>: <tt>org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties$StubsMode</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>contractsMode</tt></li>
<li><b>Default</b>: <tt>CLASSPATH</tt></li>
</ul><hr />
<p><b><a name="contractsPath">contractsPath</a>:</b></p>
<div>The path in the JAR with all the contracts where contracts for this
@@ -580,6 +606,21 @@ taken into consideration</div>
<li><b>User Property</b>: <tt>contractsRepositoryUsername</tt></li>
</ul><hr />
<p><b><a name="contractsSnapshotCheckSkip">contractsSnapshotCheckSkip</a>:</b></p>
<div>If <tt>true</tt> then will not assert whether a stub / contract
JAR was downloaded from local or remote location</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>contractsSnapshotCheckSkip</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="destination">destination</a>:</b></p>
<div>(no description)</div>
@@ -654,20 +695,6 @@ create jar with stubs</div>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/stubs/</tt></li>
</ul><hr />
<p><b><a name="stubsMode">stubsMode</a>:</b></p>
<div>Picks the mode in which stubs will be found and registered</div>
<ul>
<li><b>Type</b>: <tt>org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties$StubsMode</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>stubsMode</tt></li>
<li><b>Default</b>: <tt>CLASSPATH</tt></li>
</ul>
</div>
</div>