Description:
Latest main still contains placeholder public comments in inventory/inventory.proto, and those placeholders are propagated into generated documentation and OpenAPI output.
Current behavior:
On latest main, inventory/inventory.proto still has unresolved placeholder comments:
inventory/inventory.proto:167
inventory/inventory.proto:172
// TBD: Type 9 or Type 41 ?
Because these comments are public proto comments, they leak into generated artifacts that are checked into the repository:
inventory/v1/autogen.md:160
total_usable_bytes description is TBD
inventory/v1/autogen.md:171
PCIeDeviceInfo section still says TBD: Type 9 or Type 41 ?
inventory/v1/gen/go/inventory.swagger.json:216
total_usable_bytes has "title": "TBD"
inventory/v1/gen/go/inventory.swagger.json:257
PCIeDeviceInfo description still contains TBD: Type 9 or Type 41 ?
- Generated Go comments also inherit same placeholders:
inventory/v1/gen/go/inventory.pb.go:516
inventory/v1/gen/go/inventory.pb.go:568
v1/gen/go/inventory/inventory.pb.go:498
v1/gen/go/inventory/inventory.pb.go:550
Expected behavior:
Public inventory API comments should use final descriptive wording, not unresolved placeholders, and regenerated docs/swagger should no longer expose TBD.
Why this matters:
- Public API docs look unfinished.
- Generated Swagger/OpenAPI metadata exposes ambiguous placeholder text.
- Low risk cleanup: this is documentation/comment quality work, not a wire-format change.
Issue Reproduction:
- Check out latest
main.
- Run:
rg -n "TBD" \
inventory/inventory.proto \
inventory/v1/autogen.md \
inventory/v1/gen/go/inventory.swagger.json \
inventory/v1/gen/go/inventory.pb.go \
v1/gen/go/inventory/inventory.pb.go
- Observe matches for the placeholder comments and their generated outputs.
Description:
Latest
mainstill contains placeholder public comments ininventory/inventory.proto, and those placeholders are propagated into generated documentation and OpenAPI output.Current behavior:
On latest
main,inventory/inventory.protostill has unresolved placeholder comments:inventory/inventory.proto:167// TBDinventory/inventory.proto:172// TBD: Type 9 or Type 41 ?Because these comments are public proto comments, they leak into generated artifacts that are checked into the repository:
inventory/v1/autogen.md:160total_usable_bytesdescription isTBDinventory/v1/autogen.md:171PCIeDeviceInfosection still saysTBD: Type 9 or Type 41 ?inventory/v1/gen/go/inventory.swagger.json:216total_usable_byteshas"title": "TBD"inventory/v1/gen/go/inventory.swagger.json:257PCIeDeviceInfodescription still containsTBD: Type 9 or Type 41 ?inventory/v1/gen/go/inventory.pb.go:516inventory/v1/gen/go/inventory.pb.go:568v1/gen/go/inventory/inventory.pb.go:498v1/gen/go/inventory/inventory.pb.go:550Expected behavior:
Public inventory API comments should use final descriptive wording, not unresolved placeholders, and regenerated docs/swagger should no longer expose
TBD.Why this matters:
Issue Reproduction:
main.rg -n "TBD" \ inventory/inventory.proto \ inventory/v1/autogen.md \ inventory/v1/gen/go/inventory.swagger.json \ inventory/v1/gen/go/inventory.pb.go \ v1/gen/go/inventory/inventory.pb.go