GiGpro22/complex-bug-tracking-example

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

Offen

#6 geöffnet am 04.02.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person) (0 Forks)auto 404
bugdocumentationgood first issuewontfix

Repository-Metriken

Stars
 (0 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Machen Sie sich mit den vorhandenen API Endpunkten und deren Implementierungen vertraut. Verwenden Sie ein Tool wie Swagger oder OpenAPI, um die Dokumentation zu generieren oder zu aktualisieren. Stellen Sie sicher, dass alle Endpunkte mit Anfrage /Antwortschemata und Beispielen dokumentiert sind. Gleichen Sie die Dokumentation mit dem tatsächlichen API Verhalten ab.
Tech Stack
Keine
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitREST API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65