Adds comment in remove props test about safeDump and the skipInvalid …

…option
elastic · Aug 20, 2024 · 415d452 · 415d452
1 parent c2b18f9
commit 415d452
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/kbn-openapi-bundler/tests/bundler/remove_props.test.ts b/packages/kbn-openapi-bundler/tests/bundler/remove_props.test.ts
@@ -108,6 +108,8 @@ describe('OpenAPI Bundler - remove custom x- props', () => {
     expect(bundledSpec.paths['/api/some_api']!.post).not.toMatchObject({
       'x-codegen-enabled': expect.anything(),
     });
+    // As we have switched to using the js-yaml safeDump function, we are stripping
+    // out invalid types like 'undefined' when the spec is written to file.
     expect(bundledSpec.paths['/api/some_api']!.put).not.toMatchObject({
       'x-codegen-enabled': expect.anything(),
     });