mattpolzin / mattpolzin/jsonapi-openapi-test-server
add OpenAPI validation that no JSON:API attributes have `_id` suffix or `id` name.
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 6
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
it is almost never a good idea to put anything named an id into the JSON:API attributes. For the rare case where you need to ignore best practices, this validation should also pay attention to a x-no-validation escape hatch.
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
Locate the Swift code that builds or validates the OpenAPI/JSON:API test suite and start by reading its existing validation and schema-extension handling. Done means attribute names equal to id or ending in _id are rejected unless the x-no-validation escape hatch is present, with coverage in the relevant test suite.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, swift
- Domain
- api, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100