GiGpro22/complex-bug-tracking-example

связанная с документацией (Documentation)

Aberta

#6 aberto em 4 de fev. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (1 responsável) (0 fork)auto 404
bugdocumentationgood first issuewontfix

Métricas do repositório

Stars
 (0 estrela)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

• Описание задачи: Обновить документацию по API для партнеров, интегрирующихся с приложением McDonald's. Документация должна содержать: * Описание всех доступных endpoints. * Форматы запросов и ответов (JSON schema). * Примеры использования. * Коды ошибок и их описание. * Описание процесса аутентификации и авторизации. * Условия использования API. • Отчет о текущем состоянии документации: * Документация устарела. * Отсутствует описание новых endpoints, добавленных в последней версии API. * Некоторые примеры не соответствуют текущей реализации API. * Отсутствует информация об ограничениях по использованию API (rate limiting). * Формат документации не стандартизирован. • Требования: * Использовать стандартный формат документации (например, OpenAPI Specification). * Обеспечить актуальность и полноту документации. * Документация должна быть понятной и легко читаемой. * Автоматически генерировать документацию из кода (если возможно). • Приоритет: Высокий • Сложность: Средняя • Затронутые области: Backend (API development), Documentation (API documentation).

Guia do colaborador

Direção de pesquisa
Familiarize se com os endpoints da API existentes e suas implementações. Use uma ferramenta como Swagger ou OpenAPI para gerar ou atualizar a documentação. Certifique se de que todos os endpoints estejam documentados com esquemas e exemplos de requisição/resposta. Verifique a documentação com o comportamento real da API.
Pilha de tecnologia
None
Domain
backenddocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitREST API
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65