OpenAPITools / OpenAPITools/openapi-diff
Output in text and markdown not equivalent (text output incomplete)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
The text output which is printed by default by the CLI doesn't show all the information that the markdown output shows:
spec1.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
spec2.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
- ENUM_VALUE_3
markdown output
#### What's Changed
---
##### `GET` /resources1/{id}/resources2
###### Return Type:
Changed response : **200 OK**
> OK
* Changed content type : `application/json`
Changed items (object):
* Changed property `someProperty` (string)
Added enum value:
* `ENUM_VALUE_3`
text output
==========================================================================
== API CHANGE LOG ==
==========================================================================
API for Umetrics Core Project Management Service
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
Return Type:
- Changed 200 OK
Media types:
- Changed application/json
Schema: Broken compatibility
- GET /resources1/{id}/resources2
API changes broke backward compatibility
--------------------------------------------------------------------------
text output tells nothing about what actually broke backwards compatibility, but since it's the stdout of the process it should show everything that's needed to determine the reason of the problem.
Alternative solution: give an option to decide which kind of output: text/markdown/json should be printed to stdout.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem CLI-Pfad, der die gezeigte Textausgabe erzeugt, und vergleiche ihn mit dem Markdown-Formatter. Verwende das bereitgestellte Beispiel spec1.yaml und spec2.yaml, um zu überprüfen, dass stdout die geänderte Eigenschaft und den Enum-Wert identifiziert oder dass eine explizite Option für das Ausgabeformat verfügbar ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java, openapi
- Bereich
- api, cli
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100