Azure / Azure/azure-openapi-validator

Ability to build ARM summary report

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

Chưa có ai nhận issue này.

Ngôn ngữ chính
TypeScript
Star
53
Fork
57
Merge trung bình
1 ngày 23 giờ
Pull request đã merge (30 ngày)
2

Mô tả

To build confidence in the linter automation we need a summary report in the following format that can be the starting place for API reviewers to review the PRs.

For each RT

RPC category #rules #applicable #success #fail
RPC-V1-PUT 22 22 20 2
RPC-V1-PATCH 11 0 0 0
         

we need to investigate how to fix below issues:

  1. the linter output message should include the RT and/or Namespace field , so we may need to update some rules implementation to relate the swagger paths with the rule
  2. Linter should output message for each passed linter rule execution (currently there is no message for passed rules)
    then we can generate a result base on the linter output message
  3. some rules are implemented as only finding the violations of swagger greedily, so they don't have chance to visit all the swagger paths/operations and these rules need to be re-implemented

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.

Hướng nghiên cứu

Bắt đầu bằng cách lần theo đầu ra của linter và các phần triển khai quy tắc, sau đó kiểm tra cách các đường dẫn và thao tác của Swagger được duyệt. Hoàn thành nghĩa là tạo bản tóm tắt theo từng RT được yêu cầu với số lượng quy tắc, đồng thời bổ sung đủ ngữ cảnh RT hoặc namespace và các thông báo về những quy tắc đã đạt để hỗ trợ việc review API.

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

Đánh giá

Công nghệ
typescript
Lĩnh vực
api, tooling
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
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
25/100

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.