code4romania/alex-api

[Tech] OpenAPI specs

Open

#51 opened on Apr 7, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)Dockerfile (1 fork)auto 404
WIPback-enddocumentationgood first issuehelp wanted

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Examine the existing codebase to identify all API endpoints and then create OpenAPI specification files for sponsor, grant, balance sheet, and CSO modules.
Tech stack
None
Domain
apidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitOpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80