HXL hashtag customizada: `#x_api`

[fititnt]

• Motivação inicial
  • https://github.com/HXL-CPLP/forum/issues/38#issuecomment-744137897
• Wikipedia
  • PT: Interface de programação de aplicações
  • https://pt.wikipedia.org/wiki/Interface_de_programa%C3%A7%C3%A3o_de_aplica%C3%A7%C3%B5es
  • EN: application programming interface (API)

  • https://en.wikipedia.org/wiki/API

Documentação oficial sobre tags de extensão

Tradução de máquina (Google Translate) de https://hxlstandard.org/standard/1_0final/tagging/#extensions:

3.2. Criação de tags de extensão As tags principais HXL incluem tags que serão geralmente aplicáveis ​​a muitos conjuntos de dados humanitários, mas é impossível prever cada tag para cada necessidade humanitária. Este padrão faz as seguintes quatro recomendações para estender tags e atributos HXL:

Sempre que possível, pegue uma tag existente com um significado mais amplo e restrinja-a com um atributo, por exemplo, # loc + hospital.

1. Quando não houver uma tag principal aplicável, comece uma tag de extensão com “x_”, de modo que não entre em conflito com nenhuma hashtag principal HXL futura, por exemplo, #x_toxicity.
2. Quando o software encontra uma hashtag HXL que não reconhece, por ex. #x_toxicity, ele deve simplesmente ignorar a coluna de dados.
3. Quando o software encontra um atributo HXL que não reconhece, por ex. # loc + hospital, deve ignorar o atributo, mas ainda processar a tag e quaisquer outros atributos que reconheça: neste caso, deve se comportar como se o conjunto de dados contivesse apenas #loc.

Nota: os designers de software podem optar por alertar sobre tags e atributos não reconhecidos, para ajudar na detecção de erros e controle de qualidade.

Motivação da #x_api

Vide https://github.com/HXL-CPLP/forum/issues/38#issuecomment-744137897. Vou fazer testes pelo menos alguns dias antes de escrever mais sobre.

[fititnt]

Que lindo. Acho que vai dar para fazer uma gambiarra solução usando isso aqui:

• https://github.com/HXLStandard/hxl-proxy/wiki/Append-datasets-filter
• https://github.com/HXLStandard/hxl-proxy/wiki/Append-datasets-%28external-list%29-filter

Talvez além de usarmos as #x_api de cada grupo de APIs, (por exemplo o HXL-CPLP-FOD_languages #38 seria um grupo, o HXL-CPLP-FOD_countries-territories #34 outro) a gente tenha como ter um local mais central que lista os #x_api dos demais <3

HXL-CPLP-FOD_languages#x_api

Print atual

[fititnt]

Ca***ho. Funciona.

hxl +public
status	Public working draft
meta +discussion+public	https://github.com/HXL-CPLP/forum/issues/39
x_api	https://proxy.hxlstandard.org/data/96cf8b
x_api +description +text	Este planilha é usada para permitir mesclar em uma API única uma mescla de informações descritas em planilhas #x_api. Documentação de como isto é feito pode ser lida em https://github.com/HXL-CPLP/forum/issues/39.Resumidamente: A planilha HXL-CPLP-FOD#x_api serve como "template" de que campos as planilhas citadas em HXL-CPLP-FOD#x_source deveriam ter.