Skip to content
Snippets Groups Projects
Commit 2e7cbf7a authored by Patrick Joos's avatar Patrick Joos
Browse files

Updating documentation regarding port and clientid

parent 3575eb25
No related branches found
No related tags found
No related merge requests found
Pipeline #280848 passed
......@@ -11,7 +11,7 @@ A `Port` is defined as follows:
```json
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "port",
"title": "Port",
"type": "object",
"properties": {
"id": {
......@@ -19,11 +19,16 @@ A `Port` is defined as follows:
"type": "string",
"format": "uuid"
},
"clientid": {
"description": "Unique ID that stays the same for the client",
"type": "string",
"format": "uuid"
},
"name": {
"description": "A human-readable name (need not be unique)",
"type": "string"
},
"type": {
"porttype": {
"description": "Defines what type of port is transmitted",
"enum": ["requirement", "capability"]
},
......@@ -46,6 +51,7 @@ A `Port` is defined as follows:
```json
{
"id": "936DA01F-9ABD-4D9D-80C7-02AF85C822A8",
"clientid": "bc244d87-f65e-47e5-a24a-0f211f069b0a",
"name": "Joystick - X",
"type": "requirement",
"interface": "axis",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment