Changes reported in operations but only securityScheme changed
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 55/100
Piste de recherche
Commencez par reproduire le rapport avec les deux documents OpenAPI 3.1 présentés et la dépendance openapi-diff-core 2.1.6. Suivez la manière dont les modifications apportées à authorizationUrl et tokenUrl du securityScheme OAuth2 sont attribuées à POST /users, puis mettez à jour l’emplacement de la modification signalée et vérifiez que le message résultant identifie la modification du security-scheme.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
I am using
testImplementation("org.openapitools.openapidiff:openapi-diff-core:2.1.6") {
exclude(group = "io.swagger.core.v3", module = "swagger-core")
exclude(group = "io.swagger.core.v3", module = "swagger-models")
exclude(group = "io.swagger.core.v3", module = "swagger-annotations")
}
Given the two API docs to compare where the only change is in authorizationUrl ('' vs. 'some_value') and tokenUrl ('' vs. 'some_value').
First file
components:
securitySchemes:
OAuth2:
bearerFormat: JWT
flows:
authorizationCode:
authorizationUrl: ''
tokenUrl: ''
in: header
scheme: bearer
type: oauth2
info:
title: Company API
version: V0
openapi: 3.1.0
paths:
/users:
post:
operationId: createUser
responses:
"201":
description: Created
security:
- OAuth2: []
servers:
- description: Default Server URL
url: /api/
Second file
components:
securitySchemes:
OAuth2:
bearerFormat: JWT
flows:
authorizationCode:
authorizationUrl: 'some_value'
tokenUrl: 'some_value'
in: header
scheme: bearer
type: oauth2
info:
title: Company API
version: V0
openapi: 3.1.0
paths:
/users:
post:
operationId: createUser
responses:
"201":
description: Created
security:
- OAuth2: []
servers:
- description: Default Server URL
url: /api/
The resulting error message is misleading as the issue is not directly related to any concrete endpoint. This took me quite a while to narrow this down to this difference.
So it would be nice to have a more suitable error message.
org.opentest4j.AssertionFailedError: [### Company API (v V0)
---
#### What's Changed
---
##### `POST` /users
#### Result
---
API changes broke backward compatibility
]
- Langage dominant
- Java
- Étoiles
- 1.1k
- Forks
- 190
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OpenAPITools/openapi-diff
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
OpenAPITools/openapi-diff#364 ·
-
bug OpenAP 3.1.0 Support
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
OpenAPITools/openapi-diff#910 · 1 commentaire ·
-
Breaking/Non-Breaking classification
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
OpenAPITools/openapi-diff#886 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
OpenAPITools/openapi-diff#883 ·
Toutes les issues de OpenAPITools/openapi-diff
Issues similaires
-
1.0.0-rc2
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
wso2/dpdp-accelerator#377 ·
Les mainteneurs répondent en général sous 1 jour
-
area/dependencies backport/26.4 kind/cve severity/high source/scan-dependencies status/triage
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 2 jours
-
(primitive-collections-base) Use `NumberInput` to parse numeric map keys, as `jackson-databind` doesOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
FasterXML/jackson-datatypes-collections#270 ·
Les mainteneurs répondent en général sous 1 jour
-
type/bug
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour