Redocly / Redocly/openapi-starter
Add securitySchemes example for multi-file structure
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 220
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
Describe the problem to be solved
No current example exists for a multi-file directory structure using multiple different forms of authentication.
Describe the solution you'd like
Include a components/schemas/securitySchemes example to illustrate how to implement the structure in other projects.
Describe alternatives you've considered
Also nice to add: examples in the multi-file guide.
Additional context
N/A
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 the repository's existing multi-file examples and the linked multi-file guide. Add a securitySchemes example showing multiple authentication forms in a multi-file directory structure, and update the guide if appropriate; done means the example clearly demonstrates the requested structure.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100