Handle OpenAPI ignored responses

Author: nolannbiron

.changeset/shaggy-crabs-return.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/openapi-parser': patch
+'@gitbook/react-openapi': patch
+---
+
+Handle OpenAPI ignored responses

packages/openapi-parser/src/helpers/shouldIgnoreEntity.ts

@@ -4,7 +4,7 @@ import type { OpenAPIV3 } from '@scalar/openapi-types';
  * Check if an entity should be ignored
  */
 export function shouldIgnoreEntity(
-    data: undefined | OpenAPIV3.TagObject | OpenAPIV3.OperationObject
+    data: undefined | OpenAPIV3.TagObject | OpenAPIV3.OperationObject | OpenAPIV3.ResponseObject
 ) {
     return data?.['x-internal'] === true || data?.['x-gitbook-ignore'] === true;
 }

packages/react-openapi/src/OpenAPIResponseExample.tsx

@@ -1,4 +1,4 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
+import { type OpenAPIV3, shouldIgnoreEntity } from '@gitbook/openapi-parser';
 import { Markdown } from './Markdown';
 import { OpenAPIEmptyExample, OpenAPIExample } from './OpenAPIExample';
 import { OpenAPIMediaTypeContent } from './OpenAPIMediaType';
@@ -42,7 +42,12 @@ export function OpenAPIResponseExample(props: {
     });
 
     const tabs = responses
-        .filter(([_, responseObject]) => responseObject && typeof responseObject === 'object')
+        .filter(
+            ([_, responseObject]) =>
+                responseObject &&
+                typeof responseObject === 'object' &&
+                !shouldIgnoreEntity(responseObject)
+        )
         .map(([key, responseObject]) => {
             const description = resolveDescription(responseObject);
             const label = description ? (

packages/react-openapi/src/OpenAPIResponses.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-import type { OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
+import { type OpenAPIV3, type OpenAPIV3_1, shouldIgnoreEntity } from '@gitbook/openapi-parser';
 import clsx from 'clsx';
 import { Markdown } from './Markdown';
 import { OpenAPIDisclosureGroup } from './OpenAPIDisclosureGroup';
@@ -26,7 +26,10 @@ export function OpenAPIResponses(props: {
     const { responses, context } = props;
 
     const groups = Object.entries(responses)
-        .filter(([_, response]) => response && typeof response === 'object')
+        .filter(
+            ([_, response]) =>
+                response && typeof response === 'object' && !shouldIgnoreEntity(response)
+        )
         .map(([statusCode, response]: [string, OpenAPIV3.ResponseObject]) => {
             const tabs = (() => {
                 // If there is no content, but there are headers, we need to show the headers
@@ -107,6 +110,11 @@ export function OpenAPIResponses(props: {
 
     const state = useResponseExamplesState(context.blockKey, groups[0]?.key);
 
+    // If there are no responses, don't display anything
+    if (!groups.length) {
+        return null;
+    }
+
     return (
         <StaticSection header={t(context.translation, 'responses')} className="openapi-responses">
             <OpenAPIDisclosureGroup