fix(v2): accept empty/null custom_edit_url docs frontmatter for retro…

…compat (#4687)
facebook · Apr 27, 2021 · 8efc0cd · 8efc0cd
1 parent 66254cf
commit 8efc0cd
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
@@ -34,4 +34,15 @@ describe('validateDocFrontMatter', () => {
     const frontMatter: DocFrontMatter = {description: ''};
     expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
   });
+
+  test('accept null custom_edit_url', () => {
+    const frontMatter: DocFrontMatter = {custom_edit_url: null};
+    expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
+  });
+
+  // See https://github.com/demisto/content-docs/pull/616#issuecomment-827087566
+  test('accept empty custom_edit_url', () => {
+    const frontMatter: DocFrontMatter = {custom_edit_url: ''};
+    expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
+  });
 });
diff --git a/packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts b/packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts
@@ -33,7 +33,7 @@ const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
   slug: Joi.string(),
   sidebar_label: Joi.string(),
   sidebar_position: Joi.number(),
-  custom_edit_url: Joi.string().allow(null),
+  custom_edit_url: Joi.string().allow('', null),
   parse_number_prefixes: Joi.boolean(),
 });