Ether Framework
Unified API docs for Ether modules
Loading...
Searching...
No Matches
OpenApiResponse.java
Go to the documentation of this file.
1
package
dev.rafex.ether.http.openapi.model;
2
3
/*-
4
* #%L
5
* ether-http-openapi
6
* %%
7
* Copyright (C) 2025 - 2026 Raúl Eduardo González Argote
8
* %%
9
* Permission is hereby granted, free of charge, to any person obtaining a copy
10
* of this software and associated documentation files (the "Software"), to deal
11
* in the Software without restriction, including without limitation the rights
12
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
* copies of the Software, and to permit persons to whom the Software is
14
* furnished to do so, subject to the following conditions:
15
*
16
* The above copyright notice and this permission notice shall be included in
17
* all copies or substantial portions of the Software.
18
*
19
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25
* THE SOFTWARE.
26
* #L%
27
*/
28
29
import
java.util.Map;
30
31
public
record
OpenApiResponse
(String description, Map<String, OpenApiMediaType> content) {
32
33
public
OpenApiResponse
{
34
content = content ==
null
? Map.of() : Map.copyOf(content);
35
}
36
37
public
static
OpenApiResponse
ok(
final
String description,
final
OpenApiSchema
schema) {
38
return
new
OpenApiResponse
(description, Map.of(
"application/json"
,
new
OpenApiMediaType
(schema,
null
)));
39
}
40
}
dev.rafex.ether.http.openapi.model.OpenApiSchema
record OpenApiSchema(String type, String format, String description, boolean nullable, Object example, String ref, Map< String, OpenApiSchema > properties, List< String > required, OpenApiSchema items)
Definition
OpenApiSchema.java:32
dev.rafex.ether.http.openapi.model.OpenApiResponse
record OpenApiResponse(String description, Map< String, OpenApiMediaType > content)
Definition
OpenApiResponse.java:31
dev.rafex.ether.http.openapi.model.OpenApiMediaType
record OpenApiMediaType(OpenApiSchema schema, Object example)
Definition
OpenApiMediaType.java:29
Generated by
1.16.1