restructured material

api/parameters.yaml

@@ -15,10 +15,19 @@ Name:
     type: string
 
 State:
-  name: group
+  name: state
   description: 'possible values: new, deleted'
   in: path
   required: true
   schema:
     type: string
-  example: deleted
+  example: deleted
+
+Collection:
+  name: collection
+  description: 'possible values: condition, measurement, material'
+  in: path
+  required: true
+  schema:
+    type: string
+  example: condition

api/schemas.yaml

@@ -115,25 +115,21 @@ Material:
     group:
       type: string
       example: PA46
-    mineral:
-      type: number
-      example: 0
-    glass_fiber:
-      type: number
-      example: 40
-    carbon_fiber:
-      type: number
-      example: 0
+    properties:
+      type: object
+      properties:
+        material_template:
+          $ref: 'api.yaml#/components/schemas/Id'
+      example:
+        condition_template: 5ea0450ed851c30a90e70894
+        mineral: 0
+        glass_fiber: 40
+        carbon_fiber: 0
     numbers:
       type: array
       items:
-        type: object
-        allOf:
-          - $ref: 'api.yaml#/components/schemas/Color'
-        properties:
-          number:
-            type: string
-            example: 5514263423
+        type: string
+        example: 5514263423
 
 Measurement:
   allOf:

api/template.yaml

@@ -1,6 +1,8 @@
-/template/conditions:
+/template/{collection}s:
+  parameters:
+    - $ref: 'api.yaml#/components/parameters/Collection'
   get:
-    summary: all available condition methods
+    summary: all available templates
     description: 'Auth: basic, levels: read, write, maintain, dev, admin'
     tags:
       - /template
@@ -8,7 +10,7 @@
       - BasicAuth: []
     responses:
       200:
-        description: list of conditions
+        description: list of templates
         content:
           application/json:
             schema:
@@ -20,11 +22,12 @@
       500:
         $ref: 'api.yaml#/components/responses/500'
 
-/template/condition/{id}:
+/template/{collection}/{id}:
   parameters:
+    - $ref: 'api.yaml#/components/parameters/Collection'
     - $ref: 'api.yaml#/components/parameters/Id'
   get:
-    summary: condition method details
+    summary: template details
     description: 'Auth: basic, levels: read, write, maintain, admin'
     tags:
       - /template
@@ -32,7 +35,7 @@
       - BasicAuth: []
     responses:
       200:
-        description: condition details
+        description: template details
         content:
           application/json:
             schema:
@@ -44,7 +47,7 @@
       500:
         $ref: 'api.yaml#/components/responses/500'
   put:
-    summary: change condition method
+    summary: change template
     description: 'Auth: basic, levels: maintain, admin'
     x-doc: With a change a new version is set, resulting in a new template with a new id
     tags:
@@ -59,7 +62,7 @@
             $ref: 'api.yaml#/components/schemas/Template'
     responses:
       200:
-        description: condition details
+        description: template details
         content:
           application/json:
             schema:
@@ -75,116 +78,11 @@
       500:
         $ref: 'api.yaml#/components/responses/500'
 
-/template/condition/new:
-  post:
-    summary: add condition method
-    description: 'Auth: basic, levels: maintain, admin'
-    tags:
-      - /template
-    security:
-      - BasicAuth: []
-    requestBody:
-      required: true
-      content:
-        application/json:
-          schema:
-            $ref: 'api.yaml#/components/schemas/Template'
-    responses:
-      200:
-        description: condition details
-        content:
-          application/json:
-            schema:
-              $ref: 'api.yaml#/components/schemas/Template'
-      400:
-        $ref: 'api.yaml#/components/responses/400'
-      401:
-        $ref: 'api.yaml#/components/responses/401'
-      403:
-        $ref: 'api.yaml#/components/responses/403'
-      500:
-        $ref: 'api.yaml#/components/responses/500'
-
-/template/measurements:
-  get:
-    summary: all available measurement methods
-    description: 'Auth: basic, levels: read, write, maintain, dev, admin'
-    tags:
-      - /template
-    security:
-      - BasicAuth: []
-    responses:
-      200:
-        description: list of measurement methods
-        content:
-          application/json:
-            schema:
-              type: array
-              items:
-                $ref: 'api.yaml#/components/schemas/Template'
-      401:
-        $ref: 'api.yaml#/components/responses/401'
-      500:
-        $ref: 'api.yaml#/components/responses/500'
-/template/measurement/{id}:
+/template/{collection}/new:
   parameters:
-    - $ref: 'api.yaml#/components/parameters/Id'
-  get:
-    summary: measurement method details
-    description: 'Auth: basic, levels: read, write, maintain, admin'
-    tags:
-      - /template
-    security:
-      - BasicAuth: []
-    responses:
-      200:
-        description: measurement details
-        content:
-          application/json:
-            schema:
-              $ref: 'api.yaml#/components/schemas/Template'
-      400:
-        $ref: 'api.yaml#/components/responses/400'
-      401:
-        $ref: 'api.yaml#/components/responses/401'
-      404:
-        $ref: 'api.yaml#/components/responses/404'
-      500:
-        $ref: 'api.yaml#/components/responses/500'
-  put:
-    summary: change measurement method
-    description: 'Auth: basic, levels: maintain, admin'
-    tags:
-      - /template
-    security:
-      - BasicAuth: []
-    requestBody:
-      required: true
-      content:
-        application/json:
-          schema:
-            $ref: 'api.yaml#/components/schemas/Template'
-    responses:
-      200:
-        description: measurement details
-        content:
-          application/json:
-            schema:
-              $ref: 'api.yaml#/components/schemas/Template'
-      400:
-        $ref: 'api.yaml#/components/responses/400'
-      401:
-        $ref: 'api.yaml#/components/responses/401'
-      403:
-        $ref: 'api.yaml#/components/responses/403'
-      404:
-        $ref: 'api.yaml#/components/responses/404'
-      500:
-        $ref: 'api.yaml#/components/responses/500'
-
-/template/measurement/new:
+    - $ref: 'api.yaml#/components/parameters/Collection'
   post:
-    summary: add measurement method
+    summary: add template
     description: 'Auth: basic, levels: maintain, admin'
     tags:
       - /template
@@ -198,7 +96,7 @@
             $ref: 'api.yaml#/components/schemas/Template'
     responses:
       200:
-        description: measurement details
+        description: template details
         content:
           application/json:
             schema:
@@ -210,4 +108,4 @@
       403:
         $ref: 'api.yaml#/components/responses/403'
       500:
-        $ref: 'api.yaml#/components/responses/500'
+        $ref: 'api.yaml#/components/responses/500'