Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aprimorar apresentação de metadados #508

Open
berinhard opened this issue Nov 27, 2020 · 0 comments
Open

Aprimorar apresentação de metadados #508

berinhard opened this issue Nov 27, 2020 · 0 comments

Comments

@berinhard
Copy link
Contributor

berinhard commented Nov 27, 2020

Na API

Adicionar metadados de uma tabela em v1/dataset/<dataset_slug>/<tablename>/ (essa rota hoje não existe). A resposta teria qie ser algo similar a:

{
    "fields": [
        {
            "name": "date",
            "type": "string"
        },
        {
            "name": "state",
            "type": "string"
        },
        {
            "name": "url",
            "type": "string"
        },
        {
            "name": "notes",
            "type": "string"
        }
    ],
    "filters": {
        "date": {"type": "string", "choices": ["2020-10-01", "2020-09-30"]}
    },
    "name": "boletim",
    "data_url": "http://localhost:8000/api/dataset/covid19/boletim/data/",
    "import_date": "2020-09-27T13:22:41.225767-03:00"
}

É muito importante que a serialização dos fields também apresente informações extras sobre os campos como visibilidade, busca e etc. Todas elas estão muito bem documentadas neste comentário.

Atualizar a documentação da API

Na interface WEB

A pessoa que quiser saber o que significam os campos de cada tabela (porque baixou o dataset completo e vai analisar por conta própria) mas não sabe o que é API provavelmente nunca vai clicar em "documentação da API". Por isso, acho que poderíamos ter uma listagem parecida na aba "metadados" da view dataset-table-detail (podemos usar o mesmo código que a página de documentação da API vai usar e talvez até criar uma URL específica para isso, como /dataset/<dataset_slug>//meta/).

PR de referência: #502

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant