Support nested schema inside object properties

Đang mở
  • Có gì không ổn?
#379 3 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
42/100
Loại issue
Tính năng
Độ 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

Hướng nghiên cứu

Bắt đầu bằng cách lần theo cách lược đồ phản hồi YAML, các thuộc tính đối tượng và các tham chiếu #/components/schemas được biểu diễn và phân giải. Kiểm tra xem đường dẫn tạo OpenAPI hiện tại có hỗ trợ một lược đồ lồng nhau được tham chiếu với phần mô tả thuộc tính hay không; được xem là hoàn tất khi tạo ra đầu ra hợp lệ cho ví dụ AddressInfo, đồng thời giữ nguyên tham chiếu lồng nhau và phần mô tả, với coverage cho trường hợp này.

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

Mô tả

question

Hi. Maybe I missed, I'm trying to nest a schema to object type properties, but I couldn't found the way to solve this situation.

responses:
  200:
    content:
      application/json:
        schema: 
          type: object
          properties:
            addressInfo:
              $ref: "#/components/schemas/AddressInfo"
              description: Address info.

First I wrote below, but it doesn't work.

schema: 
  type: object
   properties:
     addressInfo:
       $ref: AddressInfo
       description: Address info.

This is one of options, but it can't declare description

schema: 
  type: object
   properties:
     addressInfo: AddressInfo
     # description?

manual binding is not working because AddressInfo is not in #/components/schema

schema: 
  type: object
   properties:
     addressInfo:
       $ref: "#/components/schemas/AddressInfo" # not defined. 
       description: Address info.

Is there a proper solution for this? 🙏 Thanks.

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.