SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2019-10-22 09:25:32 +00:00
parent 202fd0212e
commit 0adfdbbe80
4 changed files with 6628 additions and 6359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
reference/html/project-features.html
View File

@@ -101,14 +101,15 @@ $(addBlockSwitches);
<li><a href="#contract-groovy">1.1. Contract DSL in Groovy</a></li>
<li><a href="#contract-java">1.2. Contract DSL in Java</a></li>
<li><a href="#contract-kotlin">1.3. Contract DSL in Kotlin</a></li>
<li><a href="#contract-limitations">1.4. Limitations</a></li>
<li><a href="#contract-common-top-elements">1.5. Common Top-Level Elements</a>
<li><a href="#contract-yml">1.4. Contract DSL in YML</a></li>
<li><a href="#contract-limitations">1.5. Limitations</a></li>
<li><a href="#contract-common-top-elements">1.6. Common Top-Level Elements</a>
<ul class="sectlevel3">
<li><a href="#contract-dsl-description">1.5.1. Description</a></li>
<li><a href="#contract-dsl-name">1.5.2. Name</a></li>
<li><a href="#contract-dsl-ignoring-contracts">1.5.3. Ignoring Contracts</a></li>
<li><a href="#contract-dsl-in-progress">1.5.4. Contracts in Progress</a></li>
<li><a href="#contract-dsl-passing-values-from-files">1.5.5. Passing Values from Files</a></li>
<li><a href="#contract-dsl-description">1.6.1. Description</a></li>
<li><a href="#contract-dsl-name">1.6.2. Name</a></li>
<li><a href="#contract-dsl-ignoring-contracts">1.6.3. Ignoring Contracts</a></li>
<li><a href="#contract-dsl-in-progress">1.6.4. Contracts in Progress</a></li>
<li><a href="#contract-dsl-passing-values-from-files">1.6.5. Passing Values from Files</a></li>
</ul>
</li>
</ul>
@@ -770,7 +771,13 @@ You can also provide an import to the <code>contract</code> function (<code>impo
</div>
</div>
<div class="sect2">
<h3 id="contract-limitations"><a class="anchor" href="#contract-limitations"></a><a class="link" href="#contract-limitations">1.4. Limitations</a></h3>
<h3 id="contract-yml"><a class="anchor" href="#contract-yml"></a><a class="link" href="#contract-yml">1.4. Contract DSL in YML</a></h3>
<div class="paragraph">
<p>In order to see a schema of a YAML contract, you can check out the <a href="yml-schema.html">YML Schema</a> page.</p>
</div>
</div>
<div class="sect2">
<h3 id="contract-limitations"><a class="anchor" href="#contract-limitations"></a><a class="link" href="#contract-limitations">1.5. Limitations</a></h3>
<div class="admonitionblock warning">
<table>
<tr>
@@ -802,7 +809,7 @@ is why you should use the Groovy Map notation.
</div>
</div>
<div class="sect2">
<h3 id="contract-common-top-elements"><a class="anchor" href="#contract-common-top-elements"></a><a class="link" href="#contract-common-top-elements">1.5. Common Top-Level Elements</a></h3>
<h3 id="contract-common-top-elements"><a class="anchor" href="#contract-common-top-elements"></a><a class="link" href="#contract-common-top-elements">1.6. Common Top-Level Elements</a></h3>
<div class="paragraph">
<p>The following sections describe the most common top-level elements:</p>
</div>
@@ -826,7 +833,7 @@ is why you should use the Groovy Map notation.
</ul>
</div>
<div class="sect3">
<h4 id="contract-dsl-description"><a class="anchor" href="#contract-dsl-description"></a><a class="link" href="#contract-dsl-description">1.5.1. Description</a></h4>
<h4 id="contract-dsl-description"><a class="anchor" href="#contract-dsl-description"></a><a class="link" href="#contract-dsl-description">1.6.1. Description</a></h4>
<div class="paragraph">
<p>You can add a <code>description</code> to your contract. The description is arbitrary text. The
following code shows an example:</p>
@@ -929,7 +936,7 @@ then:
</div>
</div>
<div class="sect3">
<h4 id="contract-dsl-name"><a class="anchor" href="#contract-dsl-name"></a><a class="link" href="#contract-dsl-name">1.5.2. Name</a></h4>
<h4 id="contract-dsl-name"><a class="anchor" href="#contract-dsl-name"></a><a class="link" href="#contract-dsl-name">1.6.2. Name</a></h4>
<div class="paragraph">
<p>You can provide a name for your contract. Assume that you provided the following name:
<code>should register a user</code>. If you do so, the name of the autogenerated test is
@@ -990,7 +997,7 @@ override each other.
</div>
</div>
<div class="sect3">
<h4 id="contract-dsl-ignoring-contracts"><a class="anchor" href="#contract-dsl-ignoring-contracts"></a><a class="link" href="#contract-dsl-ignoring-contracts">1.5.3. Ignoring Contracts</a></h4>
<h4 id="contract-dsl-ignoring-contracts"><a class="anchor" href="#contract-dsl-ignoring-contracts"></a><a class="link" href="#contract-dsl-ignoring-contracts">1.6.3. Ignoring Contracts</a></h4>
<div class="paragraph">
<p>If you want to ignore a contract, you can either set a value for ignored contracts in the
plugin configuration or set the <code>ignored</code> property on the contract itself. The following
@@ -1032,7 +1039,7 @@ example shows how to do so:</p>
</div>
</div>
<div class="sect3">
<h4 id="contract-dsl-in-progress"><a class="anchor" href="#contract-dsl-in-progress"></a><a class="link" href="#contract-dsl-in-progress">1.5.4. Contracts in Progress</a></h4>
<h4 id="contract-dsl-in-progress"><a class="anchor" href="#contract-dsl-in-progress"></a><a class="link" href="#contract-dsl-in-progress">1.6.4. Contracts in Progress</a></h4>
<div class="paragraph">
<p>A contract in progress will not generate tests on the producer side, but will allow generation of stubs.</p>
</div>
@@ -1091,7 +1098,7 @@ example shows how to do so:</p>
</div>
</div>
<div class="sect3">
<h4 id="contract-dsl-passing-values-from-files"><a class="anchor" href="#contract-dsl-passing-values-from-files"></a><a class="link" href="#contract-dsl-passing-values-from-files">1.5.5. Passing Values from Files</a></h4>
<h4 id="contract-dsl-passing-values-from-files"><a class="anchor" href="#contract-dsl-passing-values-from-files"></a><a class="link" href="#contract-dsl-passing-values-from-files">1.6.5. Passing Values from Files</a></h4>
<div class="paragraph">
<p>Starting with version <code>1.2.0</code>, you can pass values from files. Assume that you have the
following resources in your project:</p>