Removing a Query parameter is considered a breaking change while removing a Request Body parameter isn't
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 25/100
Direzione di ricerca
Riprodurre il confronto utilizzando old_queryparameter.yml/new_queryparameter.yml e old_requestbody.yml/new_requestbody.yml dell'issue, quindi esaminare i punti di ingresso del confronto di compatibilità per i parametri di query e gli schemi del corpo della richiesta. Confrontare i risultati riportati con il comportamento previsto per le modifiche incompatibili; controllare la pull request #474 prima di iniziare, perché è già aperta per questa issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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!
- Lingua principale
- Java
- Stelle
- 1.1k
- Fork
- 190
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di OpenAPITools/openapi-diff
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
OpenAPITools/openapi-diff#364 ·
-
bug OpenAP 3.1.0 Support
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
OpenAPITools/openapi-diff#910 · 1 commento ·
-
Render capabilities
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
OpenAPITools/openapi-diff#893 · 1 commento ·
-
Breaking/Non-Breaking classification
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
OpenAPITools/openapi-diff#886 ·
Tutte le issue di OpenAPITools/openapi-diff
Issue simili
-
Bug Java Platform: Java
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
getsentry/sentry-java#6138 · 1 commento ·
-
bug needs triage p2
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
GoogleCloudPlatform/DataflowTemplates#4273 · 1 commento ·
-
[Studio][Bug] Bulk-deleting a full page of alert rules steps the page back while more rules remain Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
apache/rocketmq-dashboard#4654 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100