Azure / Azure/oav

Swagger Accuracy Report should track/report coverage of response body properties

Open
#868 0 comments 0 reactions 0 assignees View on GitHub
feature request
Dominant language
TypeScript
Stars
104
Forks
62
Avg merge
2d 12h
Merged PRs (30d)
5

Description

The Swagger Accuracy Report currently tracks coverage of operations and reports any operations that are not exercised in a test run. We want to extend coverage checking to properties of the response schema.

Optional properties of a response schema may not be returned for a particular test scenario and that means we cannot confirm that the property is correctly defined in terms of its name and type. So our confidence in the correctness of the API definition should take into account the coverage of response body properties achieved by the tests.

Contributor guide

Open the contributing guide

Research direction

Start by locating the Swagger Accuracy Report implementation and its existing operation-coverage reporting, then trace how response schemas are inspected during a test run. Done means the report tracks which response-body properties are exercised and reports uncovered optional properties alongside existing operation coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.