loopbackio / loopbackio/loopback-next
Introduce getModelSchema and soft-deprecate getModelSchemaRef
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- TypeScript
- Star
- 5.1k
- Fork
- 1.1k
- Merge trung bình
- 2 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 27
Mô tả
Opening a follow up issue according to: https://github.com/strongloop/loopback-next/issues/4328#issuecomment-571638433
Cross posting @bajtos' comment from the above link:
-----
After we land feat(rest): add openapi schema consolidation #4365, I'd like to start the process of deprecating getModelSchemaRef and reworking both our existing code and CLI templates to leverage the new schema consolidation:
- Introduce getModelSchema similar to getModelSchemaRef (see src/controller-spec.ts)
- Rework our controller templates to use getModelSchema instead of getModelSchemaRef
- Rework controllers inside /examples to use getModelSchema
- Soft-deprecate getModelSchemaRef in our documentation (both /docs files and the tsdoc comment)
- Update https://github.com/strongloop/loopback4-example-shopping to use getModelSchema
-----
cc @bajtos @jannyHou
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
Bắt đầu với src/controller-spec.ts và ngữ cảnh schema-consolidation được liên kết để hiểu thay đổi được yêu cầu đối với getModelSchema. Sau đó, kiểm tra các template của controller, các controller trong /examples, các tệp /docs và chú thích tsdoc; công việc được xem là hoàn tất khi các chỗ sử dụng đó và tài liệu dùng getModelSchema, đồng thời ví dụ shopping bên ngoài cũng được cập nhật.
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, typescript
- Lĩnh vực
- api, cli, documentation
- Loại issue
- Tính năng
- Độ 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
- 35/100