An open API service indexing awesome lists of open source software.

https://github.com/onsdigital/dp-data-api

ONS Data API
https://github.com/onsdigital/dp-data-api

Last synced: 5 months ago
JSON representation

ONS Data API

Awesome Lists containing this project

README

          

# dp-data-api
ONS Data API

### Getting started

* Run `make debug` to run application on http://localhost:29300
* Run `make help` to see full list of make targets

### Dependencies

* No further dependencies other than those defined in `go.mod`

### Configuration

| Environment variable | Default | Description
| ---------------------------- | ------------------ | -----------
| BIND_ADDR | :29300 | The host and port to bind to
| GRACEFUL_SHUTDOWN_TIMEOUT | 5s | The graceful shutdown timeout in seconds (`time.Duration` format)
| HEALTHCHECK_INTERVAL | 30s | Time between self-healthchecks (`time.Duration` format)
| HEALTHCHECK_CRITICAL_TIMEOUT | 90s | Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (`time.Duration` format)
| OTEL_EXPORTER_OTLP_ENDPOINT | localhost:4317 | Endpoint for OpenTelemetry service
| OTEL_SERVICE_NAME | dp-data-api | Label of service for OpenTelemetry service
| OTEL_BATCH_TIMEOUT | 5s | Timeout for OpenTelemetry
| OTEL_ENABLED | false | Feature flag to enable OpenTelemetry

### Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details.

### License

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

Released under MIT license, see [LICENSE](LICENSE.md) for details.