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

[Schema Inaccuracy] Code Scanning Alert

Đang mở
#4,728 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.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
55/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github, openapi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu với schema của endpoint cảnh báo code scanning của tổ chức được liên kết trong issue và kiểm tra cách enum phân loại response được định nghĩa. Xác nhận rằng "documentation" là một giá trị quan sát được hợp lệ, sau đó cập nhật schema để enum bao gồm giá trị này và xác minh rằng mô tả endpoint vẫn nhất quán.

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

Mô tả

documentation

Schema Inaccuracy

The Response Schema for the code scanning alert endpoint(for organizations) defines 4 valid values for classifications. When using this endpoint we sometimes get the value "documentation" which is not listed.

"code-scanning-alert-classification": {
        "type": "string",
        "description": "A classification of the file. For example to identify it as generated.",
        "nullable": true,
        "enum": [
          "source",
          "generated",
          "test",
          "library"
        ]
      },

Expected

The schema should include all values

"code-scanning-alert-classification": {
        "type": "string",
        "description": "A classification of the file. For example to identify it as generated.",
        "nullable": true,
        "enum": [
          "source",
          "generated",
          "test",
          "library",
          "documentation"
        ]
      },

Reproduction Steps

Due to the sensitive nature of the alerts I cannot provide an explicit example.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1.6k
Fork
342
Merge trung bình
2 giờ 23 phút
Pull request đã merge (30 ngày)
57

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 github/rest-api-description

Tất cả issue của github/rest-api-description

Issue tương tự

Thêm issue về Backend & API Design

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.