adjusted material

api/api.yaml

@@ -34,6 +34,7 @@ info:
       <li>0: newly added/changed</li>
       <li>10: validated</li>
     </ul>
+    <a href="https://sourcecode.socialcoding.bosch.com/users/vle2fe/repos/dfop-api/">Bitbucket repository</a>
 # TODO: Link to new documentation page
 
 

api/material.yaml

@@ -2,6 +2,7 @@
   get:
     summary: lists all materials
     description: 'Auth: all, levels: read, write, maintain, dev, admin'
+    x-doc: returns only materials with status 10  # TODO: methods /materials/new|deleted
     tags:
       - /material
     responses:
@@ -24,6 +25,7 @@
   get:
     summary: get material details
     description: 'Auth: all, levels: read, write, maintain, dev, admin'
+    x-doc: status handling (accessible (only for maintain/admin))?  # TODO
     tags:
       - /material
     responses:
@@ -42,6 +44,7 @@
   put:
     summary: change material
     description: 'Auth: basic, levels: write, maintain, dev, admin'
+    x-doc: status is reset to 0 on any changes
     tags:
       - /material
     security:
@@ -72,6 +75,7 @@
   delete:
     summary: delete material
     description: 'Auth: basic, levels: write, maintain, dev, admin'
+    x-doc: sets status to -1
     tags:
       - /material
     security:
@@ -94,6 +98,7 @@
   post:
     summary: add material
     description: 'Auth: basic, levels: write, maintain, dev, admin'
+    x-doc: 'Adds status: 0 automatically'
     tags:
       - /material
     security: