Skip to content

Commit 50c3258

Browse files
dblockdblock
committed
Normalize fields.
 .replaceAll('::', '___') .replaceAll('@', '__') .replaceAll(':', '_') Signed-off-by: dblock <[email protected]>
1 parent acf7788 commit 50c3258

File tree

6 files changed

+88
-87
lines changed

6 files changed

+88
-87
lines changed

‎tools/src/linter/SchemasValidator.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ export default class SchemasValidator {
6161
const message = this.json_validator.validate_schema(param.schema)
6262
if (message == null) return
6363

64-
const namespace = this.group_to_namespace(key.split('__')[0])
64+
const namespace = this.group_to_namespace(key.split('___')[0])
6565
const file = namespace === '_global' ? '_global_parameters.yaml' : `namespaces/${namespace}.yaml`
66-
const location = namespace === '_global' ? param.name as string : `#/components/parameters/${key}`.replace('__', '::')
66+
const location = namespace === '_global' ? param.name as string : `#/components/parameters/${key}`.replace('___', '::')
6767
return this.error(file, location, message)
6868
}).filter((error) => error != null) as ValidationError[]
6969
}
@@ -78,9 +78,9 @@ export default class SchemasValidator {
7878

7979
validate_response_schemas (): ValidationError[] {
8080
return Object.entries(this.spec.responses as Record<string, any>).flatMap(([key, response]) => {
81-
const namespace = this.group_to_namespace(key.split('.')[0])
81+
const namespace = this.group_to_namespace(key.split('__')[0])
8282
const file = `namespaces/${namespace}.yaml`
83-
const location = `#/components/responses/${key}`.replace('.', '@')
83+
const location = `#/components/responses/${key}`.replace('__', '@')
8484
const content = response.content as Record<string, any>
8585
return this.validate_content_schemas(file, location, content)
8686
})

‎tools/src/merger/OpenApiMerger.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ export default class OpenApiMerger {
154154

155155
#normalize_key(key: string): string {
156156
return key
157-
.replaceAll('@', '.')
157+
.replaceAll('::', '___')
158+
.replaceAll('@', '__')
158159
.replaceAll(':', '_')
159160
}
160161

‎tools/tests/merger/fixtures/extractor/opensearch/expected_1.3.yaml

+23-23
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,33 @@ paths:
1212
x-version-added: '1.0'
1313
description: Returns information about nodes in the cluster.
1414
parameters:
15-
- $ref: '#/components/parameters/nodes.info__path.id'
15+
- $ref: '#/components/parameters/nodes.info___path.id'
1616
responses:
1717
'200':
18-
$ref: '#/components/responses/nodes.info.200'
18+
$ref: '#/components/responses/nodes.info__200'
1919
/index:
2020
get:
2121
operationId: get.0
2222
responses:
2323
'200':
24-
$ref: '#/components/responses/info.200'
24+
$ref: '#/components/responses/info__200'
2525
'201':
26-
$ref: '#/components/responses/info.201'
26+
$ref: '#/components/responses/info__201'
2727
'404':
28-
$ref: '#/components/responses/info.404'
28+
$ref: '#/components/responses/info__404'
2929
'500':
30-
$ref: '#/components/responses/info.500'
30+
$ref: '#/components/responses/info__500'
3131
'503':
32-
$ref: '#/components/responses/info.503'
32+
$ref: '#/components/responses/info__503'
3333
removed-2.0:
34-
$ref: '#/components/responses/info.removed-2.0'
34+
$ref: '#/components/responses/info__removed-2.0'
3535
x-version-removed: '2.0'
3636
removed-2.0-refs:
37-
$ref: '#/components/responses/info.removed-2.0-refs'
37+
$ref: '#/components/responses/info__removed-2.0-refs'
3838
added-1.3-removed-2.0:
39-
$ref: '#/components/responses/info.added-1.3-removed-2.0'
39+
$ref: '#/components/responses/info__added-1.3-removed-2.0'
4040
distributed-excluded-amazon-serverless:
41-
$ref: '#/components/responses/info.distributed-all'
41+
$ref: '#/components/responses/info__distributed-all'
4242
x-distributions-excluded:
4343
- amazon-serverless
4444
parameters: []
@@ -47,11 +47,11 @@ paths:
4747
operationId: nodes.0
4848
responses:
4949
'200':
50-
$ref: '#/components/responses/nodes.info.200'
50+
$ref: '#/components/responses/nodes.info__200'
5151
parameters: []
5252
components:
5353
parameters:
54-
nodes.info__path.id:
54+
nodes.info___path.id:
5555
in: path
5656
name: id
5757
description: Node ID.
@@ -60,7 +60,7 @@ components:
6060
type: string
6161
requestBodies: {}
6262
responses:
63-
info.200:
63+
info__200:
6464
content:
6565
application/json:
6666
schema:
@@ -73,7 +73,7 @@ components:
7373
required:
7474
- tagline
7575
description: ''
76-
info.201:
76+
info__201:
7777
content:
7878
application/json:
7979
schema:
@@ -85,7 +85,7 @@ components:
8585
- tagline
8686
unevaluatedProperties: true
8787
description: ''
88-
info.404:
88+
info__404:
8989
content:
9090
application/json:
9191
schema:
@@ -98,7 +98,7 @@ components:
9898
unevaluatedProperties:
9999
type: object
100100
description: ''
101-
info.500:
101+
info__500:
102102
content:
103103
application/json:
104104
schema:
@@ -107,27 +107,27 @@ components:
107107
tagline:
108108
type: string
109109
description: ''
110-
info.503:
110+
info__503:
111111
content:
112112
application/json:
113113
schema:
114114
type: object
115115
description: ''
116-
info.added-1.3-removed-2.0:
116+
info__added-1.3-removed-2.0:
117117
description: Added in 1.3, removed in 2.0 via attribute in response body.
118118
x-version-added: '1.3'
119119
x-version-removed: '2.0'
120-
info.distributed-all:
120+
info__distributed-all:
121121
description: Distributed in opensearch.org, AOS and AOSS.
122-
info.removed-2.0:
122+
info__removed-2.0:
123123
description: Removed in 2.0 via attribute next to ref.
124-
info.removed-2.0-refs:
124+
info__removed-2.0-refs:
125125
description: One of the ref values removed in 2.0.
126126
schema:
127127
oneOf:
128128
- $ref: '#/components/schemas/_common_Type'
129129
- $ref: '#/components/schemas/_common_OldId'
130-
nodes.info.200:
130+
nodes.info__200:
131131
description: All nodes.
132132
content:
133133
application/json:

‎tools/tests/merger/fixtures/extractor/opensearch/expected_2.0.yaml

+27-27
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ paths:
1212
x-version-added: '1.0'
1313
description: Returns information about nodes in the cluster.
1414
parameters:
15-
- $ref: '#/components/parameters/nodes.info__path.id'
15+
- $ref: '#/components/parameters/nodes.info___path.id'
1616
responses:
1717
'200':
18-
$ref: '#/components/responses/nodes.info.200'
18+
$ref: '#/components/responses/nodes.info__200'
1919
post:
2020
operationId: nodes.info.1
2121
x-operation-group: nodes.info
2222
x-version-added: '2.0'
2323
description: Returns information about nodes in the cluster.
2424
parameters:
25-
- $ref: '#/components/parameters/nodes.info__path.id'
26-
- $ref: '#/components/parameters/nodes.info__query.flag'
25+
- $ref: '#/components/parameters/nodes.info___path.id'
26+
- $ref: '#/components/parameters/nodes.info___query.flag'
2727
requestBody:
2828
$ref: '#/components/requestBodies/nodes.info'
2929
responses:
3030
'200':
31-
$ref: '#/components/responses/nodes.info.200'
31+
$ref: '#/components/responses/nodes.info__200'
3232
'201':
33-
$ref: '#/components/responses/nodes.info.201'
33+
$ref: '#/components/responses/nodes.info__201'
3434
/cluster_manager:
3535
get:
3636
operationId: cluster_manager.0
@@ -45,22 +45,22 @@ paths:
4545
operationId: get.0
4646
responses:
4747
'200':
48-
$ref: '#/components/responses/info.200'
48+
$ref: '#/components/responses/info__200'
4949
'201':
50-
$ref: '#/components/responses/info.201'
50+
$ref: '#/components/responses/info__201'
5151
'404':
52-
$ref: '#/components/responses/info.404'
52+
$ref: '#/components/responses/info__404'
5353
'500':
54-
$ref: '#/components/responses/info.500'
54+
$ref: '#/components/responses/info__500'
5555
'503':
56-
$ref: '#/components/responses/info.503'
56+
$ref: '#/components/responses/info__503'
5757
added-2.0:
58-
$ref: '#/components/responses/info.added-2.0'
58+
$ref: '#/components/responses/info__added-2.0'
5959
x-version-added: '2.0'
6060
removed-2.0-refs:
61-
$ref: '#/components/responses/info.removed-2.0-refs'
61+
$ref: '#/components/responses/info__removed-2.0-refs'
6262
distributed-excluded-amazon-serverless:
63-
$ref: '#/components/responses/info.distributed-all'
63+
$ref: '#/components/responses/info__distributed-all'
6464
x-distributions-excluded:
6565
- amazon-serverless
6666
parameters: []
@@ -69,18 +69,18 @@ paths:
6969
operationId: nodes.0
7070
responses:
7171
'200':
72-
$ref: '#/components/responses/nodes.info.200'
72+
$ref: '#/components/responses/nodes.info__200'
7373
parameters: []
7474
components:
7575
parameters:
76-
nodes.info__path.id:
76+
nodes.info___path.id:
7777
in: path
7878
name: id
7979
description: Node ID.
8080
required: true
8181
schema:
8282
type: string
83-
nodes.info__query.flag:
83+
nodes.info___query.flag:
8484
in: query
8585
name: flag
8686
description: Flag.
@@ -102,7 +102,7 @@ components:
102102
x-version-added: '2.0'
103103
description: Nodes options.
104104
responses:
105-
info.200:
105+
info__200:
106106
content:
107107
application/json:
108108
schema:
@@ -113,7 +113,7 @@ components:
113113
required:
114114
- tagline
115115
description: ''
116-
info.201:
116+
info__201:
117117
content:
118118
application/json:
119119
schema:
@@ -125,7 +125,7 @@ components:
125125
- tagline
126126
unevaluatedProperties: true
127127
description: ''
128-
info.404:
128+
info__404:
129129
content:
130130
application/json:
131131
schema:
@@ -138,7 +138,7 @@ components:
138138
unevaluatedProperties:
139139
type: object
140140
description: ''
141-
info.500:
141+
info__500:
142142
content:
143143
application/json:
144144
schema:
@@ -147,28 +147,28 @@ components:
147147
tagline:
148148
type: string
149149
description: ''
150-
info.503:
150+
info__503:
151151
content:
152152
application/json:
153153
schema:
154154
type: object
155155
description: ''
156-
info.added-2.0:
156+
info__added-2.0:
157157
description: Added in 2.0 via attribute next to ref.
158-
info.distributed-all:
158+
info__distributed-all:
159159
description: Distributed in opensearch.org, AOS and AOSS.
160-
info.removed-2.0-refs:
160+
info__removed-2.0-refs:
161161
description: One of the ref values removed in 2.0.
162162
schema:
163163
oneOf:
164164
- $ref: '#/components/schemas/_common_OldId'
165-
nodes.info.200:
165+
nodes.info__200:
166166
description: All nodes.
167167
content:
168168
application/json:
169169
schema:
170170
type: object
171-
nodes.info.201:
171+
nodes.info__201:
172172
description: All nodes.
173173
content:
174174
application/json:

0 commit comments

Comments
 (0)