loopbackio / loopbackio/loopback-next
Overriding title in `getModelSchemaRef` causes duplication in OpenAPI schema
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ả
Steps to reproduce
Define a controller with getModelSchemaRef(SomeModel, {title: 'TitleOverride'}).
Controller definition
export class UserController {
@post('/users', {
security: OPERATION_SECURITY_SPEC,
responses: {
'200': {
description: 'User',
content: {
'application/json': {
schema: {
'x-ts-type': User,
},
},
},
},
},
})
async create(
@requestBody({
content: {
'application/json': {
schema: getModelSchemaRef(NewUserRequest, {
title: 'NewUser',
}),
},
},
})
newUserRequest: NewUserRequest,
): Promise<User> {
// implementation
}
}
Current Behavior
The controller above emits schema definitions for both NewUserRequest and NewUser. While NewUserRequest is not referenced anywhere else in the schema.
Expected Behavior
Only NewUser is present in OpenAPI schema.
Additional information
@loopback/repository-json-schema@2.4.2
@loopback/openapi-v3@3.4.1
I presume NewUserRequest is generated from getModelSchemaRef as it should while NewUser comes from parsing paramTypes where it causes a cache miss due to overridden title.
A probable fix could exclude a parameter corresponding to requestBody from enumeration here
Acceptance Criteria
- Don't generate unused schema for parameter decorated with
@requestBody
A solution I can think of is:
https://github.com/strongloop/loopback-next/blob/7f8d8356946dc236dd4daecbfae12e0a0662cf1c/packages/openapi-v3/src/controller-spec.ts#L329
should search through the content objects in the request body spec, if all contents' schemas exist in reference, then skip generating the one inferred from model ctor.
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 trong packages/openapi-v3/src/controller-spec.ts, tại khu vực liệt kê tham số được tham chiếu, và theo dõi cách các schema của requestBody cùng các hàm khởi tạo model được suy luận đi vào các component của OpenAPI. Tái hiện trường hợp ghi đè title, sau đó xác minh rằng một request body có schema đã được tham chiếu không tạo ra schema trùng lặp không được sử dụng.
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, backend-api-design
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 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
- 42/100