API Download - Específica - documentation

[edysouza]

Localização da API:
https://afa.codes/swagger/#/full_packfilevers/get_full_packfilevers

Tarefa: Especificar melhor os dados retornados pela API Acima.
Do que se trata? R: API que vai filtrar colunas

[ppKrauss]

O endpoint do download servirá de modelo para novos endpoints, com maior controle sobre códigos de erro:

• códigos de status HTTP controlados, conforme PostgREST
• atributos de erro e mensagem de erro conforme issues anteriores, padrão JSON-RPC.

O endereço http do endpoint também precisa ser modelado por NGINX (como segunda opção à chamada de função direta no PostgREST). Sintaxe conforme acordada nos entendimentos orais.

Requisitos do request

• sintaxe submetida a parser que infere o nivel hierárquico requisitado.
• níveis hierárquicos requisiáveis: pais/doador/pacote/versão, pais/jurisdicao_superior_opcional/municipio/pacote/versão, pais/pacote/versão.

A hierarquia baseada em doador não precisa ser implementado na primeira versão de teste.
A hierarquia baseada em município pode apresentar zero ou mais níveis entre país e município. Por exemplo no Brasil tem o Estado, em Camarões o estado é opcional. Na Colômbia se o município for expresso por código numérico, dispensa estado.

Requisitos do JSON de return

Retorno em caso de sucesso,

• requisição de hierarquia pais/pacote/versão é canonizada como pais/jurisdicao_superior_opcional/municipio/pacote/versão

• requisição de hierarquia finalizada em pacote com apenas uma versão, é canonizada como pais/jurisdicao_superior_opcional/municipio/pacote/versão

• requisição de hierarquia finalizada em municipio com apenas uma versão, é canonizada como pais/jurisdicao_superior_opcional/municipio/pacote/versão.

• requisição de hierarquia finalizada em municipio com apenas um pacote (porém mais de uma versão), é canonizada como pais/jurisdicao_superior_opcional/municipio/pacote.

Retornos conforme requisições, recorrência de sumarizações da raiz para a folha:

1. pais/jurisdicao_superior_opcional/municipio/pacote/versão: retorna apenas metadados do pacote/versão.
2. pais/jurisdicao_superior_opcional/municipio/pacote: retorna árvore de versões do pacote. Contabilizar totais de versões no pacote.
3. pais/jurisdicao_superior_opcional/municipio: retorna árvore de pacotes do município. Contabilizar totais de pacotes no município.
4. pais/jurisdicao_superior_opcional: retorna árvore de municipios da jurisdição. Contabilizar totais de municipios na jurisdicao.
5. pais: retorna árvore de juridições (ou municipios) do país. Contabilizar totais de jurisdições no país.

[0e1]

As folhas estão na view

• optim.vw01full_packfilevers_ftype

Pode-se ainda, considerar a view:

• optim.vw01full_donated_PackComponent