mattpolzin / mattpolzin/OpenAPIKit
Add support for specifying JSON schema dialects
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 333
- Forks
- 49
- Avg merge
- 19h 9m
- Merged PRs (30d)
- 10
Description
See Specifying Schema Dialects in the new spec.
This change will impact both the JSONSchema type and the root document type (where a default dialect is allowed to be specified).
Note that OpenAPIKit will not (at this time) do anything with values of these fields other than store/encode/decode them. In the future we may indicate what values (i.e. what schema dialects) are supported by OpenAPIKit but for now we will not change the behavior of OpenAPIKit in response to the dialect specified.
Work on types in the OpenAPIKit (not OpenAPIKit30) module.
Contributor guide
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 in the OpenAPIKit module with the JSONSchema type and the root document type, as identified in the issue. Read their existing Codable storage and encoding/decoding paths, then add the dialect fields without changing behavior based on their values. Done means both types can store and round-trip the specified dialect information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100