Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
942 Commits 7 Branches 0 Tags
ffe4c93c3862df712dde666c04be64faaf041bc8
Commit Graph

942 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Andy Wilkinson
ffe4c93c38 Polish "Propagate ignoreUndocumentedParamteres with .and()" 
See gh-676
 2020-09-01 13:55:12 +01:00
Brice Dutheil
eac7d67c4e Propagate ignoreUndocumentedParamteres with .and() 
See gh-676
 2020-09-01 13:54:54 +01:00
Andy Wilkinson
b02fcbee6a Default to UTF-8 when reading operation content as a string 
Fixes gh-689
 2020-09-01 13:37:13 +01:00
Andy Wilkinson
9162888f1b Read snippet templates as UTF-8 by default 
Fixes gh-585
 2020-09-01 13:30:42 +01:00
Andy Wilkinson
c203710ae9 Merge pull request #690 from m-schroeer 
* gh-690:
  Fix descries -> describes typo in the reference docs

Closes gh-690
 2020-08-24 16:58:31 +01:00
M Schröer
323cec4527 Fix descries -> describes typo in the reference docs 
See gh-690
 2020-08-24 16:57:51 +01:00
Andy Wilkinson
7a1a989765 Expand and update REST Assured compatibility testing 
Closes gh-688
 2020-07-13 10:53:28 +01:00
Andy Wilkinson
a9c4732a83 Update javadoc to be Java 11 compatible 
Closes gh-687
 2020-06-08 16:40:48 +01:00
Andy Wilkinson
0146f1a8ca Fix handling of parameters when documenting non-GET requests 
Fixes gh-683
 2020-05-06 13:35:19 +01:00
Andy Wilkinson
f5dda622d0 Merge pull request #679 from progresivoJS 
* gh-679:
  Fix a typo in getting started reference documentation

Closes gh-679
 2020-04-09 08:40:43 +01:00
jinseong.hwang
3fc8780dfc Fix a typo in getting started reference documentation 
See gh-679
 2020-04-09 08:40:08 +01:00
Andy Wilkinson
513a0e9172 Tolerate breaking change in MockHttpServletRequestBuilder 
Closes gh-675
 2020-03-27 16:19:06 +00:00
Andy Wilkinson
22c6475dd1 Merge pull request #673 from luvarqpp 
* gh-673:
  Polish "Add snapshot plugin repository to Data REST sample"
  Add snapshot plugin repository to Data REST sample

Closes gh-673
 2020-03-27 15:49:34 +00:00
Andy Wilkinson
eb0aaf389b Polish "Add snapshot plugin repository to Data REST sample" 
See gh-673
 2020-03-27 15:48:59 +00:00
luvarqpp
075f02d64c Add snapshot plugin repository to Data REST sample 
See gh-673
 2020-03-27 15:47:32 +00:00
Andy Wilkinson
e2e61dff53 Use snake_case consistently for anchors and cross-references 
Closes gh-674
 2020-03-27 15:44:59 +00:00
Andy Wilkinson
1ee96bbb76 Make tests tolerate varying presence of Content-Length header 
In Framework 5.2, the Content-Length is now provided by MockMvc. In
earlier versions it is not. This commit updates the tests to tolerate
this difference in behaviour so that the compatibility tests pass
again.
 2019-12-18 17:43:35 +00:00
Andy Wilkinson
d34a81ff19 Merge pull request #663 from daniel-shuy 
* gh-663:
  Use @BeforeEach instead of @Before in JUnit 5 examples

Closes gh-663
 2019-12-18 09:44:28 +00:00
Daniel Shuy
189d235c84 Use @BeforeEach instead of @Before in JUnit 5 examples 
See gh-663
 2019-12-18 09:44:03 +00:00
Andy Wilkinson
34a007c018 Merge pull request #656 from izeye 
* gh-656:
  Upgrade the Spring Boot-based samples to 2.1.9.RELEASE

Closes gh-656
 2019-10-25 11:46:02 +01:00
Johnny Lim
c34cdc65b1 Upgrade the Spring Boot-based samples to 2.1.9.RELEASE 
See gh-656
 2019-10-25 11:45:46 +01:00
Andy Wilkinson
5cee88c30d Merge pull request #654 from LichKing-lee 
* gh-654:
  Polish "Mention WebTestClient in Gradle getting started example"
  Mention WebTestClient in Gradle getting started example

Closes gh-654
 2019-10-24 10:17:14 +01:00
Andy Wilkinson
14149cb85f Polish "Mention WebTestClient in Gradle getting started example" 
See gh-654
 2019-10-24 10:16:48 +01:00
ChangYong
c8727a2188 Mention WebTestClient in Gradle getting started example 
See gh-654
 2019-10-24 10:16:43 +01:00
Andy Wilkinson
c7d15a0b44 Merge pull request #653 from flo076 
* gh-653:
  Polish "Fix NPE in HttpResponseSnippet when response has custom status"
  Fix NPE in HttpResponseSnippet when response has custom status

Closes gh-653
 2019-10-22 10:09:28 +01:00
Andy Wilkinson
d925a9f219 Polish "Fix NPE in HttpResponseSnippet when response has custom status" 
See gh-653
 2019-10-22 10:09:20 +01:00
