diff --git a/OpenAPI/openapi.yml b/OpenAPI/openapi.yml
index 2f9907cd37d58591f507b4e81b9d4606b8b46fa7..083221f1dcf4b2881e46d897e266b37cbf0d3bdc 100644
--- a/OpenAPI/openapi.yml
+++ b/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:
diff --git a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name.yml b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name.yml
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..2ef1720b628d709609504ebb1a7c1e0b4441294d 100644
--- a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name.yml
+++ b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name.yml
@@ -0,0 +1,85 @@
+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
diff --git a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-State.yml b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-State.yml
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..09a21333571b33862a5ef5e877c00ec9a9848f52 100644
--- a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-State.yml
+++ b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-State.yml
@@ -0,0 +1,42 @@
+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
diff --git a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type.yml b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type.yml
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..993c7973048d598483de9f8804cfd8723a8f87f0 100644
--- a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type.yml
+++ b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type.yml
@@ -0,0 +1,41 @@
+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
diff --git a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/index.yml b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/index.yml
index 65ee4b1e28fae0e54c045913f6b51b6a94bf4608..c38a1957179f119e402b84e778f3252fa47c754e 100644
--- a/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/index.yml
+++ b/OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/index.yml
@@ -7,4 +7,8 @@ FUN-Trigger:
PAR-Calibration:
$ref: 'PAR-Calibration.yml'
PAR-Mode:
- $ref: 'PAR-Mode.yml'
\ No newline at end of file
+ $ref: 'PAR-Mode.yml'
+PAR-Name:
+ $ref: 'PAR-Name.yml'
+PAR-Type:
+ $ref: 'PAR-Type.yml'
\ No newline at end of file
diff --git a/OpenAPI/paths/OBJ-ROOT/PAR-State.yml b/OpenAPI/paths/OBJ-ROOT/PAR-State.yml
index d10ac056f923b67b2fe13d4dbedb4cd8dfccd3ae..46d615c46788a24d815150834e6a61d0ca08616d 100644
--- a/OpenAPI/paths/OBJ-ROOT/PAR-State.yml
+++ b/OpenAPI/paths/OBJ-ROOT/PAR-State.yml
@@ -6,7 +6,9 @@ description: >
* `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.
+ * `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: []