Skip to content

Commit 8cee178

Browse files
docs(feign): fixup formatting after CI/CD fail
1 parent 716ad91 commit 8cee178

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

core/src/main/java/feign/RequestLine.java

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,14 @@
3232

3333
/**
3434
* The HTTP request line, including the method and an optional URI template.
35-
* <p>
36-
* The string must begin with a valid {@linkplain feign.Request.HttpMethod HTTP method name} (e.g.
37-
* {@linkplain feign.Request.HttpMethod#GET GET}, {@linkplain feign.Request.HttpMethod#POST POST},
38-
* {@linkplain feign.Request.HttpMethod#PUT PUT}), followed by a space and a URI template. If only
39-
* the HTTP method is specified (e.g. {@code "DELETE"}), the request will use the base URL defined
40-
* for the client.
4135
*
42-
* <p>
43-
* Example:
36+
* <p>The string must begin with a valid {@linkplain feign.Request.HttpMethod HTTP method name}
37+
* (e.g. {@linkplain feign.Request.HttpMethod#GET GET}, {@linkplain feign.Request.HttpMethod#POST
38+
* POST}, {@linkplain feign.Request.HttpMethod#PUT PUT}), followed by a space and a URI template.
39+
* If only the HTTP method is specified (e.g. {@code "DELETE"}), the request will use the base URL
40+
* defined for the client.
41+
*
42+
* <p>Example:
4443
*
4544
* <pre>{@code @RequestLine("GET /repos/{owner}/{repo}")
4645
* Repo getRepo(@Param("owner") String owner, @Param("repo") String repo);
@@ -55,40 +54,37 @@
5554
* Controls whether percent-encoded forward slashes ({@code %2F}) in expanded path variables are
5655
* decoded back to {@code '/'} before sending the request.
5756
*
58-
* <p>
59-
* When {@code true} (the default), any {@code %2F} sequences produced during URI template
57+
* <p>When {@code true} (the default), any {@code %2F} sequences produced during URI template
6058
* expansion will be replaced with literal slashes, meaning that path variables containing slashes
6159
* will be interpreted as multiple path segments.
6260
*
63-
* <p>
64-
* When {@code false}, percent-encoded slashes ({@code %2F}) are preserved in the final URL. This
65-
* is useful when a path variable intentionally includes a slash as part of its value (for
61+
* <p>When {@code false}, percent-encoded slashes ({@code %2F}) are preserved in the final URL.
62+
* This is useful when a path variable intentionally includes a slash as part of its value (for
6663
* example, an encoded identifier such as {@code "foo%2Fbar"}).
6764
*
68-
* <p>
69-
* Example:
65+
* <p>Example:
7066
*
7167
* <pre>{@code @RequestLine(value = "GET /projects/{id}", decodeSlash = false)
7268
* Project getProject(@Param("id") String encodedId);
7369
* }</pre>
7470
*
7571
* @return {@code true} if encoded slashes should be decoded (default behavior); {@code false} to
76-
* preserve {@code %2F} sequences in the URL.
72+
* preserve {@code %2F} sequences in the URL.
7773
*/
7874
boolean decodeSlash() default true;
7975

8076
/**
8177
* Specifies how collections (e.g. {@link java.util.List List} or arrays) are serialized when
8278
* expanded into the URI template.
83-
* <p>
84-
* Determines whether values are represented as exploded parameters (repeated keys) or as a single
85-
* comma-separated value, depending on the chosen {@link feign.CollectionFormat}.
8679
*
87-
* <p>
88-
* Example:
80+
* <p>Determines whether values are represented as exploded parameters (repeated keys) or as a
81+
* single comma-separated value, depending on the chosen {@link feign.CollectionFormat}.
82+
*
83+
* <p>Example:
84+
*
8985
* <ul>
90-
* <li>{@linkplain CollectionFormat#EXPLODED EXPLODED}: {@code /items?id=1&id=2&id=3}</li>
91-
* <li>{@linkplain CollectionFormat#CSV CSV}: {@code /items?id=1,2,3}</li>
86+
* <li>{@linkplain CollectionFormat#EXPLODED EXPLODED}: {@code /items?id=1&id=2&id=3}
87+
* <li>{@linkplain CollectionFormat#CSV CSV}: {@code /items?id=1,2,3}
9288
* </ul>
9389
*
9490
* @return the collection serialization format to use when expanding templates.

0 commit comments

Comments
 (0)