Add openapi.json so it can be viewed by OCS-API Viewer app
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ó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 48/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- openapi
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
Bắt đầu bằng cách so sánh các API endpoint hiện có của Deck với tài liệu API hiện tại tại deck.readthedocs.io và các yêu cầu của ứng dụng OCS-API Viewer. Công việc được xem là hoàn tất khi một openapi.json cho Deck được phát hành và có thể được viewer cùng các công cụ OpenAPI khác sử dụng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
How to use GitHub
- Please use the 👍 reaction to show that you are affected by the same issue.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
- Subscribe to receive notifications on status change and new comments.
Is your feature request related to a problem? Please describe.
When using external automation tools or if you are scripting knowing API endpoints is very important. Currently, there is a quite old API documentation at https://deck.readthedocs.io/en/latest/API/ but e.g. Talk relies on the OCS-API Viewer app for Nextcloud, always displaying the latest API docs. Deck isn't available there.
Describe the solution you'd like
Publish an openapi.json which can be read by the OCS-API Viewer app.
Describe alternatives you've considered
Since I can't find any openapi.json file I can't even use other viewers. Now it's try and error with the old documentation.
Additional context
- Ngôn ngữ chính
- JavaScript
- Star
- 1.4k
- Fork
- 360
- Merge trung bình
- 1 ngày 22 giờ
- Pull request đã merge (30 ngày)
- 101
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay tệp Docker Compose
- 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 nextcloud/deck
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 1 ngày
-
CSV export leaves trailing commas in tags and assigned-user fieldsCó thể đã có người làm @Kumar-s75 đã nhận 42 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Board clone API failure is treated as a successful board responseCó thể đã có người làm @Kumar-s75 đã nhận 42 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
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 78/100
nextcloud/deck#8334 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
1. to develop bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
nextcloud/deck#8146 · 2 bình luận · 2 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của nextcloud/deck
Issue tương tự
-
Buddies in the protocol fuzzĐang mởai-proposed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
area: certificates help wanted priority: must type: docs
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
WNSolutions/digimenu-tn#35 ·
-
bug priority: low
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
sandialabs/sceptre-phenix#464 ·
Maintainer thường phản hồi trong vòng 6 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 66/100
hemilabs/token-list#124 ·
-
Ctrl + w should close dialogsĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 61/100
Maintainer thường phản hồi trong vòng 1 ngày