Skip to content

Commit

Permalink
fix(callbacks): display all defined callbacks (#9223)
Browse files Browse the repository at this point in the history
Refs #9222
  • Loading branch information
char0n authored Sep 18, 2023
1 parent 23f6645 commit 0144dad
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 14 deletions.
33 changes: 19 additions & 14 deletions src/core/plugins/oas3/spec-extensions/selectors.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,27 @@ export const callbacksOperations = onlyOAS3(
.reduce((allOperations, callback, callbackName) => {
if (!Map.isMap(callback)) return allOperations

return callback.reduce((callbackOperations, pathItem, expression) => {
if (!Map.isMap(pathItem)) return callbackOperations
const callbackOperations = callback.reduce(
(callbackOps, pathItem, expression) => {
if (!Map.isMap(pathItem)) return callbackOps

const pathItemOperations = pathItem
.entrySeq()
.filter(([key]) => validOperationMethods.includes(key))
.map(([method, operation]) => ({
operation: Map({ operation }),
method,
path: expression,
callbackName,
specPath: specPath.concat([callbackName, expression, method]),
}))
const pathItemOperations = pathItem
.entrySeq()
.filter(([key]) => validOperationMethods.includes(key))
.map(([method, operation]) => ({
operation: Map({ operation }),
method,
path: expression,
callbackName,
specPath: specPath.concat([callbackName, expression, method]),
}))

return callbackOperations.concat(pathItemOperations)
}, List())
return callbackOps.concat(pathItemOperations)
},
List()
)

return allOperations.concat(callbackOperations)
}, List())
.groupBy((operationDTO) => operationDTO.callbackName)
.map((operations) => operations.toArray())
Expand Down
19 changes: 19 additions & 0 deletions test/e2e-cypress/e2e/features/oas3-callbacks.cy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/**
* Related to // https://github.com/swagger-api/swagger-ui/issues/9222.
*/

describe("OpenAPI 3.0 Callbacks", () => {
it("should render all defined callbacks", () => {
cy.visit(
"/?url=/documents/features/oas3-callbacks.yaml"
)
.get("#operations-Device-register")
.click()
.get(".opblock-section-header .tab-item.false")
.click()
.get("#operations-callbacks-callbackOne")
.should("be.visible")
.get("#operations-callbacks-callbackTwo")
.should("be.visible")
})
})
41 changes: 41 additions & 0 deletions test/e2e-cypress/static/documents/features/oas3-callbacks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
openapi: 3.0.0
servers: []
info:
version: "1.0.0"
title: home-iot-api
description: The API
paths:
/devices:
get:
callbacks:
callbackOne:
'callbackOne':
get:
operationId: callbackOne
responses:
'200':
$ref: '#/components/schemas/ApiResponse'
callbackTwo:
'callbackTwo':
get:
operationId: callbackTwo
responses:
'200':
$ref: '#/components/schemas/ApiResponse'
tags:
- Device
operationId: register
responses:
'200':
description: successfully registered device
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
example: everything is ok

0 comments on commit 0144dad

Please sign in to comment.