Output in text and markdown not equivalent (text output incomplete)

Aperta
  • Qualcosa non va?
#620 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java, openapi
Ambito
api, cli

Direzione di ricerca

Inizia dal percorso CLI che produce l’output di testo mostrato e confrontalo con il formatter markdown. Usa l’esempio fornito spec1.yaml e spec2.yaml per verificare che stdout identifichi la proprietà modificata e il valore enum, oppure che sia disponibile un’opzione esplicita per il formato di output.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement Render capabilities

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.

Lingua principale
Java
Stelle
1.1k
Fork
191
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenAPITools/openapi-diff

Tutte le issue di OpenAPITools/openapi-diff

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.