Marshmallow’s Nested fields with a restricted schema steal the full schema’s registry spot

Đang mở
  • Có gì không ổn?
#591 14 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
52/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
openapi, python
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

Bắt đầu tại src/apispec/ext/marshmallow/openapi.py, khoảng dòng 108, và tái hiện vấn đề bằng ví dụ FooSchema sử dụng một trường Nested bị giới hạn. Xác minh rằng việc đăng ký FooSchema không đặt trước BarSchema chỉ với các trường bị giới hạn, và rằng một lần đăng ký sau đó vẫn giữ nguyên schema đầy đủ.

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

Mô tả

If we e.g. have a marshmallow Schema like this:

from marshmallow_sqlalchemy import fields, SQLAlchemyAutoSchema

class FooSchema(SQLAlchemyAutoSchema):
	parent = fields.Nested("BarSchema", only=("id", "name"))

and call spec.components.schema('Foo', schema=FooSchema), then “BarSchema” gets registered as having only the fields id and name, and subsequent tries to register the real thing fail.

The problem lies here:

https://github.com/marshmallow-code/apispec/blob/d418e3efa27f799ae3dabbdbb00ccd07eb10ce07/src/apispec/ext/marshmallow/openapi.py#L108

As that function somehow doesn’t give us something useful. Also it should first modify names for schemas where schema.only is not None before it modifies schemas where schema.only is None.

Ngôn ngữ chính
Python
Star
1.2k
Fork
210
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
4

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 marshmallow-code/apispec

Tất cả issue của marshmallow-code/apispec

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.