Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(oas31): fix re-rendering of the Webhooks component #9938

Merged
merged 2 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/core/plugins/oas31/components/webhooks.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*/
import React from "react"
import PropTypes from "prop-types"
import { List } from "immutable"

const Webhooks = ({ specSelectors, getComponent }) => {
const operationDTOs = specSelectors.selectWebhooksOperations()
Expand All @@ -25,7 +26,7 @@ const Webhooks = ({ specSelectors, getComponent }) => {
tag="webhooks"
method={operationDTO.method}
path={pathItemName}
specPath={operationDTO.specPath}
specPath={List(operationDTO.specPath)}
allowTryItOut={false}
/>
))}
Expand Down
2 changes: 1 addition & 1 deletion src/core/plugins/oas31/spec-extensions/selectors.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const selectWebhooksOperations = createSelector(
operation: Map({ operation }),
method,
path: pathItemName,
specPath: List(["webhooks", pathItemName, method]),
specPath: ["webhooks", pathItemName, method],
}))

return allOperations.concat(pathItemOperations)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/**
* @prettier
*/

describe("OpenAPI 3.1.0 webhook", () => {
it("should render the correct example for the request body", () => {
cy.visit("/?url=/documents/features/oas31-webhook-examples.yaml")
.get("#operations-webhooks-test-webhook")
.click()
.get(".body-param__example")
.should("contain", '"userId": "userId example from examples"')
.and("contain", '"orderId": "orderId example from examples"')
.get(".examples-select-element")
.eq(0)
.select("TestExample2")
.get(".body-param__example")
.should("contain", '"userId": "second userId example from examples"')
.and("contain", '"orderId": "second orderId example from examples"')
})

it("should render the correct example for the response", () => {
cy.visit("/?url=/documents/features/oas31-webhook-examples.yaml")
.get("#operations-webhooks-test-webhook")
.click()
.get(".example.microlight")
.should("contain", '"userId": "userId example from examples"')
.and("contain", '"orderId": "orderId example from examples"')
.get(".examples-select-element")
.eq(1)
.select("TestExample2")
.get(".example.microlight")
.should("contain", '"userId": "second userId example from examples"')
.and("contain", '"orderId": "second orderId example from examples"')
})
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
openapi: 3.1.0
info:
version: 1.0.0
title: Examples
description: ''
webhooks:
test-webhook:
post:
operationId: test-webhook
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TestSchema'
examples:
TestExample1:
$ref: '#/components/examples/TestExample1'
TestExample2:
$ref: '#/components/examples/TestExample2'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestSchema'
examples:
TestExample1:
$ref: '#/components/examples/TestExample1'
TestExample2:
$ref: '#/components/examples/TestExample2'
components:
schemas:
TestSchema:
type: object
properties:
userId:
type: string
examples: ['userId example from schema']
orders:
type: array
items:
type: object
properties:
orderId:
type: string
examples: ['orderId example from schema']
examples:
TestExample1:
value:
userId: 'userId example from examples'
orders:
- orderId: 'orderId example from examples'
TestExample2:
value:
userId: 'second userId example from examples'
orders:
- orderId: 'second orderId example from examples'