diff --git a/doc/openapi/components/schemas/config/nodes/ngsi.yaml b/doc/openapi/components/schemas/config/nodes/ngsi.yaml index e2698bd74..6c59a7e7f 100644 --- a/doc/openapi/components/schemas/config/nodes/ngsi.yaml +++ b/doc/openapi/components/schemas/config/nodes/ngsi.yaml @@ -12,16 +12,34 @@ allOf: entity_id: type: string + description: ID of NGSI entity. entity_type: type: string + description: Type of NGSI entity. ssl_verify: type: boolean description: Verify SSL certificate against local trust store. timeout: + description: Timeout in seconds for HTTP requests. type: number + default: 1.0 + + rate: + description: Polling rate in Hz for requesting entity updates from broker. + type: number + default: 1.0 + + access_token: + type: string + description: Send 'Auth-Token' header with every HTTP request. + + create: + type: boolean + default: true + description: Create NGSI entities during startup of node. - $ref: ../node_signals.yaml - $ref: ../node.yaml diff --git a/etc/examples/nodes/ngsi.conf b/etc/examples/nodes/ngsi.conf index f95a17ffc..3d40a5efd 100644 --- a/etc/examples/nodes/ngsi.conf +++ b/etc/examples/nodes/ngsi.conf @@ -7,9 +7,13 @@ nodes = { # The HTTP REST API endpoint of the FIRWARE context broker endpoint = "http://46.101.131.212:1026", + access_token: "aig1aaQuohsh5pee9uiC2Bae3loSh9wu" # Add an 'Auth-Token' token header to each request + entity_id = "S3_ElectricalGrid", entity_type = "ElectricalGridMonitoring", + create = true # Create the NGSI entities during startup + rate = 0.1 # Rate at which we poll the broker for updates timeout = 1, # Timeout of HTTP request in seconds (default is 1, must be smaller than 1 / rate) verify_ssl = false, # Verification of SSL server certificates (default is true)