Florian Ferreira
aee641b642 Fix NPE in HttpResponseSnippet when response has custom status 
See gh-653
 2019-10-22 10:07:41 +01:00
Andy Wilkinson
bb7aecbfe5 Fix problem with operation block macro when using leveloffset 
Previously, when a document had a leveloffset attribute this was
included in the attributes used when loading a snippet in the
operation block macro. This could lead to warnings about section
titles being out of sequence as the level used for the title did not
take the leveloffset into consideration.

This commit clones the documents attributes and removes any
leveloffset attribute before loading a snippet. This removes the
need for the leveloffset to be considered when loading a snippet
fragment. As before, the level of each block in the fragment loaded
from snippet is then set prior to adding the block to the main
document. This takes the leveloffset into consideration.

Closes gh-649
 2019-10-17 15:40:52 +01:00
Andy Wilkinson
835f0d3a43 Merge pull request #651 from izeye 
* gh-651:
  Remove accidental characters in sample's pom.xml

Closes gh-651
 2019-10-17 12:07:54 +01:00
Johnny Lim
4fb27dbc9f Remove accidental characters in sample's pom.xml 
See gh-651
 2019-10-17 12:07:41 +01:00
Andy Wilkinson
97ddf3dcec Fix handling of empty querty string parameters 
Previously empty parameters in a query string were handled
inconsistently such that they sometimes had a value of "" in a list
and sometimes were represented as an empty list. This inconsistency
lead to the parameter appearing twice in the cURL request snippet.

This commit removes the inconsistency by always using an empty string
to represent an empty query parameter value.

Fixes gh-647
 2019-10-04 18:34:56 +01:00
Andy Wilkinson
92926d65bc Update the samples to use 2.0.5 snapshots 2019-10-04 18:34:42 +01:00
Spring Buildmaster
79fce0c0d7 Next development version 2019-09-30 08:24:32 +00:00
Andy Wilkinson
816987824c Ensure that spring-restdocs-asciidoctor pom contains name and description 2019-09-30 09:04:09 +01:00
Andy Wilkinson
e66c1f4c08 Fix generation of javadoc for the documentation zip 2019-09-29 19:48:11 +01:00
Andy Wilkinson
c12d8c0024 Complete upgrade to org.asciidoctor.convert 1.5.9.2 
See gh-642
 2019-09-29 18:24:41 +01:00
Andy Wilkinson
ce9d0c985f Upgrade the Spring Boot-based samples to 2.1.8.RELEASE 
Closes gh-645
 2019-09-29 18:24:01 +01:00
Andy Wilkinson
733039d12f Upgrade to Spring Framework 5.0.15.RELEASE 
Closes gh-636
 2019-09-29 18:10:19 +01:00
Andy Wilkinson
5f6f7680cd Upgrade to org.asciidoctor.convert 1.5.9.2 
Closes gh-642
 2019-09-19 12:08:12 +01:00
Andy Wilkinson
c2521de8f1 Merge pull request #638 from ahus1 
* gh-638:
  Polish "Prevent unwanted incrementing of section number in operation macro"
  Prevent unwanted incrementing of section number in operation macro

Closes gh-638
 2019-09-19 11:11:22 +01:00
Andy Wilkinson
8624a33ff5 Polish "Prevent unwanted incrementing of section number in operation macro" 
See gh-638
 2019-09-19 11:10:57 +01:00
Alexander Schwartz
1d911367d6 Prevent unwanted incrementing of section number in operation macro 
See gh-638
 2019-09-19 10:45:43 +01:00
Andy Wilkinson
ae59baf38c Remove invalid and empty part from samples' getting started guides 
Fixes gh-641
 2019-09-19 10:37:51 +01:00
Andy Wilkinson
93a43dfd0a Consider optionality when finding uncommon fields in subsection extraction 
Fixes gh-573
 2019-09-18 14:26:40 +01:00
Andy Wilkinson
3f66b066f7 Improve field type resolution for fields with optional ancestors 
Fixes gh-567
 2019-09-18 11:53:42 +01:00
Andy Wilkinson
3a5cc58fab Test against Spring Framework 5.2 2019-09-15 15:03:50 +01:00
Andy Wilkinson
ef0973c548 Test against latest Framework 5.1 snapshot 
This updates REST Docs to test against Framework's latest 5.1
snapshot. Due to a bug in the behaviour of HttpHeaders' key set [1],
HeaderRemovingOperationPreprocessor has been updated to no longer use
it when removing headers from a request or response prior to it being
documented.

[1] https://github.com/spring-projects/spring-framework/issues/22821
 2019-09-14 17:38:29 +01:00
Andy Wilkinson
4bbc5b37b5 Perform compatibility testing against REST Assured 4.0 and 4.1 
Closes gh-640
 2019-09-13 13:02:51 +01:00
Andy Wilkinson
66787cd3a5 Broaden compatibility testing for Asciidoctor 2.x 
Closes gh-630
 2019-09-13 12:58:11 +01:00
Andy Wilkinson
3597ebc35a Allow responses with non-standard status codes to be documented 
Fixes gh-639
 2019-09-12 17:03:21 +01:00