Fix mqtt documentation on device connections (#30257)

This commit is contained in:
Jan Bouwhuis 2023-12-11 08:43:19 +01:00 committed by GitHub
parent 13452901e9
commit f116e91bc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 18 additions and 18 deletions

View File

@ -78,9 +78,9 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`." description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: [list, map] type: list
hw_version: hw_version:
description: The hardware version of the device. description: The hardware version of the device.
required: false required: false

View File

@ -78,7 +78,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -89,7 +89,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -75,9 +75,9 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`." description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: [list, map] type: list
hw_version: hw_version:
description: The hardware version of the device. description: The hardware version of the device.
required: false required: false

View File

@ -53,9 +53,9 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`." description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: [list, map] type: list
identifiers: identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number. description: A list of IDs that uniquely identify the device. For example a serial number.
required: false required: false

View File

@ -86,7 +86,7 @@ device:
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: [list, map] type: list
hw_version: hw_version:
description: The hardware version of the device. description: The hardware version of the device.
required: false required: false

View File

@ -105,7 +105,7 @@ device:
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: [list, map] type: list
hw_version: hw_version:
description: The hardware version of the device. description: The hardware version of the device.
required: false required: false

View File

@ -81,7 +81,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -77,7 +77,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example, the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -70,7 +70,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -82,7 +82,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -34,9 +34,9 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`." description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: [list, map] type: list
hw_version: hw_version:
description: The hardware version of the device. description: The hardware version of the device.
required: false required: false

View File

@ -76,7 +76,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version:

View File

@ -73,7 +73,7 @@ device:
required: false required: false
type: string type: string
connections: connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false required: false
type: list type: list
hw_version: hw_version: