turicas/covid19-br

Ajustar documentação da API

Open

#182 opened on Jun 29, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (129 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (537 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Na documentação da API, a ordem dos campos não reflete a ordem dos campos definidos em schema/*.csv nem datapackage.json.

API doc X CSV Schema

É possível fazer manualmente, mas idealmente seria possível automatizar tomando a o arquivo datapackage.json como referência.

Contributor guide

Research direction
Compare the field order in each API doc endpoint with the corresponding CSV schema and update the API documentation to match. For automation, consider using the datapackage.json as reference.
Tech stack
python
Domain
backenddocumentation
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-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75