0xironclad / 0xironclad/Task-Scheduler-API
Add OpenAPI spec
Aberta
api
docs
- Linguagem predominante
- TypeScript
- Estrelas
- 0
- Forks
- 2
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
Document endpoints, payloads, and error shapes in a `openapi.yaml`. Optional Swagger UI.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Examine as rotas Express existentes na base de código para entender os endpoints, os payloads de solicitação/resposta e os formatos de erro. Crie um arquivo openapi.yaml documentando-os. Opcionalmente, integre um pacote Swagger UI para servir a especificação. Verifique se a especificação corresponde ao comportamento real da API testando os endpoints.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- express, node.js, openapi, typescript
- Domínio
- api, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 55/100