Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add schemas for config files #16

Open
2 tasks
david-i-berry opened this issue Jun 7, 2024 · 1 comment
Open
2 tasks

add schemas for config files #16

david-i-berry opened this issue Jun 7, 2024 · 1 comment

Comments

@david-i-berry
Copy link
Member

david-i-berry commented Jun 7, 2024

  • config.json
  • .mqtt_session.json
@david-i-berry david-i-berry changed the title add schemas from config files add schemas for config files Jun 11, 2024
@david-i-berry
Copy link
Member Author

config.json schema added to readme (in yaml)

schema:
  type: object
  properties:
    broker_hostname:
      type: string
      description: The hostname of the global broker to subscribe to.
      example: globalbroker.meteo.fr
    broker_password:
      type: string
      description: The password to use when connecting to the specified global broker.      
      example: everyone
    broker_port:
      type: number
      description: The port the global broker is using for the specified protocol.
      example: 443
    broker_protocol:
      type: string
      description: The protocol (websockets or tcp) to use when connecting to the global broker.
      example: websockets
    broker_username:
      type: string
      description: The username to use when connecting to the global broker.
      example: everyone
    download_workers:
      type: number
      description: The number of download worker threads to spawn.
      example: 1
    download_dir:
      type: string
      description: The path to download data to.
      example: ./downloads
    flask_host:
      type: string
      description: Network interface on which flask should listen when run in dev mode.
      example: 0.0.0.0
    flask_port:
      type: number
      description: The port on which flask should listen when run in dev mode.
      example: 5050
    log_path:
      type: string
      description: Path to write log files to.
      example: ./logs
    max_disk_usage:
      type: number
      description: Maximum size (MB) for the download path.
      example: 10
    save_logs:
      type: boolean
      description: Write log files to disk (true) or stdout (false)
      example: false
    mqtt_session_info:
      type: string
      description: 
        File to save session information (active subscriptions and MQTT client id) to. 
        Used to persist subscriptions on restart.
      example: mqtt_session.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant