[Rendering] R3: new Render API and migration notes

Đang mở
#959 0 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 5 ngày

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
20/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java
Lĩnh vực
tooling

Hướng nghiên cứu

Read the rendering plan in #954 first, then find the current Render entry point and the renderer classes that take ChangedOpenApi/Changed* so you know what is being removed. The migration notes and README output examples depend on the final Render.render(ChangeReport, Writer) signature and the --json, --html-detailed, --template and stderr-logging behaviour, so settle the API before writing docs. Done means no renderer references Changed* classes and the README plus migration notes match the new CLI output.

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

Mô tả

Render capabilities

Part of the rendering plan: #954 (R3)

Goal

The stable 3.0.0 rendering API; old renderer code is removed.

Scope
  • Render.render(ChangeReport, Writer); the caller owns and closes the writer
  • Remove the old renderer code and the deprecated String render(ChangedOpenApi)
  • Migration notes: Render API, --json format, --html-detailed, --template, logs on stderr
  • README: output examples for every format and a template example
Done when
  • No renderer reads Changed* classes or spec objects
  • Migration notes and README updated
Ngôn ngữ chính
Java
Star
1.1k
Fork
191
Merge trung bình
4 ngày 23 giờ
Pull request đã merge (30 ngày)
1

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 OpenAPITools/openapi-diff

Tất cả issue của OpenAPITools/openapi-diff

Issue tương tự

Thêm issue về Java

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.