Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta
#620 2 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
30/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
java, openapi
Domínio
api, cli

Direção de pesquisa

Comece pelo caminho de CLI que produz a saída de texto mostrada e compare-o com o formatador markdown. Use o exemplo fornecido spec1.yaml e spec2.yaml para verificar se stdout identifica a propriedade alterada e o valor do enum, ou se há uma opção explícita de formato de saída disponível.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Java
Estrelas
1.1k
Forks
190
Nenhum PR com merge em 30d

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de OpenAPITools/openapi-diff

Todas as issues de OpenAPITools/openapi-diff

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.