swagger-api / swagger-api/swagger-core
`AnnotatedType` is missing javadoc
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 7.5k
- Forks
- 2.3k
- Avg merge
- 18h 1m
- Merged PRs (30d)
- 10
Description
While investigating an issue related to types and inheritance, seems like working on a ModelConverter is the answer.
But when trying to work on that, I've found extremely hard because AnnotatedType has no javadoc at all.
Some solutions found here, for instance, suggest marking resolveAsRef as false.
Others do check validations on type depending on the parent value.
Even though most of that is quite "guessable" after playing with swagger for a while, having javadoc is crucial in my opinion.
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
Locate the AnnotatedType class and read how its type, parent, and resolveAsRef members are used by ModelConverter implementations. Add Javadoc that explains the class and these concepts, then verify that the documentation accurately reflects the existing usage and intended behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100