From ecfe0c179c67c31ffd14bc297e9545088f1f1553 Mon Sep 17 00:00:00 2001 From: Nolann Biron Date: Mon, 1 Sep 2025 11:03:55 +0200 Subject: [PATCH] Handle OpenAPI ignored responses --- .changeset/shaggy-crabs-return.md | 5 +++++ packages/react-openapi/src/OpenAPIResponseExample.tsx | 8 +++++++- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .changeset/shaggy-crabs-return.md diff --git a/.changeset/shaggy-crabs-return.md b/.changeset/shaggy-crabs-return.md new file mode 100644 index 0000000000..e5c708b897 --- /dev/null +++ b/.changeset/shaggy-crabs-return.md @@ -0,0 +1,5 @@ +--- +'@gitbook/react-openapi': patch +--- + +Handle OpenAPI ignored responses diff --git a/packages/react-openapi/src/OpenAPIResponseExample.tsx b/packages/react-openapi/src/OpenAPIResponseExample.tsx index 79052c63e5..945ace4f16 100644 --- a/packages/react-openapi/src/OpenAPIResponseExample.tsx +++ b/packages/react-openapi/src/OpenAPIResponseExample.tsx @@ -42,7 +42,13 @@ export function OpenAPIResponseExample(props: { }); const tabs = responses - .filter(([_, responseObject]) => responseObject && typeof responseObject === 'object') + .filter( + ([_, responseObject]) => + responseObject && + typeof responseObject === 'object' && + // Make sure the response is not hidden + !responseObject['x-hideSample'] + ) .map(([key, responseObject]) => { const description = resolveDescription(responseObject); const label = description ? (