code4romania/alex-api

[Tech] OpenAPI specs

Ouverte

#51 ouverte le 7 avr. 2022

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (1 personne assignée)Dockerfile (1 fork)auto 404
WIPback-enddocumentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (5 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez le code existant pour identifier tous les points de terminaison API, puis créez des fichiers de spécification OpenAPI pour les modules sponsor, subvention, bilan et CSO.
Stack technique
Aucun
Domaine
apidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitOpenAPI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80