Added further parameters

OpenAPI/openapi.yml

@@ -4,7 +4,6 @@ info:
   title: Large-Scale Metrology Instrument
   version: '0.1'
   
-  # This line is against the schema but should be compatible
   description: >
     ## Introduction
   
@@ -64,6 +63,10 @@ paths:
     $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Calibration'
   /OBJ-LSM/OBJ-Entities/{uuid}/PAR-Mode/:
     $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Mode'
+  /OBJ-LSM/OBJ-Entities/{uuid}/PAR-Name/:
+    $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name'
+  /OBJ-LSM/OBJ-Entities/{uuid}/PAR-Type/:
+    $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type'
 
 components:
   schemas:

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

+description: >
+  **Human-readable Name**  
+
+  Easy-to read name for the mobile entity. This parameter shall not be considered
+  redundant to the name or uuid ob the object. The uuid is expected to be persistent
+  and unique to the hardware (e.g. a serial number of the target). The name parameter
+  is intended to be changeable to assign the target to a specific object or task, e.g.
+  a robot frame
+
+get:
+  tags:
+    - Entity
+  description: 
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+        description: >
+          **OK**  
+
+          Everything occurred as expected.
+        content:
+          application/json:
+            schema: 
+              $ref: '../../../../../schemas/index.yml#/Parameter'
+            example:
+              uuid: PAR-Name
+              name: Human-readable Name
+              description: Human-readable Name that can be assigned by the user.
+              ontology: null
+              datatype: string
+              dimension: []
+              unit: null
+              range: []
+              constant: false
+              value: TCP Robot Alpha
+              timestamp: '2022-03-01T12:54:29.147062Z'
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+patch:
+  tags:
+    - Entity
+  description: 
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            value: 
+              type: string
+        example:
+          value: TCP Robot Beta
+  responses:
+    '200':
+        description: >
+          **OK**  
+
+          Everything occurred as expected.
+        content:
+          application/json:
+            schema: 
+              $ref: '../../../../../schemas/index.yml#/Parameter'
+            example:
+              uuid: PAR-Name
+              name: Human-readable Name
+              description: Human-readable Name that can be assigned by the user.
+              ontology: null
+              datatype: string
+              dimension: []
+              unit: null
+              range: []
+              constant: false
+              value: TCP Robot Beta
+              timestamp: '2022-03-01T12:54:29.147062Z'
+    '405':
+      $ref: "../../../../../responses/index.yml#/NotAllowed"
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+    
+      
\ No newline at end of file

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

+description: >
+  **State**  
+
+  Enumeration representing the current state of the mobile entity. The following states are accepted:
+
+    * `OK`: The system is operated as expected.  
+    * `WARNING`: There is a warning which is not critical to operation.
+    * `ERROR`: There is an error which is critical to operation.
+    * `MAINTENANCE`: The system ist currently down for a scheduled maintenance operation.  
+
+  This is a *read-only* parameter.
+get:
+  tags:
+    - Entity
+  description:
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+      description: >
+        **OK**  
+
+        Everything occurred as expected.
+      content:
+        application/json:
+          schema: 
+            $ref: '../../../../../schemas/index.yml#/Parameter'
+          example:
+            uuid: PAR-State
+            name: State
+            description: State of the mobile entity.
+            ontology: null
+            datatype: enum
+            dimension: []
+            unit: null
+            range: ["OK", "WARNING", "ERROR", "MAINTENANCE"]
+            constant: false
+            value: "OK"
+            timestamp: "2022-02-01T17:00:01.000Z"
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
\ No newline at end of file

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

+description: >
+  **Target Type**  
+
+  System-specific identifier of the target type, e.g. SMR-1.5inch.
+  The type is not further standardized.  
+
+  This is a *read-only* parameter.
+
+get:
+  tags:
+    - Entity
+  description: 
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+        description: >
+          **OK**  
+
+          Everything occurred as expected.
+        content:
+          application/json:
+            schema: 
+              $ref: '../../../../../schemas/index.yml#/Parameter'
+            example:
+              uuid: PAR-Type
+              name: Target Type
+              description: System-specific description of target type.
+              ontology: null
+              datatype: string
+              dimension: []
+              unit: null
+              range: []
+              constant: true
+              value: SMR-1.5inch
+              timestamp: '2022-03-01T12:54:29.147062Z'
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+
+      
\ No newline at end of file

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

@@ -8,3 +8,7 @@ PAR-Calibration:
   $ref: 'PAR-Calibration.yml'
 PAR-Mode:
   $ref: 'PAR-Mode.yml'
+PAR-Name:
+  $ref: 'PAR-Name.yml'
+PAR-Type:
+  $ref: 'PAR-Type.yml'
\ No newline at end of file

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

@@ -7,6 +7,8 @@ description: >
     * `WARNING`: There is a warning which is not critical to operation.
     * `ERROR`: There is an error which is critical to operation.
     * `MAINTENANCE`: The system ist currently down for a scheduled maintenance operation.  
+
+  This is a *read-only* parameter.
 get:
   tags:
     - Root
@@ -23,9 +25,9 @@ get:
           schema: 
             $ref: '../../schemas/index.yml#/Parameter'
           example:
-            uuid: PAR-Manufacturer
-            name: Manufacturer
-            description: Manufacturer of the equipment.
+            uuid: PAR-State
+            name: State
+            description: Overall system state.
             ontology: null
             datatype: enum
             dimension: []