Problem
74/341 (22%) query params render with an empty description because their proto fields carry no leading comment. The list_military_flights.proto fields are commented (those descriptions are populated) — that's the model to copy.
Scope (empty-desc params by service)
Economic(2), Forecast(2), Imagery(4), Infrastructure(3), Intelligence(13), Market(14), Military(8), Natural(1), Resilience(1), Sanctions(3), SupplyChain(16), Thermal(1), Webcam(6).
Single upstream fix
Add a leading comment to every (sebuf.http.query) field (mirror the flights proto), and add a buf-lint rule that fails CI when a query field lacks a comment. Comments flow into description on regenerate. Coordinate with the existing tests/generated-api-description-guard.test.mjs allow-list (retire entries as they're fixed).
Acceptance criteria
- 0 query params with empty
description across all specs.
- buf-lint (or the description-guard test) blocks a new uncommented query field.
Part of the umbrella audit #4599. Sibling workstreams: #4595 (bbox 400/router), #4602 (auth — in flight).
Problem
74/341 (22%) query params render with an empty
descriptionbecause their proto fields carry no leading comment. Thelist_military_flights.protofields are commented (those descriptions are populated) — that's the model to copy.Scope (empty-desc params by service)
Economic(2), Forecast(2), Imagery(4), Infrastructure(3), Intelligence(13), Market(14), Military(8), Natural(1), Resilience(1), Sanctions(3), SupplyChain(16), Thermal(1), Webcam(6).
Single upstream fix
Add a leading comment to every
(sebuf.http.query)field (mirror the flights proto), and add a buf-lint rule that fails CI when a query field lacks a comment. Comments flow intodescriptionon regenerate. Coordinate with the existingtests/generated-api-description-guard.test.mjsallow-list (retire entries as they're fixed).Acceptance criteria
descriptionacross all specs.Part of the umbrella audit #4599. Sibling workstreams: #4595 (bbox 400/router), #4602 (auth — in flight).