mattpolzin / mattpolzin/JSONAPI-OpenAPI
sort out test properties "skipExample" such that request & response and multiple examples are accounted for.
Open
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 12
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- openapi, swift
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100