Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

feature request: Make "Permissions" API objects consistent

Đang mở
#29 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

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
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
openapi, typescript
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu bằng cách so sánh các đối tượng Permissions trong đặc tả API cho Set Role Permission và Create Role, sử dụng các operation được liên kết làm điểm bắt đầu. Xác định tên trường nào nên là tên chuẩn, sau đó theo dõi cách các kiểu TypeScript và đầu ra được OpenAPI tạo ra biểu diễn cả hai schema. Công việc được xem là hoàn tất khi các model API sử dụng một biểu diễn nhất quán mà không cần xử lý giải tuần tự hóa dư thừa.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement
What do you want to see?

There are multiple places in the API spec where an object representing a role's permissions (allowed and denied) is expressed, but I've noticed an inconsistency: Sometimes the fields are allow and deny (example: Set Role Permission), and sometimes they are a and d (example: Create Role). Could this be fixed up and unified in one way or another? It would make some API wrappers' lives easier not needing to include special JSON deserialization logic to handle the same model with differing field names, or having to include redundant model code. 😄

Ngôn ngữ chính
TypeScript
Star
42
Fork
34
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stoatchat/javascript-client-api

Tất cả issue của stoatchat/javascript-client-api

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.