Introduce check concept from "Azure/openapi-diff" project
Les mainteneurs répondent en général sous 5 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- openapi
- Domaine
- api
Piste de recherche
Commencez par lire la documentation de Azure/openapi-diff et ses tests openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger, puis comparez les vérifications qu’ils signalent avec le comportement actuel de comparaison de ce projet. L’issue ne nomme aucun fichier local ni point d’entrée ; sa réalisation nécessiterait de convenir d’un périmètre d’intégration et des vérifications correspondantes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
The project Azure/openapi-diff produce following output when two versions of a spec are compared: a list of items (error, warning, info) is computed.
Example:
$ oad compare old/added_path.json new/added_path.json
{
"id": "1001",
"code": "NoVersionChange",
"message": "The versions have not changed.",
"jsonref": "#",
"json-path": "#",
"type": "Info"
}
{
"id": "1039",
"code": "AddedOperation",
"message": "The new version is adding an operation that was not found in the old version.",
"jsonref": "#/paths/~1api~1Operations/post",
"json-path": "#/paths/api/Operations/post",
"type": "Info"
}
{
"id": "1038",
"code": "AddedPath",
"message": "The new version is adding a path that was not found in the old version.",
"jsonref": "#/paths/~1api~1Paths",
"json-path": "#/paths/api/Paths",
"type": "Info"
}
The list of rules that are currently checked can be found in their git repository: docs
I had a look at their test suite in this folder: Swagger
To run their the oad tool against it, I had to perform some changes: https://github.com/Azure/openapi-diff/pull/108
Then I have converted the old Swagger 2.0 format to OpenAPI 3.0.1 format.
Of course, I will share my work.
We can then continue the discussion and see how this could be integrated.
- Langage dominant
- Java
- Étoiles
- 1.1k
- Forks
- 191
- Merge moyen
- 4 j 23 h
- PR mergées (30 j)
- 1
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 ·
Les mainteneurs répondent en général sous 5 jours
-
HtmlRender: Notes of Parameters shows always the new descriptionPeut-être pris @Inf1mum l’a pris il y a 6 jours. Ouvertegood first issue help wanted
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
OpenAPITools/openapi-diff#364 ·
Les mainteneurs répondent en général sous 5 jours
-
Render capabilities
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
OpenAPITools/openapi-diff#959 ·
Les mainteneurs répondent en général sous 5 jours
-
Render capabilities
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 18/100
OpenAPITools/openapi-diff#958 ·
Les mainteneurs répondent en général sous 5 jours
-
Render capabilities
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
OpenAPITools/openapi-diff#957 ·
Les mainteneurs répondent en général sous 5 jours
Toutes les issues de OpenAPITools/openapi-diff
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
eclipse-tradista/tradista#371 ·
Les mainteneurs répondent en général sous 1 jour
-
Failed to start Rescue missionOuvertecritical
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
mars-sim/mars-sim#2199 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
primefaces/primefaces#15568 ·
Les mainteneurs répondent en général sous 1 jour
-
崩溃日志只按 CRLF 分行Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
PCL-Community/PCL-CE#3872 ·
Les mainteneurs répondent en général sous 1 jour