VILLASnode/doc/openapi/components/schemas/config/nodes/ngsi.yaml

# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
---
allOf:
- type: object
  required:
  - endpoint
  properties:
    endpoint:
      type: string
      format: uri
    
    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