OpenAPITools / OpenAPITools/openapi-diff
Removing a Query parameter is considered a breaking change while removing a Request Body parameter isn't
- Lenguaje dominante
- Java
- Estrellas
- 1.1k
- Forks
- 190
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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!
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduzca la comparación utilizando old_queryparameter.yml/new_queryparameter.yml y old_requestbody.yml/new_requestbody.yml del issue y, a continuación, inspeccione los puntos de entrada de la comparación de compatibilidad para los parámetros de consulta y los esquemas del cuerpo de la solicitud. Compare los resultados informados con el comportamiento esperado de los cambios incompatibles; revise la pull request #474 antes de comenzar porque ya está abierta para este issue.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, openapi
- Área
- api
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100