Commit Graph

307 Commits

Author SHA1 Message Date
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
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
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
Andy Wilkinson
cc22dbfe26 Merge branch '1.2.x' 2019-08-30 11:20:34 +01:00
Andy Wilkinson
508b3d6593 Upgrade to Spring Java Format 0.0.15 2019-08-30 11:07:04 +01:00
Andy Wilkinson
32c92bf885 Merge branch '1.2.x' 2019-03-26 12:11:10 +00:00
Andy Wilkinson
2dda908c7e Polish "Use HTTPS for externals links where possible"
See gh-611
2019-03-26 12:00:27 +00:00
Spring Operator
cb5d7c2220 Use HTTPS for externals links where possible
See gh-611
2019-03-26 11:59:53 +00:00
Andy Wilkinson
c2c4ed7752 Merge branch '1.1.x' into 1.2.x 2019-03-26 11:45:06 +00:00
Andy Wilkinson
2cfe47a330 Merge branch '1.0.x' into 1.1.x 2019-03-26 10:53:52 +00:00
Andy Wilkinson
447cc4940e Polish "Use HTTPS for external links where possible"
See gh-609
2019-03-26 10:49:19 +00:00
Spring Operator
f2e60ea347 Use HTTPS for external links where possible
See gh-609
2019-03-26 10:28:47 +00:00
Andy Wilkinson
09a4323ed5 Merge branch '1.2.x' 2019-03-19 11:42:23 +00:00
Andy Wilkinson
3282a798cb Merge branch '1.1.x' into 1.2.x 2019-03-19 11:35:06 +00:00
Andy Wilkinson
f7e61013bb Merge branch '1.0.x' into 1.1.x 2019-03-19 11:24:34 +00:00
Andy Wilkinson
75132b537a Use HTTPS to link to Apache license 2019-03-19 11:21:34 +00:00
Andy Wilkinson
df9711ba3a Merge branch '1.2.x' 2019-03-13 09:33:16 +00:00
Andy Wilkinson
874ebba73d Polish "Fix links to ignored() in RequestDocumentation's javadoc"
See gh-595
2019-03-13 09:31:35 +00:00
clydebarrow
2f12c2de6a Fix links to ignored() in RequestDocumentation's javadoc
See gh-595
2019-03-13 09:27:42 +00:00
Andy Wilkinson
c006b062e8 Merge branch '1.2.x' 2018-11-22 12:13:59 +00:00
Andy Wilkinson
71198a402a Maintain formatting during subsection extraction
Closes gh-466
2018-11-22 11:33:34 +00:00
Andy Wilkinson
9851a7cd71 Merge branch '1.2.x' 2018-11-22 11:03:30 +00:00
Andy Wilkinson
9e1ba8a922 Improve beneathPath to work with multiple matches with common structure
Closes gh-473
2018-11-22 11:00:23 +00:00
Andy Wilkinson
1966640520 Only attempt parameter resolution in a test method context
Previously, RestDocumenationExtension would attempt parameter resolution
for any use RestDocumentationContextProvider. Due to the provider
being method-scoped, this could lead to a NullPointerException when
it was resolved in the context of a class.

This commit updates RestDocumentationExtension so that it only supports
parameter resolution for RestDocumentationContextProvider in the context
of a test method.

Closes gh-538
2018-11-21 15:03:48 +00:00
Andy Wilkinson
64ea9c29f5 Polish "Provide a public API for resolving the type of a field"
Closes gh-549
2018-11-21 14:22:20 +00:00
Mathias Düsterhöft
4453fde23c Provide a public API for resolving the type of a field
See gh-549
2018-11-21 14:22:20 +00:00
Andy Wilkinson
ada273ba9e Rework JsonFieldTypeResolver to only discover the field types
See gh-549
2018-11-21 14:22:20 +00:00
Andy Wilkinson
9deae49795 Merge branch '1.2.x' 2018-11-01 07:04:45 +00:00
Andy Wilkinson
e23c6b45d4 Stop flagging documented field beneath option null field as missing
Closes gh-557
2018-11-01 07:03:29 +00:00
Andy Wilkinson
5d4cfb934a Merge branch '1.2.x' 2018-10-03 17:53:39 +01:00
VonUniGE
1456c954ba Correct default output directory in ManualRestDocumentation javadoc
Closes gh-553
2018-10-03 17:52:47 +01:00
Andy Wilkinson
fad2dff977 Merge branch '1.2.x' 2018-08-08 16:51:28 +01:00
Andy Wilkinson
244a734232 Adopt Spring Java Format for code formatting and style 2018-08-08 14:08:15 +01:00
Andy Wilkinson
ceb844183d Merge branch '1.2.x' 2018-08-08 12:27:43 +01:00