Ajustar documentação da API · turicas/covid19-br#182

2020-06-29T15:02:15.000Z

Na [documentação da API](https://github.com/turicas/covid19-br/blob/master/api.md#obito_cartorio), a ordem dos campos não reflete a ordem dos campos definidos em `schema/*.csv` nem `datapackage.json`. **API doc X CSV Schema** - [ ] [/caso](https://github.com/turicas/covid19-br/blob/master/api.md#caso) X [caso.csv](https://github.com/turicas/covid19-br/blob/master/schema/caso.csv) - [ ] [/boletim](https://github.com/turicas/covid19-br/blob/master/api.md#boletim) X [boletim.csv](https://github.com/turicas/covid19-br/blob/master/schema/boletim.csv) - [ ] [/caso_full](https://github.com/turicas/covid19-br/blob/master/api.md#caso_full) X [caso_full.csv](https://github.com/turicas/covid19-br/blob/master/schema/caso_full.csv) - [ ] [/obito_cartorio](https://github.com/turicas/covid19-br/blob/master/api.md#obito_cartorio) X [obito_cartorio.csv](https://github.com/turicas/covid19-br/blob/master/schema/obito_cartorio.csv) É possível fazer manualmente, mas idealmente seria possível automatizar tomando a o arquivo [datapackage.json](https://github.com/turicas/covid19-br/blob/master/datapackage.json) como referência.

(1 comment) (0 reactions) (0 assignees)Python (537 stars) (129 forks)batch import

documentationgood first issuehelp wanted

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

Tech stack: python
Domain: documentation
Issue type: documentation
Difficulty: 2
Estimated time: 1-3 hours
Activity status: fresh
Clarity: clear
Prerequisites: Ability to edit MarkdownFamiliarity with CSV file structure
Newbie friendliness: 80
Research direction: Compare the field order in each API endpoint section in api.md with the corresponding schema/*.csv files and datapackage.json. The goal is to ensure the order matches. For each endpoint listed, update the documentation to reflect the schema order. Optionally, consider automating this process by generating the API docs from datapackage.json.