Expose OpenAPI helper shouldIgnoreEntity (#2903)

Author: gregberge

.changeset/two-numbers-brush.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/openapi-parser': patch
+---
+
+Expose helper `shouldIgnoreEntity`

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<OpenAPIV3.TagObject, 'x-internal' | 'x-gitbook-ignore'>
+ | Pick<OpenAPIV3.OperationObject, 'x-internal' | 'x-gitbook-ignore'>
+) {
+ return data?.['x-internal'] === true || data?.['x-gitbook-ignore'] === true;
+}

packages/openapi-parser/src/index.ts

@@ -1,8 +1,9 @@
 export { parseOpenAPI } from './parse';
 
+export { dereference } from '@scalar/openapi-parser';
+export type { AnyObject } from '@scalar/openapi-parser';
 export type * from '@scalar/openapi-types';
-export type * from './types';
 export * from './error';
+export * from './helpers/shouldIgnoreEntity';
 export * from './traverse';
-export { dereference } from '@scalar/openapi-parser';
-export type { AnyObject } from '@scalar/openapi-parser';
+export type * from './types';