SSWConsulting / SSWConsulting/SSW.CleanArchitecture
Better Swagger Docs
Open
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 199
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Investigate examples for swagger docs. i.e. better docs than:
myWeirdField: "string" vs myWeirdField: "this-silly-string"
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 by locating the Swagger/OpenAPI documentation and the generated examples in this C# template. Compare the current example showing values such as "string" with the requested more realistic examples. Done means the relevant documentation examples are identified and improved, with the exact scope confirmed before editing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100