Skip to content

fix: ignore rendering responses with extensions in the schema #10592

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Oct 8, 2025
Merged

fix: ignore rendering responses with extensions in the schema #10592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9cef89a
fix: ignore rendering responses with extensions in the schema
DarkMatter-999 Oct 7, 2025
35058b7
feat: add `isExtension` util function
DarkMatter-999 Oct 7, 2025
20edf59
fix: avoid rendering empty table if only extensions are present
DarkMatter-999 Oct 7, 2025
1478cbc
refactor: update `getExtensions` function to use `isExtension`
DarkMatter-999 Oct 7, 2025
bfb4f4e
Merge branch 'master' into fix/ignore-extensions
robert-hebel-sb Oct 7, 2025
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
7 changes: 4 additions & 3 deletions src/core/components/responses.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React from "react"
import { fromJS, Iterable } from "immutable"
import PropTypes from "prop-types"
import ImPropTypes from "react-immutable-proptypes"
import { defaultStatusCode, getAcceptControllingResponse } from "core/utils"
import { defaultStatusCode, getAcceptControllingResponse, isExtension } from "core/utils"
import createHtmlReadyId from "core/utils/create-html-ready-id"

export default class Responses extends React.Component {
Expand Down Expand Up @@ -87,10 +87,11 @@ export default class Responses extends React.Component {
const acceptControllingResponse = isSpecOAS3 ?
getAcceptControllingResponse(responses) : null

const nonExtensionResponses = responses.filter((_, key) => !isExtension(key))
const regionId = createHtmlReadyId(`${method}${path}_responses`)
const controlId = `${regionId}_select`

return (
return (!nonExtensionResponses || !nonExtensionResponses.size) ? null : (
<div className="responses-wrapper">
<div className="opblock-section-header">
<h4>Responses</h4>
Expand Down Expand Up @@ -131,7 +132,7 @@ export default class Responses extends React.Component {
</thead>
<tbody>
{
responses.entrySeq().map( ([code, response]) => {
nonExtensionResponses.entrySeq().map( ([code, response]) => {

let className = tryItOutResponse && tryItOutResponse.get("status") == code ? "response_current" : ""
return (
Expand Down
10 changes: 7 additions & 3 deletions src/core/utils/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,12 +704,16 @@ export const createDeepLinkPath = (str) => typeof str == "string" || str instanc
// suitable for use in CSS classes and ids
export const escapeDeepLinkPath = (str) => cssEscape( createDeepLinkPath(str).replace(/%20/g, "_") )

export const getExtensions = (defObj) => {
export const isExtension = (key) => {
const extensionRegExp = /^x-/
return extensionRegExp.test(key)
}

export const getExtensions = (defObj) => {
if(Map.isMap(defObj)) {
return defObj.filter((v, k) => extensionRegExp.test(k))
return defObj.filter((v, k) => isExtension(k))
}
return Object.keys(defObj).filter((key) => extensionRegExp.test(key))
return Object.keys(defObj).filter((key) => isExtension(key))
}
export const getCommonExtensions = (defObj) => defObj.filter((v, k) => /^pattern|maxLength|minLength|maximum|minimum/.test(k))

Expand Down