sort out test properties "skipExample" such that request & response and multiple examples are accounted for.

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi, swift
Domain
documentation

Research direction

Start by locating the handling for the skipExample test property and read how response examples are currently used. Implement support for independently using and validating request examples, plus multiple labeled request and response examples; done means both example directions and multiple labels are represented correctly.

Written by the indexing model from the issue text.

Description

test properties currently just allow you to skip using the response example to validate response data or not.

  • there needs to be a way to use a request example as request body or not (and validate that it matches the schema for the request).
  • there needs to be a way to support multiple labeled examples instead of only supporting a single example.
Dominant language
Swift
Stars
12
Forks
1
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from mattpolzin/JSONAPI-OpenAPI

All issues in mattpolzin/JSONAPI-OpenAPI

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.