Commit 7c78cb3

committed

Handle OpenAPI ignored responses

1 parent 262a9b1 commit 7c78cb3Copy full SHA for 7c78cb3

File tree

+24

-5

lines changed

+24

-5

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,6 @@`
	`1`	`+---`
	`2`	`+'@gitbook/openapi-parser': patch`
	`3`	`+'@gitbook/react-openapi': patch`
	`4`	`+---`
	`5`	`+`
	`6`	`+Handle OpenAPI ignored responses`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import type { OpenAPIV3 } from '@scalar/openapi-types';`
`4`	`4`	`* Check if an entity should be ignored`
`5`	`5`	`*/`
`6`	`6`	`export function shouldIgnoreEntity(`
`7`		`- data: undefined \| OpenAPIV3.TagObject \| OpenAPIV3.OperationObject`
	`7`	`+ data: undefined \| OpenAPIV3.TagObject \| OpenAPIV3.OperationObject\|OpenAPIV3.ResponseObject`
`8`	`8`	`) {`
`9`	`9`	`return data?.['x-internal'] === true \|\| data?.['x-gitbook-ignore'] === true;`
`10`	`10`	`}`

Lines changed: 7 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type{OpenAPIV3 } from '@gitbook/openapi-parser';`
	`1`	`+import {typeOpenAPIV3,shouldIgnoreEntity } from '@gitbook/openapi-parser';`
`2`	`2`	`import { Markdown } from './Markdown';`
`3`	`3`	`import { OpenAPIEmptyExample, OpenAPIExample } from './OpenAPIExample';`
`4`	`4`	`import { OpenAPIMediaTypeContent } from './OpenAPIMediaType';`
`@@ -42,7 +42,12 @@ export function OpenAPIResponseExample(props: {`
`42`	`42`	`});`
`43`	`43`
`44`	`44`	`const tabs = responses`
`45`		`- .filter(([_, responseObject]) => responseObject && typeof responseObject === 'object')`
	`45`	`+ .filter(`
	`46`	`+ ([_, responseObject]) =>`
	`47`	`+ responseObject &&`
	`48`	`+ typeof responseObject === 'object' &&`
	`49`	`+ !shouldIgnoreEntity(responseObject)`
	`50`	`+ )`
`46`	`51`	`.map(([key, responseObject]) => {`
`47`	`52`	`const description = resolveDescription(responseObject);`
`48`	`53`	`const label = description ? (`

Lines changed: 10 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`'use client';`
`2`	`2`
`3`		`-import type{OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';`
	`3`	`+import {typeOpenAPIV3, typeOpenAPIV3_1,shouldIgnoreEntity } from '@gitbook/openapi-parser';`
`4`	`4`	`import clsx from 'clsx';`
`5`	`5`	`import { Markdown } from './Markdown';`
`6`	`6`	`import { OpenAPIDisclosureGroup } from './OpenAPIDisclosureGroup';`
`@@ -26,7 +26,10 @@ export function OpenAPIResponses(props: {`
`26`	`26`	`const { responses, context } = props;`
`27`	`27`
`28`	`28`	`const groups = Object.entries(responses)`
`29`		`- .filter(([_, response]) => response && typeof response === 'object')`
	`29`	`+ .filter(`
	`30`	`+ ([_, response]) =>`
	`31`	`+ response && typeof response === 'object' && !shouldIgnoreEntity(response)`
	`32`	`+ )`
`30`	`33`	`.map(([statusCode, response]: [string, OpenAPIV3.ResponseObject]) => {`
`31`	`34`	`const tabs = (() => {`
`32`	`35`	`// If there is no content, but there are headers, we need to show the headers`
`@@ -107,6 +110,11 @@ export function OpenAPIResponses(props: {`
`107`	`110`
`108`	`111`	`const state = useResponseExamplesState(context.blockKey, groups[0]?.key);`
`109`	`112`
	`113`	`+ // If there are no responses, don't display anything`
	`114`	`+ if (!groups.length) {`
	`115`	`+ return null;`
	`116`	`+ }`
	`117`	`+`
`110`	`118`	`return (`
`111`	`119`	`<StaticSection header={t(context.translation, 'responses')} className="openapi-responses">`
`112`	`120`	`<OpenAPIDisclosureGroup`

Comments

(0)