update openapi.yaml

zms-publishing · Jul 21, 2023 · efef56f · efef56f
1 parent 007ad30
commit efef56f
Showing 1 changed file with 136 additions and 19 deletions.
diff --git a/Products/zms/zpt/ZMS/openapi_yaml.zpt b/Products/zms/zpt/ZMS/openapi_yaml.zpt
@@ -21,14 +21,30 @@ paths:
         </tal:block>
       responses:
         '200':    # status code
-          description: A JSON array of user names
+          description: Records from ZMSIndex.
           content:
             application/json:
-              type: string 
+              schema: 
+                type: array
+                items:
+                  $ref: '#/components/schemas/ZMSIndexRecord'
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api/metaobj_manager:
+    get:
+      summary: Returns meta-model.
+      description: get meta-model
+      responses:
+        '200':    # status code
+          description: Meta-model
+          content:
+            application/json:
+              schema: 
+                type: array
+                items:
+                  $ref: '#/components/schemas/MetaModelRecord'
   <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}:
     get:
-      summary: Returns a ZMS-object.
-      description: get ZMS-objects
+      summary: Returns a ZMS-Object.
+      description: Get ZMS-Object.
       parameters:
         - name: path
           in: path
@@ -39,12 +55,31 @@ paths:
             example: /
       responses:
         '200':    # status code
-          description: A JSON array of user names
+          description: ZMS-Object
+          content:
+            application/json:
+              schema: 
+                $ref: '#/components/responses/ZMSObjectResponse'
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/list_parent_nodes:
+    get:
+      summary: List ZMS-Object Parent's Index-Data.
+      description: Sequencing Parent Nodes Index-Data
+      parameters:
+        - name: path
+          in: path
+          description: id-path to current node
+          required: false
+          schema:
+            type: string
+            example: /e34/e36/
+      responses:
+        '200':    # status code
+          description: A JSON array of Parent Objects Meta-Data
           content:
             application/json:
               schema: 
                 $ref: '#/components/responses/ZMSObjectResponse'
-  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}list_child_nodes:
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/list_child_nodes:
     get:
       summary: List ZMS-Object Children's Index-Data.
       description: Sequencing Child Nodes Index-Data
@@ -62,11 +97,13 @@ paths:
           content:
             application/json:
               schema: 
-                $ref: '#/components/responses/ZMSObjectResponse'
-  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}get_tree_nodes:
+                type: array
+                items:
+                  $ref: '#/components/responses/ZMSObjectResponse'
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/list_tree_nodes:
     get:
-      summary: List Object Tree Content.
-      description: Sequencing the Object Tree
+      summary: List ZMS-Object-Tree Index-Data.
+      description: Sequencing Object-Tree Index-Data
       parameters:
         - name: path
           in: path
@@ -77,12 +114,35 @@ paths:
             example: /e34/e36/
       responses:
         '200':    # status code
-          description: A JSON array of Object Tree
+          description: A JSON array of Tree Objects Meta-Data
           content:
             application/json:
               schema: 
-                $ref: '#/components/responses/ZMSObjectResponse'
-  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}get_child_nodes:
+                type: array
+                items:
+                  $ref: '#/components/responses/ZMSObjectResponse'
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/get_parent_nodes:
+    get:
+      summary: List ZMS-Object Parent's Index-Data.
+      description: Sequencing Parent Nodes Content
+      parameters:
+        - name: path
+          in: path
+          description: id-path to current node
+          required: false
+          schema:
+            type: string
+            example: /e34/e36/
+      responses:
+        '200':    # status code
+          description: A JSON array of Parent Objects Content
+          content:
+            application/json:
+              schema: 
+                type: array
+                items:
+                  $ref: '#/components/responses/ZMSObjectResponse'
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/get_child_nodes:
     get:
       summary: List ZMS-Object Children's Index-Data.
       description: Sequencing Child Nodes Content
@@ -96,11 +156,34 @@ paths:
             example: /e34/e36/
       responses:
         '200':    # status code
-          description: A JSON array of Children Objects Contet
+          description: A JSON array of Children Objects Content
           content:
             application/json:
               schema: 
-                $ref: '#/components/responses/ZMSObjectResponse'
+                type: array
+                items:
+                  $ref: '#/components/responses/ZMSObjectResponse'
+  <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/get_tree_nodes:
+    get:
+      summary: List Object-Tree Content.
+      description: Sequencing the Object-Tree
+      parameters:
+        - name: path
+          in: path
+          description: id-path to current node
+          required: false
+          schema:
+            type: string
+            example: /e34/e36/
+      responses:
+        '200':    # status code
+          description: A JSON array of Object-Tree
+          content:
+            application/json:
+              schema: 
+                type: array
+                items:
+                  $ref: '#/components/responses/ZMSObjectResponse'
   <tal:block tal:content="python:'/'.join(here.getDocumentElement().getPhysicalPath())"></tal:block>/++rest_api{path}/get_body_content:
     get:
       summary: Returns body-content of a ZMS-object.
@@ -140,6 +223,36 @@ components:
             discriminator:
               propertyName: meta_id
   schemas:
+    ZMSIndexRecord:
+      description: ZMSIndex-Record
+      type: object
+      required: 
+        - id
+        - meta_id
+        - uid
+        - getPath
+      properties:
+        id:
+          description: object-id
+          type: string
+        meta_id:
+          description: ZMS meta-id
+          type: string
+        uid:
+          description: ZODB unique-id
+          type: string
+        getPath:
+          description: physical-path
+          type: string
+    MetaModelRecord:
+      description: Meta-Model-Record
+      type: object
+      required: 
+        - icon_clazz
+      properties:
+        icon_clazz:
+          description: icon-class
+          type: string
     <tal:block tal:repeat="metaObjId python:here.getMetaobjIds(sort=True)"
     ><tal:block tal:define="
       metaObj python:here.getMetaobj(metaObjId); 
@@ -152,8 +265,9 @@ components:
       type: object
       required:
         - id
-        - uid
         - meta_id
+        - uid
+        - getPath
         <tal:block tal:repeat="property properties"
         ><tal:block tal:define="metaObjAttr python:here.getMetaobjAttr(metaObjId,property)"
         ><tal:block tal:condition="metaObjAttr/mandatory">
@@ -163,13 +277,16 @@ components:
         ></tal:block>
       properties:
         id:
-          description: ZMS id
+          description: object-id
+          type: string
+        meta_id:
+          description: ZMS meta-id
           type: string
         uid:
           description: ZODB unique-id
           type: string
-        meta_id:
-          description: ZMS meta-id
+        getPath:
+          description: physical-path
           type: string
         <tal:block tal:repeat="property properties"
         ><tal:block tal:define="metaObjAttr python:here.getMetaobjAttr(metaObjId,property)">