openapi-processor / openapi-processor/openapi-processor-spring
interpretation of openapi readOnly flag in model
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Kotlin
- Star
- 56
- Fork
- 11
- Merge trung bình
- 2 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 8
Mô tả
Given a definition like:
``yaml
Data:
type: object
properties:
status:
type: string)
readOnly: true
get generated java:
```java
public record Data {
@JsonProperty(value = "status", access = JsonProperty.Access.READ_ONLY)
String status
) {}
This is correct if the generated code is for the provider of the interface (i.e. server-side). But if the code is to be the client of the interface, the field should instead be annotated with JsonProperty.Access.WRITE_ONLY.
So, as a feature request, it would be useful if there was a code generation option that declared the intended usage of the generated code.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Issue không xác định tệp mã nguồn, test hoặc điểm vào nào. Hãy bắt đầu bằng việc truy vết cách generator ánh xạ các thuộc tính readOnly của OpenAPI vào các chú thích truy cập của Jackson, sau đó xác định nơi nên cấu hình tùy chọn sinh mã provider-versus-client và định nghĩa các test bao phủ cả hai chế độ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- java, openapi, spring-boot
- Lĩnh vực
- backend-api-design, tooling
- 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
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100