getappmap / getappmap/appmap-js
swagger: swagger.io reports errors in docs generated from Java AppMaps
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 53
- Forks
- 18
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 8
Description
swagger.io complains about these issues in API docs generated from Petclinic app AppMaps:
- missing property
openapi: 3.0.0 - string parameter types declared as
java.lang.stringinstead ofstring - missing property
info:
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 the attached petclinic.swagger.yml and trace the TypeScript code that generates Swagger/OpenAPI docs from Java AppMaps. Check how the OpenAPI version, info metadata, and string parameter types are emitted. Done means the generated document includes valid openapi and info properties, uses string rather than java.lang.string, and is accepted by swagger.io.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, typescript
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100