-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.json
183 lines (183 loc) · 7.33 KB
/
openapi.json
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
{
"openapi": "3.1.0",
"info": {
"title": "Attribute Name Analyzer",
"description": "This document describes schemas for the input to, output from the attribute-name-validator(anv) package. No `paths` are defined in this document because this application is not a REST API, it is a python library and command line interface (CLI)."
},
"components": {
"schemas": {
"catalog_document": {
"description": "The root document for the catalog ",
"properties": {
"class_word_abbreviations": {
"$ref": "#/components/schemas/class_word_abbreviations"
},
"class_words": {
"$ref": "#/components/schemas/class_words"
},
"acronyms": {
"$ref": "#/components/schemas/acronyms"
},
"aggregates": {
"$ref": "#/components/schemas/aggregates"
}
},
"type": "object"
},
"class_words": {
"description": "A collection of class words.",
"additionalProperties": {
"$ref": "#/components/schemas/class_word"
},
"type": "object"
},
"class_word": {
"description": "Information about a class word.",
"properties": {},
"type": "object"
},
"class_word_abbreviations": {
"description": "A dictionary mapping abbreviated class words to class words and usage information about each.",
"additionalProperties": {
"$ref": "#/components/schemas/class_word_abbreviation"
},
"type": "object"
},
"class_word_abbreviation": {
"description": "Information about a class word.",
"properties": {
"abbreviation": {
"type": "string"
},
"class_word": {
"type": "string"
},
"sample_usage": {
"type": "string"
},
"when_to_use": {
"type": "string"
}
},
"type": "object"
},
"acronyms": {
"description": "A mapping of ACRONYMS to a list of phrases which they are approved to be used for.",
"additionalProperties": {
"$ref": "#/components/schemas/phrases"
},
"type": "object"
},
"phrases": {
"description": "One or more phrases acronym to be used for",
"items": {
"type": "string"
},
"type": "array"
},
"aggregates": {
"description": "A mapping of aggregate acronyms to its usage",
"additionalProperties": {
"$ref": "#/components/schemas/aggregate"
},
"type": "object"
},
"aggregate": {
"description": "One or more phrases acronym to be used for",
"properties": {
"phrase": {
"type": "string"
},
"sample_usage": {
"type": "string"
},
"when_to_use": {
"type": "string"
}
},
"type": "object"
},
"class_word_analysis_report": {
"description": "A mapping of ACRONYMS to a list of phrases which they are approved to be used for.",
"additionalProperties": {
"$ref": "#/components/schemas/column_name_class_word_analysis"
},
"type": "object"
},
"column_name_class_word_analysis": {
"description": "Class word analysis of an column name.",
"items": {
"$ref": "#/components/schemas/column_name_class_word_analysis_unit"
},
"type": "array"
},
"used_abbreviations": {
"description": "This object records data pertaining to all instances of the usage of all approved abbreviations, and the abbreviation's approved usages. This is for ensuring they are used only for approved usages.",
"additionalProperties": {
"$ref": "#/components/schemas/used_abbreviation"
},
"type": "object"
},
"used_abbreviation": {
"description": "This object records data pertaining to all instances of the usage of an approved abbreviation, and the abbreviation's approved usages ",
"properties": {
"column_names": {
"items": {
"type": "string"
},
"type": "array"
},
"allowed_usages": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"column_name_class_word_analysis_unit": {
"description": "Class Word Analysis Instance",
"properties": {
"column_name": {
"type": "string"
},
"word": {
"type": "string"
},
"analysis": {
"enum": [
"ABBREVIATED CLASS WORD IS USED IN THE MIDDLE",
"FULL CLASS WORD IS USED IN THE MIDDLE",
"FULL CLASS WORD IS USED AT THE END",
"APPROVED ACRONYM IS USED AT THE END",
"GENERIC WORD USED AT THE END",
"ABBREVIATED CLASS WORD IS USED AT THE END",
"CLASS WORD IS USED AS COLUMN NAME",
"UNIT SPECIFIC CLASS WORD MAY BE NEEDED AT THE END",
"AGGREGATE ACRONYM IS USED AT THE END",
"AGGREGATE ACRONYM IS USED IN THE MIDDLE",
"NO CLASS WORD IS USED IN THE NAME"
],
"type": "string"
},
"class_word_rules_followed": {
"enum": [
"YES",
"NO",
"MAY BE"
],
"type": "string"
},
"additional_notes": {
"type": "string"
},
"when_to_use": {
"type": "string"
}
},
"type": "object"
}
}
}
}