You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 19, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: spring-auto-restdocs-docs/other.adoc
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,3 +24,15 @@ Preprocessors are available for use in order to improve quality of endpoint exam
24
24
- link:{core-package}/response/ArrayLimitingJsonContentModifier.java[limit JSON array length]: limits all JSON arrays to 3 items
25
25
26
26
For a list of standard preprocessors see link:{restdocs-package}/operation/preprocess/Preprocessors.java[Preprocessors].
27
+
28
+
[[deprecation]]
29
+
=== Deprecation support
30
+
31
+
Endpoint or field will be marked as deprecated if at least one of these is present:
32
+
33
+
- method / field is annotated with `@Deprecated`
34
+
- method's / field's Javadoc has `@deprecated` tag
35
+
36
+
The deprecation is only visible when using <<snippets-section,Section>> approach. Then it will be shown in the title (also visible in
37
+
TOC) and description. Field's deprecation is shown in description column of request/response table.
38
+
See how it looks in the link:https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/spring-auto-restdocs-example/generated-docs/index.html#resources-item-resource-test-clone-item[example project].
0 commit comments