feat: define graph data structure (#99)

docs/openapi/schemas/entity/graph/Graph.yaml

@@ -17,7 +17,12 @@ properties:
     example: |
       ## Introduction
       This is the introduction of the paper.
+  children:
+    type: array
+    items:
+      $ref: ./GraphChild.yaml
 required:
   - id
   - name
   - paragraph
+  - children

docs/openapi/schemas/entity/graph/GraphChild.yaml

@@ -0,0 +1,26 @@
+type: object
+description: GraphChild object
+properties:
+  name:
+    type: string
+    maxLength: 100
+    description: Child node name of the graph
+    example: Study of Note Apps
+  relation:
+    type: string
+    description: Graph relation
+    example: part of
+  description:
+    type: string
+    maxLength: 400
+    description: Graph description
+    example: This is a part of the overview section.
+  children:
+    type: array
+    items:
+      $ref: ./GraphChild.yaml
+required:
+  - name
+  - relation
+  - description
+  - children

docs/openapi/schemas/entity/graph/GraphChildError.yaml

@@ -0,0 +1,17 @@
+type: object
+description: Error Message for GraphChild object
+properties:
+  name:
+    type: string
+    description: Error message for graph child name
+    example: "graph child name is required, but got ''"
+  relation:
+    type: string
+    description: Error message for graph child relation
+    example: "graph child relation is required, but got ''"
+  description:
+    type: string
+    description: Error message for graph child description
+    example: "graph child description must be less than or equal to 400 bytes"
+  children:
+    $ref: ./GraphChildrenError.yaml

docs/openapi/schemas/entity/graph/GraphChildrenError.yaml

@@ -0,0 +1,11 @@
+type: object
+description: Error Message for GraphChild list
+properties:
+  message:
+    type: string
+    description: Error message for overall of children
+    example: name of neighboring nodes must be unique, but got 'Background' duplicated
+  items:
+    type: array
+    items:
+      $ref: ./GraphChildError.yaml

docs/openapi/schemas/entity/graph/GraphContent.yaml

@@ -12,6 +12,11 @@ properties:
     example: |
       ## Introduction
       This is the introduction of the paper.
+  children:
+    type: array
+    items:
+      $ref: ./GraphChild.yaml
 required:
   - id
   - paragraph
+  - children

docs/openapi/schemas/entity/graph/GraphContentError.yaml

@@ -9,3 +9,5 @@ properties:
     type: string
     description: Error message for graph paragraph
     example: graph paragraph must be less than or equal to 40000 bytes
+  children:
+    $ref: ./GraphChildrenError.yaml

docs/openapi/schemas/entity/graph/GraphContentWithoutAutofield.yaml

@@ -8,5 +8,9 @@ properties:
     example: |
       ## Introduction
       This is the introduction of the paper.
+  children:
+    type: array
+    items:
+      $ref: ./GraphChild.yaml
 required:
   - paragraph

docs/openapi/schemas/entity/graph/GraphContentWithoutAutofieldError.yaml

@@ -5,3 +5,5 @@ properties:
     type: string
     description: Error message for graph paragraph
     example: graph paragraph must be less than or equal to 40000 bytes
+  children:
+    $ref: ./GraphChildrenError.yaml

docs/openapi/schemas/interface/graphs/update/GraphUpdateResponse.yaml

@@ -2,6 +2,6 @@ type: object
 description: Response Body for Graph Update API
 properties:
   graph:
-    $ref: ../../../entity/graph/GraphContent.yaml
+    $ref: ../../../entity/graph/Graph.yaml
 required:
   - graph

fixtures/firebase-export-metadata.json

@@ -1,5 +1,5 @@
 {
-  "version": "13.22.1",
+  "version": "13.29.1",
   "firestore": {
     "version": "1.19.8",
     "path": "firestore_export",