Enable Section Summary TOC for small pages
This commit is contained in:
Marcin Grzejszczak
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-contract]]
|
||||
= Spring Cloud Contract
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
You always need confidence when pushing new features into a new application or service in
|
||||
a distributed system. To that end, this project provides support for consumer-driven
|
||||
@@ -9,11 +10,13 @@ producers and consumers -- for both HTTP and message-based interactions.
|
||||
|
||||
[[project-page]]
|
||||
= Project page
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
You can read more about Spring Cloud Contract by going to https://spring.io/projects/spring-cloud-contract[the project page]
|
||||
|
||||
[[contributing]]
|
||||
= Contributing
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/src/main/asciidoc/contributing.adoc[]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-contract-reference-documentation]]
|
||||
= Spring Cloud Contract Reference Documentation
|
||||
:page-section-summary-toc: 1
|
||||
Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant
|
||||
|
||||
:docinfo: shared
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-contract-reference-documentation]]
|
||||
= Spring Cloud Contract Reference Documentation
|
||||
:page-section-summary-toc: 1
|
||||
Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-contract-reference-documentation]]
|
||||
= Spring Cloud Contract Reference Documentation
|
||||
:page-section-summary-toc: 1
|
||||
Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant
|
||||
|
||||
:docinfo: shared
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[contract-groovy]]
|
||||
= Contract DSL in Groovy
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If you are not familiar with Groovy, do not worry. You can use Java syntax in the
|
||||
Groovy DSL files as well.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[contract-limitations]]
|
||||
= Limitations
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
WARNING: The support for verifying the size of JSON arrays is experimental. If you want
|
||||
to turn it on, set the value of the following system property to `true`:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[contract-yml]]
|
||||
= Contract DSL in YAML
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
To see a schema of a YAML contract, visit the {docs-url}/reference/html/yml-schema.html[YML Schema] page.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
[[feature-integrations]]
|
||||
= Integrations
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[features-stub-runner]]
|
||||
= Spring Cloud Contract Stub Runner
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
One of the issues that you might encounter while using Spring Cloud Contract Verifier is
|
||||
passing the generated WireMock JSON stubs from the server side to the client side (or to
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[features-stub-runner-snapshot-versions]]
|
||||
= Snapshot Versions
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
You can add the additional snapshot repository to your build file to use snapshot
|
||||
versions, which are automatically uploaded after every successful build, as follows:
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[appendix]
|
||||
[[common-application-properties]]
|
||||
= Common application properties
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
|
||||
Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[getting-started]]
|
||||
= Getting Started
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If you are getting started with {project-full-name} or Spring in general, start by reading
|
||||
this section. It answers the basic "`what?`", "`how?`" and "`why?`" questions. It
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[howto]]
|
||||
= "`How-to`" Guides
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
This section provides answers to some common "`how do I do that...?`" questions
|
||||
that often arise when using {project-full-name}. Its coverage is not exhaustive, but it
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-debug-wiremock]]
|
||||
= How Can I Debug the Mapping, Request, or Response Being Sent by WireMock?
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Starting from version `1.2.0`, we set WireMock logging to
|
||||
`info` and set the WireMock notifier to being verbose. Now you can
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-debug]]
|
||||
= How Can I Debug the Request/Response Being Sent by the Generated Tests Client?
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The generated tests all boil down to RestAssured in some form or fashion. RestAssured
|
||||
relies on the https://hc.apache.org/httpcomponents-client-ga/[Apache HttpClient].
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-generate-stubs-at-runtime]]
|
||||
= How Can I Generate Stubs at Runtime
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If you want to generate stubs at runtime for contracts, switch the `generateStubs` property in the `@AutoConfigureStubRunner` annotation, or call the `withGenerateStubs(true)` method on the JUnit Rule or Extension. You can read more about this in xref:_project-features-stubrunner/stub-runner-generate-stubs-at-runtime.adoc[this section] of the documentation.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-mark-contract-in-progress]]
|
||||
= How Can I Mark that a Contract Is in Progress
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If a contract is in progress, it means that the, on the producer side, tests are not generated, but the stub is generated. You can read more about this in xref:_project-features-contract/common-top-elements.adoc#contract-dsl-in-progress[this section] of the documentation.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-not-write-contracts-in-groovy]]
|
||||
= How Can I Write Contracts in a Language Other than Groovy?
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
You can write a contract in YAML. See xref:_project-features-contract.adoc[this section] for more information.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-reference-text-from-file]]
|
||||
= How Can I Reference Text from File?
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
In version 1.2.0, we added this ability. You can call a `file(...)` method in the
|
||||
DSL and provide a path relative to where the contract lies.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-see-registered-stubs]]
|
||||
= How Can I See What Got Registered in the HTTP Server Stub?
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
You can use the `mappingsOutputFolder` property on `@AutoConfigureStubRunner`, `StubRunnerRule`, or
|
||||
`StubRunnerExtension` to dump all mappings for each artifact ID. Also, the port at which the given stub server
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-use-stubs-from-a-location]]
|
||||
= How Can I Use Stubs from a Location
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If you want to fetch contracts or stubs from a given location without cloning a repository or fetching a JAR, use the `stubs://` protocol when providing the repository root argument for Stub Runner or the Spring Cloud Contract plugin. You can read more about this in xref:_project-features-stubrunner/stub-runner-stubs-protocol.adoc[this section] of the documentation.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[how-to-use-the-failonnostubs-feature]]
|
||||
= How Can I Make The Build Pass if There Are No Contracts or Stubs
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If you want Stub Runner not to fail if no stubs were found, switch the `generateStubs` property in the `@AutoConfigureStubRunner` annotation or call the `withFailOnNoStubs(false)` method on the JUnit Rule or Extension. You can read more about this in xref:_project-features-stubrunner/stub-runner-fail-on-no-stubs.adoc[this section] of the documentation.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[why-spring-cloud-contract]]
|
||||
= Why use Spring Cloud Contract?
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Spring Cloud Contract works great in a polyglot environment. This project has a lot of
|
||||
really interesting features. Quite a few of these features definitely make
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
[legal]
|
||||
[[legal]]
|
||||
= Legal
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
{project-version}
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-contract-reference-documentation]]
|
||||
= Spring Cloud Contract Reference Documentation
|
||||
:page-section-summary-toc: 1
|
||||
Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant
|
||||
|
||||
:docinfo: shared
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[yml-schema]]
|
||||
= YML Schema
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
|
||||
Below you can find a JSON schema definition of a YAML contract.
|
||||
|
||||
Reference in New Issue
Block a user