swagger-api / swagger-api/swagger.io-docs
ExternalDocs is not in General info
Open
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
The page General Info says that the info includes ExternalDocs and I found out it does not after looking to the reference. It is at the same level as Info. Please change that as it is misleading
From site :
From reference :
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 with the General Info page at https://swagger.io/docs/specification/api-general-info/ and compare its description with the OpenAPI 3.0 fixed-fields reference linked in the issue. Update the documentation so ExternalDocs is described at the correct level, then review the rendered page to confirm the misleading statement is gone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100