Redocly / Redocly/openapi-starter
Add a oneOf to the example API description
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- C#
- Stars
- 220
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
We have a simple API description, but to show off some more complex examples, add an example of using oneOf to the API description.
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
Locate the simple API description in the repository and review how its existing examples are structured. Add an example that demonstrates oneOf, then verify that the API description remains valid and the new example appears in the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100