Major cleanup

OpenAPI/openapi.yml

@@ -58,7 +58,7 @@ paths:
   /OBJ-LSM/OBJ-Entities/{uuid}/FUN-Reset/:
     $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/FUN-Reset'
   /OBJ-LSM/OBJ-Entities/{uuid}/FUN-Trigger/:
-    $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/FUN-Reset'
+    $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/FUN-Trigger'
   /OBJ-LSM/OBJ-Entities/{uuid}/PAR-Calibration/:
     $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Calibration'
   /OBJ-LSM/OBJ-Entities/{uuid}/PAR-Mode/:

OpenAPI/paths/OBJ-ROOT/FUN-Reset.yml

@@ -5,12 +5,11 @@ description: >
   Function that initializes or resets the entire device. This function is usually called
   on startup and should implement the necessary business logic in the device's backend.
 get:
+  summary: READ
   tags:
     - Root
   description:
     $ref: '#/description'  
-
-    
   responses:
     '200':
       description: >
@@ -29,9 +28,10 @@ get:
             arguments: []
             returns: []
     '500':
-      $ref: "../../responses/index.yml#/InternalError"
+      $ref: '../../responses/index.yml#/InternalError'
 
 post:
+  summary: INVOKE
   tags:
     - Root
   description:
@@ -58,6 +58,6 @@ post:
       content:
         application/json: {}
     '500':
-      $ref: "../../responses/index.yml#/InternalError"
+      $ref: '../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../responses/index.yml#/NotImplemented"
+      $ref: '../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/FUN-Shutdown.yml

@@ -5,6 +5,7 @@ description: >
   Function that shuts down the entire devicee. This function is usually called
   after use and should implement the necessary business logic in the device's backend.
 get:
+  summary: READ
   tags:
     - Root
   description:
@@ -27,9 +28,10 @@ get:
             arguments: []
             returns: []
     '500':
-      $ref: "../../responses/index.yml#/InternalError"
+      $ref: '../../responses/index.yml#/InternalError'
 
 post:
+  summary: INVOKE
   tags:
     - Root
   description:
@@ -56,6 +58,6 @@ post:
       content:
         application/json: {}
     '500':
-      $ref: "../../responses/index.yml#/InternalError"
+      $ref: '../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../responses/index.yml#/NotImplemented"
+      $ref: '../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/FUN-Covariance.yml

@@ -7,6 +7,7 @@ description: >
   
   The variables **must** be scalar of 1D.
 get:
+  summary: READ
   tags:
     - LSM
   description:
@@ -56,9 +57,10 @@ get:
                 value: null
                 timestamp: null
     '500':
-      $ref: "../../../responses/index.yml#/InternalError"
+      $ref: '../../../responses/index.yml#/InternalError'
 
 post:
+  summary: INVOKE
   tags:
     - LSM
   description:
@@ -123,6 +125,6 @@ post:
                   timestamp: "2022-03-02T12:03:01.002271Z"
           
     '500':
-      $ref: "../../../responses/index.yml#/InternalError"
+      $ref: '../../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../../responses/index.yml#/NotImplemented"
+      $ref: '../../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Bases/OBJ-Bases.yml

@@ -7,6 +7,7 @@ description: >
   Manual insertion of base stations must be supported and implemented by the system itself.
 
 get:
+  summary: READ
   tags:
     - LSM
   description:
@@ -32,9 +33,10 @@ get:
               - uuid: OBJ-B
                 name: Base Station B
     '500':
-      $ref: "../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../responses/index.yml#/InternalError'
 
 put:
+  summary: CREATE
   tags:
     - LSM
   description:
@@ -72,4 +74,4 @@ put:
 
         This system does not allow manual addition of base stations.
     '500':
-      $ref: "../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entities.yml

@@ -7,6 +7,7 @@ description: >
   and implemented by the system itself.
 
 get:
+  summary: READ
   tags:
     - LSM
   description:
