add jsdoc to json schema relation type

premieroctet · Oct 3, 2024 · 3386985 · 3386985
1 parent 31d768a
commit 3386985
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/packages/json-schema/src/index.ts b/packages/json-schema/src/index.ts
@@ -1,4 +1,4 @@
-import type { JSONSchema7Definition, JSONSchema7 } from "json-schema";
+import type { JSONSchema7 } from "json-schema";
 
 export type NextAdminJsonSchemaDataType =
  | "BigInt"
@@ -13,9 +13,29 @@ export type NextAdminJsonSchemaDataType =
 
 export type NextAdminJsonSchemaRelation = {
  $ref: string;
+ /**
+ * The relation field name in the distant object
+ *
+ * Example: posts
+ */
  fromField: string;
+ /**
+ * The db relation field name in the current object
+ *
+ * Example: author_id
+ */
  fromFieldDbName?: string;
+ /**
+ * The relation field name in the current object
+ *
+ * Example: posts
+ */
  toField: string;
+ /**
+ * The db relation field name in the distant object
+ *
+ * Example: id
+ */
  toFieldDbName?: string;
 };