/
Components.java
120 lines (105 loc) · 3.65 KB
/
Components.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.eclipse.microprofile.openapi.annotations;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.eclipse.microprofile.openapi.annotations.callbacks.Callback;
import org.eclipse.microprofile.openapi.annotations.extensions.Extension;
import org.eclipse.microprofile.openapi.annotations.headers.Header;
import org.eclipse.microprofile.openapi.annotations.links.Link;
import org.eclipse.microprofile.openapi.annotations.media.ExampleObject;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
import org.eclipse.microprofile.openapi.annotations.security.SecurityScheme;
/**
* Describes the Components object that holds various reusable objects for different aspects of the OpenAPI
* Specification (OAS).
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#componentsObject"> OpenAPI
* Specification Components Object</a>
*/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Components {
/**
* An object to hold reusable Schema Objects.
*
* @return the reusable Schema objects.
*/
Schema[] schemas() default {};
/**
* An object to hold reusable Response Objects.
*
* @return the reusable ApiResponse objects.
*/
APIResponse[] responses() default {};
/**
* An object to hold reusable Parameter Objects.
*
* @return the reusable Parameter objects.
*/
Parameter[] parameters() default {};
/**
* An object to hold reusable Example Objects.
*
* @return the reusable Example objects.
*/
ExampleObject[] examples() default {};
/**
* An object to hold reusable Request Body Objects.
*
* @return the reusable RequestBody objects.
*/
RequestBody[] requestBodies() default {};
/**
* An object to hold reusable Header Objects.
*
* @return the reusable Header objects.
*/
Header[] headers() default {};
/**
* An object to hold reusable Security Scheme Objects.
*
* @return the reusable SecurityScheme objects.
*/
SecurityScheme[] securitySchemes() default {};
/**
* An object to hold reusable Link Objects.
*
* @return the reusable Link objects.
*/
Link[] links() default {};
/**
* An object to hold reusable Callback Objects.
*
* @return the reusable Callback objects.
*/
Callback[] callbacks() default {};
/**
* List of extensions to be added to the {@link org.eclipse.microprofile.openapi.models.Components Components} model
* corresponding to the containing annotation.
*
* @return array of extensions
*
* @since 3.1
*/
Extension[] extensions() default {};
}