OAI / OAI/OpenAPI-Specification

Share header with multiple response objects

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

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

re-use: globals/defaults
Ngôn ngữ chính
Markdown
Star
31.2k
Fork
9.2k
Merge trung bình
6 giờ 37 phút
Pull request đã merge (30 ngày)
27

Mô tả

Can there not just be a simple header generically at the response level not specific to each of the status codes? For our case, this kind of header is 99% the same across our codebase.


---

responses:
  200:
    description: no error
    headers:
      Content-Type:
        description: application/json
        type: string

It would be a pain to copy+paste this to each and every routine that supports HTTP JSON responses.

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 đọc các quy tắc của response object trong repository OpenAPI Specification và so sánh cách các header hiện được định nghĩa dưới từng mã trạng thái. Xác định phạm vi và cấu trúc hợp lệ cho một header dùng chung ở cấp response, sau đó cập nhật phần văn bản đặc tả liên quan và các ví dụ để hành vi của tính năng trở nên rõ ràng, không mơ hồ.

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

Đánh giá

Công nghệ
openapi
Lĩnh vực
api
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
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/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.