README
¶
dp-hierarchy-api
An API used to retrieve hierarchies - using root or child endpoints - returning children and parents (breadcrumbs) for the requested node.
Getting started
Configuration
| Environment variable | Default | Description |
|---|---|---|
| BIND_ADDR | :22600 | The host and port to bind to |
| HIERARCHY_API_URL | http://localhost:22600 | The external address of this API |
| GRACEFUL_SHUTDOWN_TIMEOUT | 5s | The graceful shutdown timeout (Go time.Duration format) |
| CODE_LIST_URL | http://localhost:22400 | The external address of the Code List API |
| HEALTHCHECK_INTERVAL | 30s | The time between doing health checks |
| HEALTHCHECK_CRITICAL_TIMEOUT | 90s | The time taken for the health changes from warning state to critical due to subsystem check failures |
Contributing
See CONTRIBUTING for details.
License
Copyright © 2016-2017, Office for National Statistics (https://www.ons.gov.uk)
Released under MIT license, see LICENSE for details
Directories
Click to show internal directories.
Click to hide internal directories.