swagger-api / swagger-api/swagger-core
Example missing for @ExternalDocumentation
Open
Nobody has claimed this yet.
backlog
- Dominant language
- Java
- Stars
- 7.5k
- Forks
- 2.3k
- Avg merge
- 18h 1m
- Merged PRs (30d)
- 10
Description
The example for @ExternalDocumentation in the wiki doesn't actually use @ExternalDocumentation
It's only a copy/paste from the previous example from the annotation @Hidden
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
Open the Swagger 2.X Annotations wiki and inspect the ExternalDocumentation section linked in the issue, comparing it with the preceding Hidden example. Update the example so it actually uses @ExternalDocumentation rather than copying the @Hidden example, then verify the wiki text is accurate and readable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100