docs: fix nullable json schema (#31938)

Co-authored-by: Rhys Arkins <[email protected]>
renovatebot · Oct 14, 2024 · 6c00935 · 6c00935
1 parent 5cb1078
commit 6c00935
Showing 1 changed file with 20 additions and 2 deletions.
diff --git a/tools/docs/schema.ts b/tools/docs/schema.ts
@@ -21,8 +21,20 @@ options.sort((a, b) => {
 });
 const properties = schema.properties as Record<string, any>;
 
+type JsonSchemaBasicType =
+  | 'string'
+  | 'number'
+  | 'integer'
+  | 'boolean'
+  | 'object'
+  | 'array'
+  | 'null';
+type JsonSchemaType = JsonSchemaBasicType | JsonSchemaBasicType[];
+
 function createSingleConfig(option: RenovateOptions): Record<string, unknown> {
-  const temp: Record<string, any> & Partial<RenovateOptions> = {};
+  const temp: Record<string, any> & {
+    type?: JsonSchemaType;
+  } & Omit<Partial<RenovateOptions>, 'type'> = {};
   if (option.description) {
     temp.description = option.description;
   }
@@ -67,7 +79,13 @@ function createSingleConfig(option: RenovateOptions): Record<string, unknown> {
   ) {
     temp.additionalProperties = option.additionalProperties;
   }
-  if (temp.type === 'object' && !option.freeChoice) {
+  if (option.default === null) {
+    temp.type = [option.type, 'null'];
+  }
+  if (
+    (temp.type === 'object' || temp.type?.includes('object')) &&
+    !option.freeChoice
+  ) {
     temp.$ref = '#';
   }
   return temp;