Include dev API in docs
Aberta
Ninguém assumiu esta issue ainda.
cloud/server
- Linguagem predominante
- Vue
- Estrelas
- 15
- Forks
- 22
- Merge médio
- 5d 11h
- PRs com merge (30d)
- 9
Descrição
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
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.
Direção de pesquisa
A issue identifica a REST API pública e uma definição do Swagger, mas não nomeia arquivos nem pontos de entrada. Comece localizando a especificação da API e os pontos de integração do site de documentação; considera-se concluído quando a API pública estiver documentada em um formato fácil de usar para integradores personalizados.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- openapi
- Domínio
- api, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100