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

298 Commits

Author SHA1 Message Date
Andy Wilkinson
03b61ab075 Use Framework's HttpStatusCode to model response's status 
Closes gh-848
 2022-10-12 11:26:01 +01:00
Andy Wilkinson
f5a629af34 Handle form and query parameters separately 
Previously, form and query parameters were handled together as
request parameters. Howeer, request parameters are a server-side
construct that's specific to the servlet specification. As such
they're not appropriate for the client-side documentation that
Spring REST Docs aims to produce.

This commit replaces support for documenting request parameters
with support for documenting query paramters found in the query
string of the request's URI and for documenting form parameters
found in the form URL encoded body of the request.

Closes gh-832
 2022-10-12 10:18:33 +01:00
Andy Wilkinson
b4be34bf8e Remove support for modifying request parameters 
Request parameters are a server-side constructor, specific to the
servlet specification. Rather than modifying request parameters the
query string of the URI or the form URL encoded content of the body
should be modified instead.

Closes gh-846
 2022-10-12 10:17:01 +01:00
Andy Wilkinson
d5522f5335 Polish "Add support for documenting request and response cookies" 
See gh-592
 2022-07-18 14:46:26 +01:00
clydebarrow
f72a9f1067 Add support for documenting request and response cookies 
See gh-592
 2022-07-18 11:16:16 +01:00
Andy Wilkinson
aa9cef9f02 Polish "Specify language derived from Content-Type in body snippets" 
See gh-797
 2022-07-15 15:47:31 +01:00
Achim Grimm
9a44205253 Specify language derived from Content-Type in body snippets 
See gh-797
 2022-07-15 15:46:31 +01:00
Andy Wilkinson
5be36f5e9e Merge branch '2.0.x' 2022-06-20 20:44:07 +01:00
Andy Wilkinson
f6f45caf5c Merge branch '2.0.x' 2022-06-20 16:40:06 +01:00
Andy Wilkinson
36418f47d7 Polish "Provide a preprocessor for modifying request and response headers" 
See gh-584
 2022-05-12 14:51:08 +01:00
Jihoon Cha
768a43a61e Provide a preprocessor for modifying request and response headers 
See gh-584
 2022-05-12 14:51:04 +01:00
Andy Wilkinson
400bf8c7d8 Merge branch '2.0.x' 2022-03-24 15:14:16 +00:00
Andy Wilkinson
8ee41a21f1 Fix modification of portless URIs when content has subsequent colon 
Closes gh-790
 2022-03-24 15:01:12 +00:00
Andy Wilkinson
4cf5892015 Remove deprecated code 
Closes gh-781
 2022-01-17 13:44:14 +00:00
Andy Wilkinson
c60c87a2b1 Merge branch '2.0.x' 2022-01-10 14:32:51 +00:00
Andy Wilkinson
d4d83f293a Fix HTTP request snippet's handling of query strings and params 
Closes gh-763
 2022-01-10 14:31:03 +00:00
Andy Wilkinson
8f8b118411 Merge branch '2.0.x' 2022-01-10 13:40:00 +00:00
Andy Wilkinson
90e0721b7a Use --multipart for HTTPie multipart requests 
Previously --form was ussed which relied on a file part turning the
request into a --multipart one. Switching to --multipart makes the
intent of the request more clear and also simplifies sending parts
that aren't file-based.

Closes gh-771
 2022-01-10 13:37:25 +00:00
Andy Wilkinson
a6687cf488 Merge branch '2.0.x' 2022-01-10 13:16:32 +00:00
Andy Wilkinson
a63a514193 Avoid duplicates in multipart reqs with overlapping parts and params 
Fixes gh-746
 2022-01-10 13:16:01 +00:00
Andy Wilkinson
42e84d1db3 Polish "Fix typo in OperationResponseFactory Javadoc" 
See gh-765
 2022-01-04 11:49:26 +00:00
izeye
a6a7a93179 Fix typo in OperationResponseFactory Javadoc 
See gh-765
 2022-01-04 11:49:07 +00:00
Andy Wilkinson
429d6da222 Merge branch '2.0.x' 2021-11-17 19:19:00 +00:00
Andy Wilkinson
36358244ca Avoid possible NPE in JsonFieldPaths 
See gh-715
 2021-11-17 19:18:42 +00:00
Andy Wilkinson
da98852d53 Upgrade to Spring Java Format 0.0.29 2021-11-17 11:18:00 +00:00
Andy Wilkinson
4223f70102 Upgrade to Spring Framework 6 and Jakarta EE 9 
Closes gh-750
Closes gh-748
 2021-11-17 11:18:00 +00:00
Andy Wilkinson
68ff043fb3 Raise the minimum supported version of Java to 17 
Closes gh-749
 2021-11-17 11:18:00 +00:00
Andy Wilkinson
88fe8a6f13 Stop pretty printing from truncating content starts as valid JSON 
Fixes gh-730
 2021-06-15 11:37:29 +01:00
Andy Wilkinson
6c0960d304 Polish "Improve exception message when subsection is empty array" 
See gh-732
 2021-06-14 21:12:45 +01:00
ddaaac
cbe6d775f3 Improve exception message when subsection is empty array 
See gh-732
 2021-06-14 21:12:32 +01:00
Andy Wilkinson
2b5eab309c Improve error message when extracting a sometimes absent sub-section 
Fixes gh-715
 2021-04-19 14:18:47 +01:00
Andy Wilkinson
c3cb7af68a Preserve UTF-8 content when masking links in JSON payloads 
Closes gh-705
 2021-01-08 12:17:50 +00:00
Andy Wilkinson
536e87acc9 Fix kebab and snake case formatting of all upper case words 
Closes gh-658
 2020-09-01 16:28:03 +01:00
Andy Wilkinson
baaf4f2e05 Update query string when modifying GET request's parameters 
Fixes gh-682
 2020-09-01 15:35:17 +01:00
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
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
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
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
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
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
3597ebc35a Allow responses with non-standard status codes to be documented 
Fixes gh-639
 2019-09-12 17:03:21 +01:00
Andy Wilkinson
1b87af13be Improve diagnostics when extracting a non-existent subsection 
Closes gh-568
 2019-08-30 14:05:50 +01:00
Andy Wilkinson
bc66fe5643 Polish "Allow custom snippets directory via JUnit 5" 
See gh-633
 2019-08-30 11:43:35 +01:00
Jochen Just
43ec46fcc1 Allow custom snippets directory via JUnit 5 
See gh-633
 2019-08-30 11:23:19 +01:00