Skip to content

api-coverage: include live-discovered model gaps in coverage report and CI artifact #54

Description

@axisrow

Problem

The current API coverage artifact can report strict_parity_ok: true while the declared WSDL coverage model is missing live Yandex Direct API services.

The latest audit found two live WSDL services that are not represented in the current declared model or CLI surface:

API service Missing methods
dynamicfeedadtargets add, delete, get, resume, setBids, suspend
strategies add, archive, get, unarchive, update

This means the existing strict parity result is accurate only inside the declared model, but the machine-readable artifact does not make the model gap explicit enough.

Required changes

  • Extend scripts/build_api_coverage_report.py with a model_gaps section.
  • Include counts for declared WSDL services/methods and live-discovered services/methods.
  • Include live_discovered_missing_services and missing method details.
  • Add summary.live_model_parity_ok separately from summary.strict_parity_ok.
  • Update .github/workflows/api-coverage.yml so the CI step summary prints these fields.
  • Update README policy text to explain declared strict parity vs live-discovered model gaps.
  • Keep the detailed human-readable coverage matrix near the tests.

Acceptance criteria

  • api_coverage_report.json includes model_gaps.
  • CI artifact preserves full machine-readable details.
  • CI step summary prints declared counts, live-discovered counts, model gap count, and missing service names.
  • README no longer implies that strict_parity_ok alone proves full live Yandex API coverage.
  • Issue test: roadmap for broader CLI/API coverage beyond current contract baseline #41 is updated with the current diff and a link to this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions