Skip to content

Commit

Permalink
Remove any paths that had all their verbs removed.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <dblock@amazon.com>
  • Loading branch information
dblock committed Jul 24, 2024
1 parent 3cadc1b commit 4f9b9b3
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 5 deletions.
4 changes: 3 additions & 1 deletion tools/src/merger/OpenApiVersionExtractor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* compatible open source license.
*/

import _, { extend } from 'lodash'
import _, { extend, isEmpty } from 'lodash'
import { delete_matching_keys, find_refs, write_yaml } from '../helpers'
import { Logger } from '../Logger'
import { type OpenAPIV3 } from 'openapi-types'
Expand Down Expand Up @@ -98,5 +98,7 @@ export default class OpenApiVersionExtractor {
delete_matching_keys(this._spec, (obj) =>
obj.$ref !== undefined && !_.includes(remaining, obj.$ref)
)

this._spec.paths = _.omitBy(this._spec.paths, isEmpty)
}
}
9 changes: 9 additions & 0 deletions tools/tests/merger/fixtures/extractor/expected_2.0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ paths:
$ref: '#/components/responses/nodes.info@200'
'201':
$ref: '#/components/responses/nodes.info@201'
/cluster_manager:
get:
operationId: cluster_manager.0
x-version-added: '2.0'
parameters: []
post:
operationId: cluster_manager.0
x-version-added: '2.0'
parameters: []
/index:
get:
operationId: get.0
Expand Down
9 changes: 9 additions & 0 deletions tools/tests/merger/fixtures/extractor/expected_default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ paths:
$ref: '#/components/responses/nodes.info@200'
'201':
$ref: '#/components/responses/nodes.info@201'
/cluster_manager:
get:
operationId: cluster_manager.0
x-version-added: '2.0'
parameters: []
post:
operationId: cluster_manager.0
x-version-added: '2.0'
parameters: []
/index:
get:
operationId: get.0
Expand Down
1 change: 1 addition & 0 deletions tools/tests/tester/MergedOpenApiSpec.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ describe('merged API spec', () => {
test('paths', () => {
expect(spec.paths()).toEqual({
'/_nodes/{id}': ['get', 'post'],
'/cluster_manager': ['get', 'post'],
'/index': ['get'],
'/nodes': ['get']
})
Expand Down
2 changes: 1 addition & 1 deletion tools/tests/tester/ResultLogger.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ describe('ConsoleResultLogger', () => {

expect(log.mock.calls).toEqual([
[],
['Tested 1/4 paths.']
['Tested 1/6 paths.']
])
})
})
Expand Down
6 changes: 3 additions & 3 deletions tools/tests/tester/TestResults.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ describe('TestResults', () => {
})

test('spec_paths_count', () => {
expect(test_results.spec_paths_count()).toEqual(4)
expect(test_results.spec_paths_count()).toEqual(6)
})

test('write_coverage', () => {
const filename = 'coverage.json'
test_results.write_coverage(filename)
expect(JSON.parse(fs.readFileSync(filename, 'utf8'))).toEqual({
evaluated_paths_count: 1,
evaluated_paths_pct: 25,
paths_count: 4
evaluated_paths_pct: 16.67,
paths_count: 6
})
fs.unlinkSync(filename)
})
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
openapi: 3.1.0
info:
title: OpenSearch API
description: OpenSearch API
version: 1.0.0
paths:
/cluster_manager:
get:
operationId: cluster_manager.0
x-version-added: '2.0'
post:
operationId: cluster_manager.0
x-version-added: '2.0'
components:
requestBodies: []
parameters: []
responses: []

0 comments on commit 4f9b9b3

Please sign in to comment.