Commit Graph

443 Commits

Author SHA1 Message Date
Andy Wilkinson
bd63fae662 Update dependency versions in the samples to use latest snapshots 2017-05-12 12:39:14 +01:00
Andy Wilkinson
b00b13fed5 Upgrade to spring-asciidoctor-extensions 0.1.1.RELEASE 2017-05-11 15:17:30 +01:00
Spring Buildmaster
72d692107f Next development version 2017-04-24 13:19:52 +00:00
Andy Wilkinson
af0cd029c7 Ensure that samples' REST Docs version is updated before they are built 2017-03-24 14:42:09 +00:00
Andy Wilkinson
b6120cd539 Fix broken cross-reference 2017-03-23 12:33:09 +00:00
Andy Wilkinson
b1227ce019 Remove recommendation about tweaking Surefire's configuration
Configuring Surefire to run tests found in files ending in
Documentation.java has the unwanted side-effect of switching off its
defaults, i.e. you end up with your documentation tests being run and
nothing else. While using a specific name for your documentation tests
can make them easier to identify, it isn't required. The documentation
also doesn't explicitly recommend using a Documentation suffix.

This commit simplifies things by removing the configuration that
changes Surefire's default inclusions.

Closes gh-368
2017-03-23 12:19:08 +00:00
Andy Wilkinson
5a76decc11 Link to correct branch on GitHub in snapshot documentation
Closes gh-367
2017-03-08 13:07:09 +00:00
Andy Wilkinson
70df55d413 Use code block switch extension from separate project
Closes gh-229
2017-03-08 13:04:27 +00:00
Andy Wilkinson
81c2816693 Relax field type validation when marked as optional and value is null
Previously, if a field was marked as optional and it appeared in a
payload with a null value a failure would occur if the field's type
was configured to be a JsonFieldType other than NULL.

This commit relaxes this restriction so that a null value is tolerated
when a field has been marked as optional.

Closes gh-365
2017-03-08 12:38:03 +00:00
Andy Wilkinson
281abb2e8b Ensure that Gradle's daemon is always disabled 2017-03-08 12:20:55 +00:00
Andy Wilkinson
2fa0aa4472 Further tweaks to try and get builds on Travis to work reliably 2017-03-05 17:28:31 +00:00
Andy Wilkinson
17acbb9fbf Upgrade Travis configuration to use a recent version of Oracle JDK 8
By default, Travis uses a rather old version of Oracle's JDK 8 in
its container-based infrastructure. It would appear that this is what
has been causing the build to fail with minimal diagnostics.

This commit implements a suggestion [1] to get a more recent version
of Java 8 by installing the oracle-java8-installer package via the APT
addon.

[1] https://github.com/travis-ci/travis-ci/issues/3259#issuecomment-130860338
2017-03-05 16:23:47 +00:00
Andy Wilkinson
727f6ccd78 Protect the tests against changes to MockMvc's HTTP header ordering
Closes gh-359
2017-03-04 20:45:47 +00:00
Andy Wilkinson
7cb91f9963 Remove use of Spring Boot from REST Assured module's integration tests
Closes gh-360
2017-03-04 20:40:42 +00:00
Andy Wilkinson
a19aef796f Merge pull request #329 from Gerrit Meier
* gh-329:
  Document that port is omitted when it matches the scheme's default
2016-12-16 14:41:37 +00:00
Gerrit Meier
2fb3ede3a6 Document that port is omitted when it matches the scheme's default
Closes gh-325
Closes gh-329
2016-12-16 14:41:30 +00:00
Andy Wilkinson
b7e4edf904 Merge pull request #334 from stonio
* gh-334:
  Clarify that parameterized output directory uses the simple class name
2016-12-16 14:33:26 +00:00
stonio
9bbb60ac2a Clarify that parameterized output directory uses the simple class name
Closes gh-334
2016-12-16 14:32:35 +00:00
Andy Wilkinson
7ff45d273e Call the right endpoint in REST Assured field reuse example
Closes gh-324
2016-10-28 16:19:19 +01:00
Andy Wilkinson
60e1bdd5f4 Merge pull request #314 from Luis del Toro
* gh-314:
  Polish "Copy attributes when applying path prefix to field descriptors"
  Copy attributes when applying path prefix to field descriptors
2016-10-25 11:35:55 +01:00
Andy Wilkinson
7487f41363 Polish "Copy attributes when applying path prefix to field descriptors"
- Apply code formatting
 - Test copying of attributes (and other parts of a field descriptor)
   in new PayloadDocumentationTests

Closes gh-314
2016-10-25 11:34:09 +01:00
Luis del Toro
27b7553812 Copy attributes when applying path prefix to field descriptors
See gh-314
2016-10-25 11:34:09 +01:00
Andy Wilkinson
0c64c781f4 Improve styling of groovy and adoc code blocks in the documentation
Closes gh-317
2016-10-21 23:09:47 +01:00
Spring Buildmaster
c0e950b3ee Next development version 2016-08-31 08:47:58 +00:00
Andy Wilkinson
0f1f84e6a6 Fix JSON field type resolution for top-level and nested array fields
Previously, the logic that determined the field’s type would incorrectly
look at the contents of the array. For example, if the array contained
one or more objects, the field’s type would be resolved as Object rather
than Array.

