Introduce check concept from "Azure/openapi-diff" project
Maintainer antworten meist innerhalb von 5 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- openapi
- Bereich
- api
Rechercherichtung
Beginne mit der Lektüre der Azure/openapi-diff-Dokumentation und der openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger-Tests und vergleiche anschließend deren gemeldete Checks mit dem aktuellen Vergleichsverhalten dieses Projekts. Das Issue nennt keine lokalen Dateien oder keinen Einstiegspunkt; für den Abschluss wären ein vereinbarter Integrationsumfang und entsprechende Checks erforderlich.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 191
- Ø Merge
- 4 T. 23 Std.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus OpenAPITools/openapi-diff
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
OpenAPITools/openapi-diff#506 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
HtmlRender: Notes of Parameters shows always the new descriptionEvtl. vergeben @Inf1mum hat das vor 6 Tagen übernommen. Offengood first issue help wanted
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
OpenAPITools/openapi-diff#364 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
Render capabilities
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
OpenAPITools/openapi-diff#959 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
Render capabilities
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 18/100
OpenAPITools/openapi-diff#958 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
Render capabilities
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
OpenAPITools/openapi-diff#957 ·
Maintainer antworten meist innerhalb von 5 Tagen
Alle Issues in OpenAPITools/openapi-diff
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
eclipse-tradista/tradista#371 ·
Maintainer antworten meist innerhalb von 1 Tag
-
critical
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
mars-sim/mars-sim#2199 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
primefaces/primefaces#15568 ·
Maintainer antworten meist innerhalb von 1 Tag
-
崩溃日志只按 CRLF 分行Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
PCL-Community/PCL-CE#3872 ·
Maintainer antworten meist innerhalb von 1 Tag