code4romania/alex-api

[Tech] OpenAPI specs

Aberta

#51 aberto em 7 de abr. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (1 responsável)Dockerfile (1 fork)auto 404
WIPback-enddocumentationgood first issuehelp wanted

Métricas do repositório

Stars
 (5 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Examine o código existente para identificar todos os endpoints de API e depois crie arquivos de especificação OpenAPI para os módulos de patrocinador, subsídio, balanço patrimonial e CSO.
Pilha de tecnologia
None
Domain
apidocumentation
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.
2
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
GitOpenAPI
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80