code4romania/alex-api

[Tech] OpenAPI specs

Aperta

#51 aperta il 7 apr 2022

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (1 assegnatario)Dockerfile (1 fork)auto 404
WIPback-enddocumentationgood first issuehelp wanted

Metriche repository

Star
 (5 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esaminare il codice esistente per identificare tutti gli endpoint API e quindi creare file di specifiche OpenAPI per i moduli sponsor, sovvenzione, bilancio e CSO.
Tech stack
Nessuno
Dominio
apidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitOpenAPI
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80