This commit updates JsonFieldPath to record when a path explicitly
identifies an array so that the array itself is used to determine the
field’s type rather than its contents.

Closes gh-292
2016-08-24 13:02:21 +01:00
Andy Wilkinson
4e4d01a459 Consolidate logic in test rules for getting output dir and operation name 2016-08-24 12:49:51 +01:00
Andy Wilkinson
21567e0ffa Simply dealing with operation names in REST Docs' own tests 2016-08-24 10:05:17 +01:00
Andy Wilkinson
14dcdb61d0 Fix package tangle between cli and operation packages
QueryStringParser has been moved into the operation page. In the
unlikely event that there were any external users of the class, a
deprecated version remains in the cli package for backwards
compatibility. It will be removed in 1.2.

Closes gh-286
2016-08-19 20:14:20 +01:00
Andy Wilkinson
5c6cf7f12f Polishing 2016-08-19 19:52:25 +01:00
Andy Wilkinson
a0faebdb0a Ignore query string when extracting path parameters
Closes gh-285
2016-08-19 19:52:23 +01:00
Andy Wilkinson
9ba0a9b6be Stop field snippets requiring a type for missing, optional, ignored field
Missing optional fields require a type to be explicitly provided as
it cannot be inferred from the payload. Ignored fields are not
included in the documentation, yet, previously, a field that was
missing, optional, and ignored would still require a type to be
provided otherwise the test would fail. This was pointless as the
field wasn't going to appear in the documentation.

This commit updates the fields snippets so that a type is no longer
required for a field that is missing, optional and ignored.

Closes gh-289
2016-08-19 19:52:14 +01:00
Andy Wilkinson
ec3a05926e Merge branch '1.0.x' into 1.1.x 2016-08-10 17:22:58 +01:00
Andy Wilkinson
b430a88796 Polishing 2016-08-10 17:08:18 +01:00
Andy Wilkinson
bf9b0f2d64 Ensure that query string is not duplicated when parameters overlap
Closes gh-286
2016-07-29 21:10:21 +01:00
Andy Wilkinson
110fa23958 Configure sonar.branch 2016-07-25 14:53:54 +01:00
Andy Wilkinson
67d31fd7d9 Upgrade to Jacoco 0.7.7.201606060606
Closes gh-282
2016-07-25 14:29:52 +01:00
Andy Wilkinson
d919238023 Update the samples following the release of 1.1.1.RELEASE 2016-07-25 11:06:49 +01:00
Spring Buildmaster
8a91f17054 Next development version 2016-07-25 09:24:28 +00:00
Andy Wilkinson
6c6054178e Upgrade tests and samples to use Spring Boot 1.3.6.RELEASE 2016-07-22 14:41:45 +01:00
Andy Wilkinson
3ec945fe58 Make it clearer how to use RestDocumentationResultHandler.document
Closes gh-255
2016-07-22 14:30:09 +01:00
Andy Wilkinson
3dceea8bb5 Document the tableCellContent Mustache lambda
Closes gh-251
2016-07-22 14:19:13 +01:00
Andy Wilkinson
78318775e0 Cause a failure when field's documented and actual types do not match
Closes gh-276
2016-07-22 13:20:44 +01:00
Andy Wilkinson
86c2310b90 Improve message when fields cannot be documented due to empty body
Closes gh-278
2016-07-22 11:44:43 +01:00
Andy Wilkinson
6131730621 Merge pull request #279 from mle-enso
* gh-279:
  Polish "Improve documention on how to use .adoc snippets"
  Improve documention on how to use .adoc snippets
2016-07-22 10:56:32 +01:00
Andy Wilkinson
9c97c8b9bf Polish "Improve documention on how to use .adoc snippets"
See gh-279
2016-07-22 10:51:11 +01:00
mle
eb46eaa3c5 Improve documention on how to use .adoc snippets
Closes gh-279
2016-07-22 10:47:13 +01:00
Andy Wilkinson
f77864b094 Merge pull request #280 from Johnny Lim
* gh-280:
  Remove unnecessary Host header set in UriModifyingOperationPreprocessor
2016-07-22 10:18:24 +01:00
Johnny Lim
19d7337e26 Remove unnecessary Host header set in UriModifyingOperationPreprocessor
Closes gh-280
2016-07-22 10:17:58 +01:00
Andy Wilkinson
4f00cebaae Adopt the new CLA signing process 2016-07-11 10:47:14 +01:00
Andy Wilkinson
a3159b6f1c Update README to link to restdocsext-jersey third-party extension 2016-07-05 15:37:22 +01:00