NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Aberta
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 136
- Forks
- 75
- Merge médio
- 1min
- PRs com merge (30d)
- 8
Descrição
Assuming this is a thing, I don't see any documentation for it. What data is returned for each endpoint? For example, if I create a topic, what object is returned?
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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 diz respeito aos endpoints da RESTful JSON API; comece fazendo um inventário de cada endpoint e verificando o comportamento atual das respostas. Documente o objeto retornado para ações como a criação de topics e, em seguida, verifique se a documentação abrange todos os endpoints e corresponde às respostas observadas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript
- Domínio
- api, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100