Categorygithub.com/ONSdigital/dp-observation-api
modulepackage
0.12.0
Repository: https://github.com/onsdigital/dp-observation-api.git
Documentation: pkg.go.dev

# README

dp-observation-api

dp-observation-api

Getting started

  • Run make debug

Dependencies

  • No further dependencies other than those defined in go.mod

Configuration

Environment variableDefaultDescription
BIND_ADDR:24500The host and port to bind to
SERVICE_AUTH_TOKEN""The token used to identify this service when authenticating
DATASET_API_URLhttp://localhost:22000The host name for the dataset API
OBSERVATION_API_URLhttp://localhost:24500The host name for the observation API
ZEBEDEE_URLhttp://localhost:8082The host name for Zebedee
DEFAULT_OBSERVATION_LIMIT1000The default limit number of observations returned in a reauest
ENABLE_PRIVATE_ENDPOINTSfalseFlag to enable private endpoints for the API
GRACEFUL_SHUTDOWN_TIMEOUT5sThe graceful shutdown timeout in seconds (time.Duration format)
HEALTHCHECK_INTERVAL30sTime between self-healthchecks (time.Duration format)
HEALTHCHECK_CRITICAL_TIMEOUT90sTime to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format)

Contributing

See CONTRIBUTING for details.

License

Copyright © 2020, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

BuildTime represents the time in which the service was built.
GitCommit represents the commit (SHA-1) hash of the service that is running.
Version represents the version of the service that is running.