/
OASConfig.java
106 lines (90 loc) · 3.35 KB
/
OASConfig.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
/**
* 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;
/**
* Configurable properties in MicroProfile OpenAPI
*/
public final class OASConfig {
private OASConfig() {
}
/**
* Configuration property to specify the fully qualified name of the OASModelReader implementation.
*
* @see org.eclipse.microprofile.openapi.OASModelReader
*/
public static final String MODEL_READER = "mp.openapi.model.reader";
/**
* Configuration property to specify the fully qualified name of the OASFilter implementation.
*
* @see org.eclipse.microprofile.openapi.OASFilter
*/
public static final String FILTER = "mp.openapi.filter";
/**
* Configuration property to disable annotation scanning.
*
*/
public static final String SCAN_DISABLE = "mp.openapi.scan.disable";
/**
* Configuration property to specify the list of packages to scan.
*
*/
public static final String SCAN_PACKAGES = "mp.openapi.scan.packages";
/**
* Configuration property to specify the list of classes to scan.
*
*/
public static final String SCAN_CLASSES = "mp.openapi.scan.classes";
/**
* Configuration property to specify the list of packages to exclude from scans.
*
*/
public static final String SCAN_EXCLUDE_PACKAGES = "mp.openapi.scan.exclude.packages";
/**
* Configuration property to specify the list of classes to exclude from scans.
*
*/
public static final String SCAN_EXCLUDE_CLASSES = "mp.openapi.scan.exclude.classes";
/**
* Configuration property to enable or disable scanning Jakarta Bean Validation annotations
*/
public static final String SCAN_BEANVALIDATION = "mp.openapi.scan.beanvalidation";
/**
* Configuration property to specify the list of global servers that provide connectivity information.
*
*/
public static final String SERVERS = "mp.openapi.servers";
/**
* Prefix of the configuration property to specify an alternative list of servers to service all operations in a
* path.
*
*/
public static final String SERVERS_PATH_PREFIX = "mp.openapi.servers.path.";
/**
* Prefix of the configuration property to specify an alternative list of servers to service an operation.
*
*/
public static final String SERVERS_OPERATION_PREFIX = "mp.openapi.servers.operation.";
/**
* Prefix of the configuration property to specify a schema for a specific class, in JSON format.
*
*/
public static final String SCHEMA_PREFIX = "mp.openapi.schema.";
/**
* Recommended prefix for vendor specific configuration properties.
*
*/
public static final String EXTENSIONS_PREFIX = "mp.openapi.extensions.";
}