|
3 | 3 | * *
|
4 | 4 | * * *
|
5 | 5 | * * * *
|
6 |
| - * * * * * Copyright 2019-2024 the original author or authors. |
7 | 6 | * * * * *
|
8 |
| - * * * * * Licensed under the Apache License, Version 2.0 (the "License"); |
9 |
| - * * * * * you may not use this file except in compliance with the License. |
10 |
| - * * * * * You may obtain a copy of the License at |
| 7 | + * * * * * * Copyright 2019-2024 the original author or authors. |
| 8 | + * * * * * * |
| 9 | + * * * * * * Licensed under the Apache License, Version 2.0 (the "License"); |
| 10 | + * * * * * * you may not use this file except in compliance with the License. |
| 11 | + * * * * * * You may obtain a copy of the License at |
| 12 | + * * * * * * |
| 13 | + * * * * * * https://www.apache.org/licenses/LICENSE-2.0 |
| 14 | + * * * * * * |
| 15 | + * * * * * * Unless required by applicable law or agreed to in writing, software |
| 16 | + * * * * * * distributed under the License is distributed on an "AS IS" BASIS, |
| 17 | + * * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 18 | + * * * * * * See the License for the specific language governing permissions and |
| 19 | + * * * * * * limitations under the License. |
11 | 20 | * * * * *
|
12 |
| - * * * * * https://www.apache.org/licenses/LICENSE-2.0 |
13 |
| - * * * * * |
14 |
| - * * * * * Unless required by applicable law or agreed to in writing, software |
15 |
| - * * * * * distributed under the License is distributed on an "AS IS" BASIS, |
16 |
| - * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
17 |
| - * * * * * See the License for the specific language governing permissions and |
18 |
| - * * * * * limitations under the License. |
19 | 21 | * * * *
|
20 | 22 | * * *
|
21 | 23 | * *
|
22 |
| - * |
| 24 | + * |
23 | 25 | */
|
24 | 26 |
|
25 | 27 | package org.springdoc.core.annotations;
|
|
48 | 50 | /**
|
49 | 51 | * The path mapping URIs (e.g. {@code "/profile"}).
|
50 | 52 | * Path mapping URIs may contain placeholders (e.g. <code>"/${profile_path}"</code>).
|
| 53 | + * |
51 | 54 | * @return the string
|
52 | 55 | */
|
53 | 56 | String path() default "";
|
54 | 57 |
|
55 | 58 | /**
|
56 | 59 | * The HTTP request methods to map to, narrowing the primary mapping:
|
57 | 60 | * GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.
|
| 61 | + * |
58 | 62 | * @return the request method [ ]
|
59 | 63 | */
|
60 | 64 | RequestMethod[] method() default {};
|
|
68 | 72 | * consumes = {"text/plain", "application/*"}
|
69 | 73 | * consumes = MediaType.TEXT_PLAIN_VALUE
|
70 | 74 | * </pre>
|
| 75 | + * |
71 | 76 | * @return the string [ ]
|
72 | 77 | */
|
73 | 78 | String[] consumes() default {};
|
|
84 | 89 | * produces = MediaType.TEXT_PLAIN_VALUE
|
85 | 90 | * produces = "text/plain;charset=UTF-8"
|
86 | 91 | * </pre>
|
| 92 | + * |
87 | 93 | * @return the string [ ]
|
88 | 94 | */
|
89 | 95 | String[] produces() default {};
|
|
93 | 99 | * <p>Same format for any environment: a sequence of "My-Header=myValue" style
|
94 | 100 | * expressions, with a request only mapped if each such header is found
|
95 | 101 | * to have the given value.
|
| 102 | + * |
96 | 103 | * @return the string [ ]
|
97 | 104 | */
|
98 | 105 | String[] headers() default {};
|
|
101 | 108 | * The parameters of the mapped request, narrowing the primary mapping.
|
102 | 109 | * Same format for any environment: a sequence of "myParam=myValue" style expressions,
|
103 | 110 | * with a request only mapped if each such parameter is found to have the given value.
|
| 111 | + * |
104 | 112 | * @return the string [ ]
|
105 | 113 | */
|
106 | 114 | String[] params() default {};
|
107 | 115 |
|
108 | 116 | /**
|
109 | 117 | * The class of the Handler bean.
|
| 118 | + * |
110 | 119 | * @return the class of the Bean
|
111 | 120 | */
|
112 | 121 | Class<?> beanClass() default Void.class;
|
113 | 122 |
|
114 | 123 | /**
|
115 | 124 | * The method of the handler Bean.
|
| 125 | + * |
116 | 126 | * @return The method of the handler Bean.
|
117 | 127 | */
|
118 | 128 | String beanMethod() default "";
|
119 | 129 |
|
120 | 130 | /**
|
121 | 131 | * The parameters of the handler method.
|
| 132 | + * |
122 | 133 | * @return The parameters of the handler method.
|
123 | 134 | */
|
124 | 135 | Class<?>[] parameterTypes() default {};
|
125 | 136 |
|
126 | 137 | /**
|
127 | 138 | * The swagger operation description
|
128 | 139 | * Alias for {@link Operation}.
|
| 140 | + * |
129 | 141 | * @return The operation
|
130 | 142 | */
|
131 | 143 | Operation operation() default @Operation();
|
|
0 commit comments