diff --git a/.changeset/two-numbers-brush.md b/.changeset/two-numbers-brush.md new file mode 100644 index 000000000..431b3b7c5 --- /dev/null +++ b/.changeset/two-numbers-brush.md @@ -0,0 +1,5 @@ +--- +'@gitbook/openapi-parser': patch +--- + +Expose helper `shouldIgnoreEntity` diff --git a/packages/openapi-parser/src/helpers/shouldIgnoreEntity.ts b/packages/openapi-parser/src/helpers/shouldIgnoreEntity.ts new file mode 100644 index 000000000..34dbdc651 --- /dev/null +++ b/packages/openapi-parser/src/helpers/shouldIgnoreEntity.ts @@ -0,0 +1,13 @@ +import type { OpenAPIV3 } from '@scalar/openapi-types'; + +/** + * Check if an entity should be ignored + */ +export function shouldIgnoreEntity( + data: + | undefined + | Pick + | Pick +) { + return data?.['x-internal'] === true || data?.['x-gitbook-ignore'] === true; +} diff --git a/packages/openapi-parser/src/index.ts b/packages/openapi-parser/src/index.ts index 8e289deb2..8b99bb9cb 100644 --- a/packages/openapi-parser/src/index.ts +++ b/packages/openapi-parser/src/index.ts @@ -1,8 +1,9 @@ export { parseOpenAPI } from './parse'; -export type * from '@scalar/openapi-types'; -export type * from './types'; -export * from './error'; -export * from './traverse'; export { dereference } from '@scalar/openapi-parser'; export type { AnyObject } from '@scalar/openapi-parser'; +export type * from '@scalar/openapi-types'; +export * from './error'; +export * from './helpers/shouldIgnoreEntity'; +export * from './traverse'; +export type * from './types';