api: the OpenAPI document allows null on_value and off_value for a flag, which the API refuses

Đang mở
  • Có gì không ổn?
#1,571 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
30/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
openapi, python
Lĩnh vực
api

Hướng nghiên cứu

Start with the FeatureFlagCreate and FeatureFlagUpdate schemas in docs/api/openapi-v1.full.json and docs/api/openapi-v1.stable.json, where on_value and off_value lack a type. Check the API's Python validation that returns null_not_allowed, and follow the #954 stability row as the format for any new entry. Done means both properties exclude null in the served document, a test pins that, and both snapshots are regenerated. The fix needs serial merge ordering and a fuzz run before merge, so confirm with maintainers first.

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

Mô tả

bug post-launch

The served OpenAPI document leaves on_value and off_value on FeatureFlagCreate and FeatureFlagUpdate without a type, so it allows any JSON value, null included. The API refuses null for them: in a measured run, 135 of 150 flag creates that the document allows answered 422 with null_not_allowed.

Both snapshots (docs/api/openapi-v1.full.json and docs/api/openapi-v1.stable.json) carry the untyped properties since #1514, which is not yet in a release. The next release would publish them in the stable document; fixing them after that needs a stability row (the #954 row is the shape), with no behaviour change.

Expected

The document describes exactly what the API accepts for on_value and off_value, and a test pins it.

Notes

The fix changes the request side of the served document, so it is its own pull request, regenerates both snapshots (merged serially with the other snapshot pull requests) and dispatches the API fuzz run before merge.

Priority

LOW.

Ngôn ngữ chính
Python
Star
0
Fork
4
Merge trung bình
5 giờ 36 phút
Pull request đã merge (30 ngày)
509

Chuẩn bị môi trường

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 Controlvar/controlvar

Tất cả issue của Controlvar/controlvar

Issue tương tự

Thêm issue về Python

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.