OAI / OAI/OpenAPI-Specification

Create „pass“ test cases from examples in `oas.md`

Open
#4,803 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Housekeeping
Dominant language
Markdown
Stars
31.2k
Forks
9.2k
Avg merge
6h 37m
Merged PRs (30d)
27

Description

Given the growing number of examples in the specification, it would be nice to (semi-)automatically create „pass“ test cases from Markdown spec text.

This would help keeping the examples correct and simplify reaching sufficient schema test coverage.

Might be a nice hobby project for someone.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the examples in oas.md and the repository's existing test structure. Determine how examples can be identified and converted into pass test cases, then define a repeatable way to verify that generated cases remain valid as the specification grows.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, openapi
Domain
api, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.