/
ExternalDocumentation.java
69 lines (62 loc) · 2.47 KB
/
ExternalDocumentation.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
/**
* 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;
import java.lang.annotation.ElementType;
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 allows referencing an external resource for extended documentation.
* <p>
* When it is applied to a method the value of the annotation is added to the corresponding OpenAPI operation
* definition.
* <p>
* When it is applied to a type and one or more of the fields are not empty strings the annotation value is added to the
* OpenAPI document root. If more than one non-empty annotation is applied to a type in the application or if the
* externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined.
*
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#external-documentation-object">OpenAPI Specification
* External Documentation Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExternalDocumentation {
/**
* A short description of the target documentation.
*
* @return the documentation description
**/
String description() default "";
/**
* The URL for the target documentation. Value must be in the format of a URL.
*
* @return the documentation URL
**/
String url() default "";
/**
* List of extensions to be added to the {@link org.eclipse.microprofile.openapi.models.ExternalDocumentation
* ExternalDocumentation} model corresponding to the containing annotation.
*
* @return array of extensions
*
* @since 3.1
*/
Extension[] extensions() default {};
}