openapi-generators / openapi-generators/openapi-python-client

Support for multiple content types in error response

Đang mở
#1,248 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.

Ngôn ngữ chính
Python
Star
2k
Fork
293
Merge trung bình
34 phút
Pull request đã merge (30 ngày)
1

Mô tả

Describe the bug
Similar to previous issues about multiple content types support like https://github.com/openapi-generators/openapi-python-client/issues/453 or https://github.com/openapi-generators/openapi-python-client/issues/1004

For a single endpoint, the same error code can be returned by different piece of software. For example, an application can return error details as application/json but have some infra elements in front (cloud gateway/load balancer/reverse proxy/firewall) that can block request and also return their own errors in their own format text/json/xml (usually for network errors 401,403,502,503,504).

In my use case, I realized a firewall can sometimes block requests and returns a text/plain with a string Access Forbidden. So I'm trying to represent that in my OpenAPI spec so the generated client can handle these errors properly without crashing, and this works for some of the other openapi generators. But it doesn't work well with this python client, because the content type is not validated in the generated code. It only depends on the first content declared in the schema and seems to ignore the other ones.

So I'm getting the following implementation:

if response.status_code == 403:
  response_403 = APIError.from_dict(response.json())

Which works for json error, but json parsing throw an exception if it's something else (like text/plain)

And if I declare text/plain before application/json, I get:

if response.status_code == 403:
  response_403 = response.text

But in that case, I'm losing any detail about the json error.

What I expect here, is something similar to the oapi-codegen golang implementation.
If there are multiple content types defined for an error code, check that the response content type match before handling it.
So each content type can coexist and be handled separately.

case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403:
    // this is a json error
    var dest APIError
    if err := json.Unmarshal(bodyBytes, &dest); err != nil {
      return nil, err
    }
    response.JSON403 = &dest
case rsp.StatusCode == 403:    
    ... // default case for text/plain error

OpenAPI Spec File

403:
  description: Forbidden
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/APIError'
    text/plain:
      schema:
        type: string

Desktop (please complete the following information):

  • OS: macOS 14.7.4
  • Python Version: 3.11.88
  • openapi-python-client version: 0.24.3

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

Sử dụng response 403 OpenAPI được cung cấp với application/json và text/plain để tái hiện cách xử lý hiện tại của client được sinh ra. Kiểm tra đường dẫn error-response của client được sinh ra và chạy phần sinh client liên quan cùng các bài kiểm thử response, nếu có. Hoàn thành có nghĩa là client được sinh ra chọn cách xử lý dựa trên Content-Type của response, để các chi tiết JSON vẫn khả dụng mà không cố gắng phân tích text/plain dưới dạng JSON.

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

Đánh giá

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