specmatic / specmatic/docs.specmatic.io
Confusing instruction on getting started
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 1
- Avg merge
- 7h 41m
- Merged PRs (30d)
- 12
Description
In the OpenAPI spec you may have noticed that there is an examples section for petid with a named example called SCOOBY_200_OK.
There are apparently 2 examples called SCOOBY_200_OK.
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 getting-started documentation that describes the OpenAPI examples for petid, then inspect how the two SCOOBY_200_OK entries are presented. Clarify the instruction so the duplicate named examples and the intended example are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100