As a user, I want to be able to reference the API documentation without installing or running the application
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- javascript
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
Bắt đầu bằng cách xem xét cách tài liệu REST API hiện đang được cung cấp và điều tra xem HTML, CSS và JavaScript của Swagger UI có thể được lưu trữ công khai trên GitHub Pages hay không. Đánh giá việc triển khai CI từ Master và ảnh hưởng của việc lưu trữ riêng các điều khiển tương tác "try it out". Công việc được xem là hoàn tất khi có một siêu liên kết công khai được ghi lại hoặc chứng minh được rằng cách tiếp cận này không khả thi.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
[Additionally], as a developer of the ATT&CK Workbench REST API I want to be able to share hyperlinks to the API documentation with users of the REST API when they ask questions about the APIs.
We should determine if it is possible to host the REST API documentation somewhere publically for ease of reference.
One possible approach is to pull the Swagger UI's HTML/CSS/JS and host that on GitHub pages, possibly with some sort of CI-deployment system to deploy the docs when pushed to Master. However, the Swagger UI does include interactive elements (i.e the "try it out" buttons) which may invalidate that approach.
- Ngôn ngữ chính
- JavaScript
- Star
- 56
- Fork
- 18
- Merge trung bình
- 21 giờ 14 phút
- Pull request đã merge (30 ngày)
- 10
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc 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.
Issue khác của mitre-attack/attack-workbench-rest-api
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
mitre-attack/attack-workbench-rest-api#513 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
mitre-attack/attack-workbench-rest-api#505 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
mitre-attack/attack-workbench-rest-api#499 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Add ADM validation bypass for server-controlled fields on non-compliant objectsCó thể đã có người làm @seansica đã nhận 12 ngày trước. Đang mở
mitre-attack/attack-workbench-rest-api#517 · 1 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 74/100
mitre-attack/attack-workbench-rest-api#512 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của mitre-attack/attack-workbench-rest-api
Issue tương tự
-
Link Checker ReportĐang mởautomated issue report
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 70/100
microsoft/playwright#43640 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
✏️ Editing - Tags
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
openfoodfacts/openfoodfacts-server#15127 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Add a dark mode toggleĐang mởenhancement good first issue hacktoberfest help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Andbal23/dynamic-music-pill#195 ·
Maintainer thường phản hồi trong vòng 1 ngày