Skip to content

OpenAPI info block: stale description + missing contact field #362

@CryptoJones

Description

@CryptoJones

Two issues with info in app/config/openapi.js:

  1. Description undersells the API: says "Customer and time-entry records" — 16 entities ago. Operators reading the spec in Swagger UI / docs aggregators get a misleading impression of the surface.
  2. No contact field: SECURITY.md documents the vuln-report channel (private advisory + email fallback) but Swagger UI's info panel never surfaces it. Operators reading the docs in a browser have to leave the spec page to find the policy.

Fix: expand description to mention the 16-entity surface + the operator-relevant feature set (idempotency, Link pagination, /metrics, CSV export). Add contact: { name, url } linking to the GH security policy.

Pin both with assertions in tests/api/openapi.test.js.

Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions