Redocly / Redocly/openapi-starter
Update documentation links from referencing 3.0.2 to 3.1.0
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 220
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
This repo's spec is in OpenAPI 3.1.0:
https://github.com/Redocly/openapi-starter/blob/d6c17acb15dab2f44a3e64a54b1c0c257180e93e/openapi/openapi.yaml#L1
But the links here are to the 3.0.2 markdown file when 3.1.0.md exists:
https://github.com/Redocly/openapi-starter/blob/d6c17acb15dab2f44a3e64a54b1c0c257180e93e/openapi/openapi.yaml#L22
It may be enough to change the links and be done with it, but I am unsure if there's also other parts of this template that need a 3.0.2 -> 3.1.0 upgrade.
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 with openapi/openapi.yaml, especially the specification declaration at line 1 and the links around line 22. Search the template for other references to OpenAPI 3.0.2, then verify that relevant links point to the 3.1.0 specification and that no outdated references remain.
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
- Mostly clear
- Newbie friendliness
- 58/100