Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Correct handling of `style` and `explode`.

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

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
35/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
tooling

Hướng nghiên cứu

Start by locating the query-parameter generation entry point and its handling of OpenAPI parameter style and explode defaults. Compare the generated TypeScript with the OpenAPI 3.0 Parameter Object rules, then add or update tests so the intended output for form-style query parameters is explicit and covered.

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

Mô tả

OpenAPI spec:

targets:

  get:
    tags:
      - targets
    operationId: getProductTargets
    parameters:
      - name: searchParameters
        description: "Some description"
        in: query
        required: true
        schema:
          $ref: "..ProductTargetsSearch"
    responses:
      200:
        description: "Some description"
        content:
          application/json:
            schema:
              $ref: "..GetProductTargetsResponse"
      400:
        description: "Some description"
        content:
          application/json:
            schema:
              $ref: "..ErrorDto"
      500:
        description: "Ошибка на сервере"
        content:
          application/json:
            schema:
              $ref: "..ErrorDto"

Generator emits type for queryParams:

export type GetProductTargetsQueryParams = {
    /**
     * Some description
     */
    searchParameters: Schemas.ProductTargetsSearch;
};

But by spec https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#parameter-object
parameter in: query has default value of style - form. So explode default value is true for form style. Spec says:

When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map

Should generator emit queryParam type with spreaded params? if no, why?

Ngôn ngữ chính
TypeScript
Star
635
Fork
82
Không có pull request nào được merge trong 30 ngày

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 fabien0102/openapi-codegen

Tất cả issue của fabien0102/openapi-codegen

Issue tương tự

Thêm issue về TypeScript

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.