Page MenuHomePhabricator

x-monitor and x-amples OpenAPI keys should be better documented
Open, Needs TriagePublic


These custom extensions to spec.yaml should be very clearly documented, so that service developers understand their role in automated tests and icinga monitoring.

Through a bit of exploration, we've learned that the built-in integration tests will run x-amples queries during CI, so it's important to either avoid relying on real-world data, or populating that data as fixtures in the test. Monitoring can be configured or disabled per endpoint, builting default queries for the endpoint, optionally with some templated parameters coming from defaults. See