Some protocol that create Schemas that can be loaded into the docs

Open
#16 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
swift
Domain
api, documentation

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.

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.

Dominant language
Swift
Stars
62
Forks
8
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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/VaporOpenAPI

All issues in mattpolzin/VaporOpenAPI

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.