getappmap / getappmap/appmap-python
editor.swagger.io flags errors in the OpenAPI description generated for django-oscar
Open
Nobody has claimed this yet.
appmap-python
bug
openapi
- Dominant language
- Python
- Stars
- 104
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
npx @appland/appmap openapi on the AppMaps generated by the tests for django-oscar shows errors, e.g.
Semantic error at paths./catalogue/category/{category_slug}_101{pk}/
Declared path parameter "category_slug" needs to be defined as a path parameter at either the path or operation level
Jump to line 786
It's possible that these are related to #227.
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 by running npx @appland/appmap openapi on the AppMaps generated by the django-oscar tests and inspect the reported path around line 786. Compare the generated path parameter declarations with the OpenAPI requirements, and review issue #227 for related context. Done means the generated description no longer produces the reported errors in editor.swagger.io.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100