mattpolzin / mattpolzin/VaporOpenAPI
Some protocol that create Schemas that can be loaded into the docs
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 62
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
I notice that the models does not get generated as a schema in the docs and has to be manually imported. There probably is a way now to do it but if not this will be a good enhancement to this. Like a struct to inherit a some kind of schema that gets loaded when creating the docs.
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 reviewing how models are currently manually imported as schemas when the docs are created. Trace the model and schema generation entry points described in the issue, then determine how an inheritable protocol or schema mechanism would fit. Done means models can generate schemas that are automatically loaded into the documentation without manual imports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100