Logflare / logflare / d0d57969aba21aac837baa1c9533eb9c6a6935c6

81%

Build Type

push

github

Committed by web-flow

Commit Message

fix: correct OpenAPI schema property/required mismatches, fix Postgres password redaction gap (#3663)

Audit of lib/logflare_web/open_api_schemas.ex against the underlying Ecto
schemas/changesets/Jason.Encoder impls found several mismatches between
the hand-written OpenAPI schemas and the resources they document:

- RuleApiSchema: required: [:name] referenced a field Rule doesn't have
  (copy/paste artifact) -- the real required field is lql_string per
  Rule.changeset/2. Drop inserted_at/updated_at properties -- Rule's
  encoder never serializes them. Add sink to both the encoder's only:
  list (missing -- sink is the "route matching events to this other
  source" field, cast via changeset/2 and editable in the Rules UI at
  rules_live.html.heex) and as an OpenAPI property.
- EndpointApiSchema: add redact_pii, enable_dynamic_reservation, labels
  properties. Add language and backend_id to the encoder's only: list
  (both missing -- language is now serialized; backend_id is cast via
  changeset/2 and read back into the edit form in endpoints_live.ex,
  i.e. a genuine UI-facing field with no way to read it via the API).
  language is NOT added to required: infer_language_from_backend/1 runs
  before validate_required/2 and always fills it in (default :bq_sql, or
  inferred from backend_id) when omitted, so the API never actually
  requires a client to submit it -- marking it required in the shared
  request/response schema would make the docs stricter than reality.
- BackendApiSchema: add type and description properties; required now
  [:name, :type, :config] matching Backend.changeset/2's
  validate_required/2 (both type and config are response-serialized).
  Replace config's generic %Schema{type: :object} with a documentation
  anyOf across 13 new per-backend-type config schemas (WebhookConfigSchema,
  DatadogConfigSchema, SentryConfigSchema, PostgresConfigSchema,
  BigQueryConfigSchema, LokiConfigSchema, ClickhouseConfigSchema,
  IncidentioConfigSch... (continued)

Coverage Stats

3 of 4 new or added lines in 1 file covered. (75.0%)

2 existing lines in 2 files now uncovered.

13569 of 16613 relevant lines covered (81.68%)

5076.3 hits per line