Add support for "changelog" in the "info" object
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Domínio
- api, documentation
Direção de pesquisa
Comece localizando a definição do objeto info do OpenAPI e a documentação ou os exemplos que descrevem seus campos opcionais. Revise o histórico de comentários para verificar se há concordância sobre a adição de changelog; a tarefa estará concluída quando houver uma alteração de especificação aceita que defina a propriedade opcional e seu valor esperado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
When maintaining an API specification, it would be really nice to offer a changelog for the API consumer. This can be as simple as a link to a changelog.
Possible Solution
The info object seems to be the most suitable place that such a parameter could be located (as an optional parameter).
Example:
info:
version: 1.1.0
title: My API Specification
changelog: https://acme.com/docs/api/v1/changelog.md
Nb: I know that this is currently possible via x- extension, yet not all tools seem to accept extensions.
- Linguagem predominante
- Markdown
- Estrelas
- 31.3k
- Forks
- 9.2k
- Merge médio
- 2d 3h
- PRs com merge (30d)
- 8
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de OAI/OpenAPI-Specification
-
Housekeeping
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 8/100
OAI/OpenAPI-Specification#5571 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 15/100
OAI/OpenAPI-Specification#5570 ·
Mantenedores costumam responder em até 1 dia
-
Housekeeping
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 45/100
OAI/OpenAPI-Specification#5566 · 5 comentários ·
Mantenedores costumam responder em até 1 dia
-
Housekeeping
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 35/100
OAI/OpenAPI-Specification#5562 · 4 comentários ·
Mantenedores costumam responder em até 1 dia
-
v3.2.1 releaseTalvez livre de novo @lornajane assumiu há 36 dias e não há nenhum pull request aberto. Aberta
OAI/OpenAPI-Specification#5460 · 11 comentários · 1 reação · 1 responsável ·
Mantenedores costumam responder em até 1 dia
Todas as issues de OAI/OpenAPI-Specification
Issues semelhantes
-
run_all sleeps after the final job despite documenting delays between jobsTalvez já em andamento @Gambit-Checkmate assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
-
bnv-manager-v2: accept_invite creates the Mailcow domain admin before the commitTalvez já em andamento @myOmikron assumiu hoje. Abertabug ready-for-agent
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
-
BUG
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Mai-with-u/MaiBot#2187 ·
Mantenedores costumam responder em até 1 dia
-
AG-UI bug pkg:core
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
pydantic/pydantic-ai#10538 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
nicolettas-muggelbude/RechnungsFee#448 ·
Mantenedores costumam responder em até 1 dia