/
Info.java
86 lines (76 loc) · 2.39 KB
/
Info.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
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* Copyright 2017 SmartBear Software
* <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.info;
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.extensions.Extension;
/**
* This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#infoObject"
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Info {
/**
* The title of the application.
*
* @return the application's title
**/
String title();
/**
* A short description of the application. CommonMark syntax can be used for rich text representation.
*
* @return the application's description
**/
String description() default "";
/**
* A URL to the Terms of Service for the API. Must be in the format of a URL.
*
* @return the application's terms of service
**/
String termsOfService() default "";
/**
* The contact information for the exposed API.
*
* @return a contact for the application
**/
Contact contact() default @Contact();
/**
* The license information for the exposed API.
*
* @return the license of the application
**/
License license() default @License(name = "");
/**
* The version of the API definition.
*
* @return the application's version
**/
String version();
/**
* The list of optional extensions.
*
* @return an optional array of extensions
*
* @since 3.1
*/
Extension[] extensions() default {};
}