@@ -32,8 +33,9 @@ get:
               - uuid: OBJ-002
                 name: Target 002
     '500':
-      $ref: "../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../responses/index.yml#/InternalError'
 put:
+  summary: CREATE
   tags:
     - LSM
   description:
@@ -68,4 +70,4 @@ put:
 
         This system does not allow manual addition of targets.
     '500':
-      $ref: "../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/FUN-Reset.yml

@@ -4,6 +4,7 @@ description: >
 
   Function that initializes or resets the mobile entity.
 get:
+  summary: READ
   tags:
     - Entity
   description:
@@ -29,9 +30,10 @@ get:
             arguments: []
             returns: []
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 
 post:
+  summary: INVOKE
   tags:
     - Entity
   description:
@@ -60,6 +62,6 @@ post:
       content:
         application/json: {}
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../../../../responses/index.yml#/NotImplemented"
+      $ref: '../../../../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/FUN-Trigger.yml

@@ -4,6 +4,7 @@ description: >
   Triggers *n* measurements and sets a special *nonce. The acquisition mode
   must be set to `TRIGGERED`for this function to act meaningfully.
 get:
+  summary: READ
   tags:
     - Entity
   description:
@@ -54,9 +55,10 @@ get:
             returns: []
               
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 
 post:
+  summary: INVOKE
   tags:
     - Entity
   description:
@@ -114,6 +116,6 @@ post:
             returns: []
           
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../../../../responses/index.yml#/NotImplemented"
+      $ref: '../../../../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/OBJ-Entity.yml

@@ -3,6 +3,7 @@ description: >
 
   Object representing as single target of Large-Scale Metrology system and organizing its elements.
 get:
+  summary: READ
   description:
     $ref: '#/description'
   tags:
@@ -44,9 +45,10 @@ get:
               - uuid: VAR-Orientation
                 name: Orientation
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 
 delete:
+  summary: REMOVE
   tags:
     - Entity
   description:
@@ -66,5 +68,5 @@ delete:
 
         This system does not allow manual removal of base stations.
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Calibration.yml

@@ -6,9 +6,8 @@ description: >
     
 
   This is a *read-only* parameter.
-
-
 get:
+  summary: READ
   tags:
     - Entity
   description: 
@@ -41,4 +40,4 @@ get:
 
 
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Mode.yml

@@ -9,6 +9,7 @@ description: >
     * `IDLE`: The entity is currently unused.
 
 get:
+  summary: READ
   tags:
     - Entity
   description: 
@@ -38,8 +39,9 @@ get:
               value: CONTINUOUS
               timestamp: '2022-03-01T12:54:29.147062Z'
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 patch:
+  summary: UPDATE
   tags:
     - Entity
   description: 
@@ -80,8 +82,8 @@ patch:
               value: TRIGGERED
               timestamp: '2022-03-01T12:54:29.147062Z'
     '405':
-      $ref: "../../../../../responses/index.yml#/NotAllowed"
+      $ref: '../../../../../responses/index.yml#/NotAllowed'
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
     
       
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name.yml

@@ -8,6 +8,7 @@ description: >
   a robot frame
 
 get:
+  summary: READ
   tags:
     - Entity
   description: 
@@ -37,8 +38,9 @@ get:
               value: TCP Robot Alpha
               timestamp: '2022-03-01T12:54:29.147062Z'
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 patch:
+  summary: UPDATE
   tags:
     - Entity
   description: 
@@ -78,8 +80,8 @@ patch:
               value: TCP Robot Beta
               timestamp: '2022-03-01T12:54:29.147062Z'
     '405':
-      $ref: "../../../../../responses/index.yml#/NotAllowed"
+      $ref: '../../../../../responses/index.yml#/NotAllowed'
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
     
       
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-State.yml

@@ -12,6 +12,7 @@ description: >
 
   This is a *read-only* parameter.
 get:
+  summary: READ
   tags:
     - Entity
   description:
@@ -36,9 +37,9 @@ get:
             datatype: enum
             dimension: []
             unit: null
