code4romania/alex-api

[Tech] OpenAPI specs

Offen

#51 geöffnet am 07.04.2022

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)Dockerfile (1 Fork)auto 404
WIPback-enddocumentationgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

Create OpenAPI specs:

  • Sponsor
    • sponsor list
    • view sponsor
    • update sponsor
  • Grant
    • grants list
    • view grant details
    • add grant (with all ramifications)
    • add grant budget line
  • Balance sheet
    • balance sheet list with search and filters
    • balance sheet item/entry list
    • add new balance sheet item/entry
    • attach file to balance sheet
    • edit balance sheet item/entry
    • download one file (archive) with all files from balance sheet item/entry included
    • download one requested file from balance sheet item/entry (should support preview)
  • Setup CSO
    • organization data
    • bank accounts
    • financial data
    • update profile
    • view profile

Contributor Guide

Research-Richtung
Untersuchen Sie die vorhandene Codebasis, um alle API Endpunkte zu identifizieren, und erstellen Sie dann OpenAPI Spezifikationsdateien für die Module Sponsor, Zuschuss, Bilanz und CSO.
Tech Stack
Keine
Domain
apidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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
GitOpenAPI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80