OpenAPITools / OpenAPITools/openapi-diff
Removing a Query parameter is considered a breaking change while removing a Request Body parameter isn't
- Ngôn ngữ chính
- Java
- Star
- 1.1k
- Fork
- 190
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
While testing this tool, we've noticed that removing a query parameter would give a API changes broke backward compatibility result while removing a request body parameter would return a API changes are backward compatible. Shouldn't both be breaking changes?
If this is expected, we'd be curious to understand why that is.
Here are the spec files we used to test this:

old_queryparameter.yml :
openapi: "3.0.1"
info:
title: "Public Api"
description: ""
version: "2022-08-23T16:17:54Z"
servers:
- url: "https://someurl"
variables:
basePath:
default: "/v1"
paths:
/auth:
post:
parameters:
- name: "Username"
in: "query"
required: true
schema:
type: "string"
- name: "Password"
in: "query"
required: true
schema:
type: "string"
new_queryparameter.yml :
openapi: "3.0.1"
info:
title: "Public Api"
description: ""
version: "2022-08-23T16:17:54Z"
servers:
- url: "https://someurl"
variables:
basePath:
default: "/v1"
paths:
/auth:
post:
parameters:
- name: "Username"
in: "query"
required: true
schema:
type: "string"

old_requestbody.yml:
openapi: "3.0.1"
info:
title: "Public Api"
description: ""
version: "2022-08-23T16:17:54Z"
servers:
- url: "https://someurl"
variables:
basePath:
default: "/v1"
paths:
/auth:
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthRequest"
required: true
components:
schemas:
AuthRequest:
required:
- "Username"
- "Password"
type: "object"
properties:
Username:
type: "string"
Password:
type: "string"
new_requestbody.yml:
openapi: "3.0.1"
info:
title: "Public Api"
description: ""
version: "2022-08-23T16:17:54Z"
servers:
- url: "https://someurl"
variables:
basePath:
default: "/v1"
paths:
/auth:
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthRequest"
required: true
components:
schemas:
AuthRequest:
required:
- "Username"
type: "object"
properties:
Username:
type: "string"
Thank you!
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
Tái hiện phép so sánh bằng cách sử dụng old_queryparameter.yml/new_queryparameter.yml và old_requestbody.yml/new_requestbody.yml từ issue, sau đó kiểm tra các entry point của phép so sánh tính tương thích cho các tham số truy vấn và schema của request body. So sánh các kết quả được báo cáo với hành vi breaking change dự kiến; kiểm tra pull request #474 trước khi bắt đầu vì nó đã được mở cho issue này.
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
- Lĩnh vực
- api
- 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
- 25/100