-            range: ["OK", "WARNING", "ERROR", "MAINTENANCE"]
+            range: ["OK", "WARNING", "Error", "MAINTENANCE"]
             constant: false
             value: "OK"
             timestamp: "2022-02-01T17:00:01.000Z"
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type.yml

@@ -9,6 +9,7 @@ description: >
   This is a *read-only* parameter.
 
 get:
+  summary: READ
   tags:
     - Entity
   description: 
@@ -38,6 +39,6 @@ get:
               value: SMR-1.5inch
               timestamp: '2022-03-01T12:54:29.147062Z'
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 
       
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/VAR-Orientation.yml

@@ -13,6 +13,7 @@ description: >
   the same JSON representation. Hence they may also be consumed via MQTT and its websocket
   extension in the corresponding applications.
 get:
+  summary: READ
   tags:
     - Entity
   description:
@@ -47,9 +48,10 @@ get:
                         ]
             timestamp: "2022-02-01T17:00:01.352916Z"
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 
 options:
+  summary: INFO
   tags:
     - Entity
   description:
@@ -79,6 +81,6 @@ options:
             covariance: null
             timestamp: null
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../../../../responses/index.yml#/NotImplemented"
+      $ref: '../../../../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/VAR-Position.yml

@@ -11,6 +11,7 @@ description: >
   the same JSON representation. Hence they may also be consumed via MQTT and its websocket
   extension in the corresponding applications.
 get:
+  summary: READ
   tags:
     - Entity
   description:
@@ -44,9 +45,10 @@ get:
                         ]
             timestamp: "2022-02-01T17:00:01.352916Z"
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
 
 options:
+  summary: INFO
   tags:
     - Entity
   description:
@@ -76,6 +78,6 @@ options:
             covariance: null
             timestamp: null
     '500':
-      $ref: "../../../../../responses/index.yml#/InternalError"
+      $ref: '../../../../../responses/index.yml#/InternalError'
     '501':
-      $ref: "../../../../../responses/index.yml#/NotImplemented"
+      $ref: '../../../../../responses/index.yml#/NotImplemented'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-LSM.yml

@@ -3,6 +3,7 @@ description: >
 
   Main object organizing all elements that belong to a Large-Scale Metrology system.
 get:
+  summary: READ
   description:
     $ref: '#/description'
   tags:
@@ -32,4 +33,4 @@ get:
               - uuid: FUN-Covariance
                 name: Covariance
     '500':
-      $ref: "../../../responses/index.yml#/InternalError"
+      $ref: '../../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/PAR-Calibration.yml

@@ -7,6 +7,7 @@ description: >
 
   This is a *read-only* parameter.
 get:
+  summary: READ
   tags:
     - LSM
   description: 
@@ -37,4 +38,4 @@ get:
 
 
     '500':
-      $ref: "../../../responses/index.yml#/InternalError"
+      $ref: '../../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-ROOT.yml

@@ -5,7 +5,7 @@ description: >
   using SOIL as long as the methods there and especially the OBJ-LSM object are maintained.
 
 get:
-  summary: TODO MEANINGFUL SUMMARIES
+  summary: READ
   description:
     $ref: '#/description'
   tags:
@@ -37,4 +37,4 @@ get:
               - uuid: PAR-Time
                 name: System Time
     '500':
-            $ref: "../../responses/index.yml#/InternalError"
+            $ref: '../../responses/index.yml#/InternalError'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/PAR-Manufacturer.yml

@@ -8,6 +8,7 @@ description: >
   This is a *read-only* parameter.
 
 get:
+  summary: READ
   tags:
     - Root
   description:
@@ -35,4 +36,4 @@ get:
             value: "WZL | RWTH Aachen"
             timestamp: "2020-02-01T15:00:01.000Z"
     '500':
-      $ref: "../../responses/index.yml#/InternalError"
+      $ref: '../../responses/index.yml#/InternalError'
\ No newline at end of file