getappmap / getappmap/appmap-python
editor.swagger.io flags errors in the OpenAPI description generated for django-oscar
Đang mở
Chưa có ai nhận issue này.
appmap-python
bug
openapi
- Ngôn ngữ chính
- Python
- Star
- 104
- Fork
- 17
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách chạy npx @appland/appmap openapi trên các AppMaps được tạo bởi các bài kiểm thử django-oscar và kiểm tra path được báo cáo quanh dòng 786. So sánh các khai báo tham số path được tạo với các yêu cầu của OpenAPI, đồng thời xem issue #227 để biết thêm ngữ cảnh liên quan. Hoàn tất khi phần mô tả được tạo không còn tạo ra các lỗi đã báo cáo trong editor.swagger.io.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- openapi, python
- Lĩnh vực
- api
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100