{"openapi":"3.1.0","info":{"title":"API do Nomear","version":"1","description":"Leitura das listas que a organização lê no Nomear: as dela, as Referências do Nomear e as abertas para ela. Só leitura. Documentação: https://nomear-staging.terrakrya.com/integracoes"},"servers":[{"url":"https://nomear-staging.terrakrya.com/api/v1"}],"security":[{"chaveDeApi":[]}],"paths":{"/":{"get":{"summary":"A chave","description":"Organização dona da chave, nome e validade. Bom para testar a configuração.","parameters":[],"responses":{"200":{"description":"A chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Root"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies":{"get":{"summary":"Listas","description":"Todas as listas que a organização lê: as dela, as Referências do Nomear e as que outras organizações abriram para ela.","parameters":[{"name":"q","in":"query","required":false,"description":"Parte do título, sem acento nem caixa.","schema":{"type":"string","maxLength":120}},{"name":"model","in":"query","required":false,"description":"Só listas deste modelo (`model.slug`).","schema":{"type":"string","minLength":2,"maxLength":60,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},{"name":"archived","in":"query","required":false,"description":"`false` (padrão) esconde as arquivadas; `true` só elas; `all` todas.","schema":{"default":"false","type":"string","enum":["true","false","all"]}}],"responses":{"200":{"description":"Listas","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VocabularyList"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}":{"get":{"summary":"Uma lista","description":"Dados da lista e os atributos que os termos têm.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Uma lista","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VocabularyDetail"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/terms":{"get":{"summary":"Termos","description":"Termos da lista, em páginas, na ordem da lista. Com `at`, como estavam numa versão ou data.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}},{"name":"q","in":"query","required":false,"description":"Casa com o rótulo ou um sinônimo, sem acento nem caixa.","schema":{"type":"string","maxLength":200}},{"name":"active","in":"query","required":false,"description":"`true` (padrão) só os em uso; `false` só os inativos; `all` todos.","schema":{"default":"true","type":"string","enum":["true","false","all"]}},{"name":"limit","in":"query","required":false,"description":"Termos por página (1 a 500, padrão 100).","schema":{"default":100,"type":"integer","minimum":1,"maximum":500}},{"name":"cursor","in":"query","required":false,"description":"O `nextCursor` da página anterior.","schema":{"type":"string","maxLength":2000}},{"name":"at","in":"query","required":false,"description":"Ler como estava numa versão (`v3`) ou num instante (ISO 8601 com fuso, `2026-09-30T23:59:59-03:00`). Ausente ou `atual`: estado atual.","schema":{"type":"string","maxLength":40}}],"responses":{"200":{"description":"Termos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermPage"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/terms/{value}":{"get":{"summary":"Um termo","description":"Um termo pela chave, em uso ou inativo. Termo inativo vem com `replacedBy` quando foi substituído.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}},{"name":"value","in":"path","required":true,"description":"Chave do termo (`value`).","schema":{"type":"string"}}],"responses":{"200":{"description":"Um termo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/search":{"get":{"summary":"Busca","description":"Termos em uso que casam com o texto: para autocompletar um campo no seu sistema.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}},{"name":"q","in":"query","required":true,"description":"Texto digitado: casa com o rótulo ou um sinônimo; quem começa com ele vem primeiro.","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"limit","in":"query","required":false,"description":"Quantos termos (1 a 20, padrão 20).","schema":{"default":20,"type":"integer","minimum":1,"maximum":20}}],"responses":{"200":{"description":"Busca","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResult"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/changes":{"get":{"summary":"O que mudou","description":"Termos criados, alterados, desativados ou com relações mudadas desde `since`, já no estado atual. Sem `since`, todos os termos.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}},{"name":"since","in":"query","required":false,"description":"O `nextSince` da sincronização anterior. Ausente: todos os termos (primeira sincronização).","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Termos por página (1 a 500, padrão 100).","schema":{"default":100,"type":"integer","minimum":1,"maximum":500}},{"name":"cursor","in":"query","required":false,"description":"O `nextCursor` da página anterior.","schema":{"type":"string","maxLength":2000}}],"responses":{"200":{"description":"O que mudou","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangesPage"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/versions":{"get":{"summary":"Versões","description":"Versões salvas da lista, da mais recente à mais antiga.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Versões","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionList"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/export/csv":{"get":{"summary":"Planilha CSV","description":"A lista em CSV (separador `;`, decimal com vírgula), no mesmo formato da exportação da tela.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}},{"name":"at","in":"query","required":false,"description":"Ler como estava numa versão (`v3`) ou num instante (ISO 8601 com fuso, `2026-09-30T23:59:59-03:00`). Ausente ou `atual`: estado atual.","schema":{"type":"string","maxLength":40}},{"name":"includeInactive","in":"query","required":false,"description":"`1` inclui os termos inativos.","schema":{"type":"string","enum":["0","1","true","false"]}}],"responses":{"200":{"description":"Arquivo CSV","content":{"text/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/vocabularies/{id}/export/xlsx":{"get":{"summary":"Planilha Excel","description":"A lista em XLSX, no mesmo formato da exportação da tela.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador da lista (`id` em `/vocabularies`).","schema":{"type":"string","format":"uuid"}},{"name":"at","in":"query","required":false,"description":"Ler como estava numa versão (`v3`) ou num instante (ISO 8601 com fuso, `2026-09-30T23:59:59-03:00`). Ausente ou `atual`: estado atual.","schema":{"type":"string","maxLength":40}},{"name":"includeInactive","in":"query","required":false,"description":"`1` inclui os termos inativos.","schema":{"type":"string","enum":["0","1","true","false"]}}],"responses":{"200":{"description":"Arquivo XLSX","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Parâmetro inválido (a mensagem diz qual).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, inválida, vencida ou revogada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A organização da chave está arquivada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Lista ou termo não encontrado, ou fora do que a organização lê.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Mais de 120 pedidos por minuto com esta chave. Espere os segundos do cabeçalho Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"chaveDeApi":{"type":"http","scheme":"bearer","description":"Chave da organização (`nmr_…`), gerada na página da organização, seção \"Integrações\"."}},"schemas":{"Root":{"type":"object","properties":{"api":{"type":"string","const":"Nomear"},"version":{"type":"string","const":"v1"},"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"slug":{"type":"string"},"name":{"type":"string"}},"required":["id","slug","name"],"additionalProperties":false,"description":"Organização dona da chave."},"key":{"type":"object","properties":{"name":{"type":"string"},"prefix":{"type":"string"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]}},"required":["name","prefix","expiresAt"],"additionalProperties":false,"description":"A chave usada: nome, começo e validade."},"documentation":{"type":"string","description":"Página da documentação."},"openapi":{"type":"string","description":"Documento OpenAPI 3.1."}},"required":["api","version","organization","key","documentation","openapi"],"additionalProperties":false},"Vocabulary":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Identificador da lista, usado nas rotas. Nunca muda."},"slug":{"type":"string","description":"Identificador legível (único dentro da organização dona)."},"title":{"type":"string","description":"Título da lista."},"description":{"description":"Descrição da lista.","type":["string","null"]},"kind":{"type":"string","enum":["reference","organization"],"description":"`reference`: Referência do Nomear, com dados oficiais. `organization`: lista de uma organização."},"organization":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"null"}],"description":"Organização dona; null em Referência do Nomear."},"ownedByYou":{"type":"boolean","description":"A lista é da organização da chave."},"model":{"type":"object","properties":{"slug":{"type":"string"},"title":{"type":"string"}},"required":["slug","title"],"additionalProperties":false,"description":"Modelo da lista: define os atributos dos termos."},"source":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"url":{"type":["string","null"]},"version":{"type":["string","null"]},"license":{"type":["string","null"]},"notes":{"type":["string","null"]}},"required":["name","url","version","license","notes"],"additionalProperties":false},{"type":"null"}],"description":"Fonte dos dados (nome, endereço, versão, licença)."},"basedOn":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false},{"type":"null"}],"description":"Referência do Nomear de onde a lista escolhe termos."},"hasCoordinates":{"type":"boolean","description":"Os termos têm ponto no mapa."},"broaderVocabulary":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"isSelf":{"type":"boolean"}},"required":["id","title","isSelf"],"additionalProperties":false},{"type":"null"}],"description":"Lista a que os termos \"pertencem\" (`broader` de cada termo). `isSelf`: hierarquia dentro da própria lista."},"archived":{"type":"boolean","description":"Lista arquivada: não recebe mais alterações."},"termCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Termos da lista, ativos e inativos."},"activeTermCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Termos em uso."},"latestVersion":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"name":{"type":"string"},"asOf":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Instante da versão."}},"required":["number","name","asOf"],"additionalProperties":false},{"type":"null"}],"description":"Última versão salva, se houver."},"lastTermChangeAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Última alteração de termo."},{"type":"null"}],"description":"Última alteração de algum termo da lista."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Criação da lista."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Última alteração dos dados da lista (título, estrutura)."}},"required":["id","slug","title","description","kind","organization","ownedByYou","model","source","basedOn","hasCoordinates","broaderVocabulary","archived","termCount","activeTermCount","latestVersion","lastTermChangeAt","createdAt","updatedAt"],"additionalProperties":false},"VocabularyDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Identificador da lista, usado nas rotas. Nunca muda."},"slug":{"type":"string","description":"Identificador legível (único dentro da organização dona)."},"title":{"type":"string","description":"Título da lista."},"description":{"description":"Descrição da lista.","type":["string","null"]},"kind":{"type":"string","enum":["reference","organization"],"description":"`reference`: Referência do Nomear, com dados oficiais. `organization`: lista de uma organização."},"organization":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"null"}],"description":"Organização dona; null em Referência do Nomear."},"ownedByYou":{"type":"boolean","description":"A lista é da organização da chave."},"model":{"type":"object","properties":{"slug":{"type":"string"},"title":{"type":"string"}},"required":["slug","title"],"additionalProperties":false,"description":"Modelo da lista: define os atributos dos termos."},"source":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"url":{"type":["string","null"]},"version":{"type":["string","null"]},"license":{"type":["string","null"]},"notes":{"type":["string","null"]}},"required":["name","url","version","license","notes"],"additionalProperties":false},{"type":"null"}],"description":"Fonte dos dados (nome, endereço, versão, licença)."},"basedOn":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false},{"type":"null"}],"description":"Referência do Nomear de onde a lista escolhe termos."},"hasCoordinates":{"type":"boolean","description":"Os termos têm ponto no mapa."},"broaderVocabulary":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"isSelf":{"type":"boolean"}},"required":["id","title","isSelf"],"additionalProperties":false},{"type":"null"}],"description":"Lista a que os termos \"pertencem\" (`broader` de cada termo). `isSelf`: hierarquia dentro da própria lista."},"archived":{"type":"boolean","description":"Lista arquivada: não recebe mais alterações."},"termCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Termos da lista, ativos e inativos."},"activeTermCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Termos em uso."},"latestVersion":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"name":{"type":"string"},"asOf":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Instante da versão."}},"required":["number","name","asOf"],"additionalProperties":false},{"type":"null"}],"description":"Última versão salva, se houver."},"lastTermChangeAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Última alteração de termo."},{"type":"null"}],"description":"Última alteração de algum termo da lista."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Criação da lista."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Última alteração dos dados da lista (título, estrutura)."},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"},"description":"Atributos dos termos desta lista."}},"required":["id","slug","title","description","kind","organization","ownedByYou","model","source","basedOn","hasCoordinates","broaderVocabulary","archived","termCount","activeTermCount","latestVersion","lastTermChangeAt","createdAt","updatedAt","attributes"],"additionalProperties":false},"Attribute":{"type":"object","properties":{"key":{"type":"string","description":"Chave em `attributes` de cada termo."},"label":{"type":"string","description":"Nome do atributo."},"type":{"type":"string","enum":["text","number","boolean","select","reference"],"description":"Tipo do valor."},"required":{"type":"boolean","description":"Todo termo tem."},"multiple":{"type":"boolean","description":"Lista de valores em vez de um só."},"options":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Valores possíveis (tipo `select`)."},"helper":{"description":"Texto de ajuda.","type":["string","null"]},"reference":{"anyOf":[{"type":"object","properties":{"vocabularyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"}},"required":["vocabularyId","title"],"additionalProperties":false},{"type":"null"}],"description":"Tipo `reference`: lista de onde vêm os valores."}},"required":["key","label","type","required","multiple","options","helper","reference"],"additionalProperties":false},"Term":{"type":"object","properties":{"value":{"type":"string","description":"Chave do termo: única na lista e nunca muda. É ela que o seu sistema guarda."},"label":{"type":"string","description":"Nome preferido do termo."},"code":{"description":"Código opcional (por exemplo, o código do IBGE).","type":["string","null"]},"synonyms":{"type":"array","items":{"type":"string"},"description":"Outros nomes: grafias, siglas, nomes locais. A busca também casa por eles."},"active":{"type":"boolean","description":"Em uso. Termo inativo continua respondendo, mas não deve ser oferecido em cadastros novos."},"replacedBy":{"anyOf":[{"$ref":"#/components/schemas/TermRef"},{"type":"null"}],"description":"Termo da mesma lista que substitui este, quando inativo."},"broader":{"anyOf":[{"$ref":"#/components/schemas/TermRef"},{"type":"null"}],"description":"\"Pertence a\": termo da lista indicada em `broaderVocabulary`."},"related":{"type":"array","items":{"$ref":"#/components/schemas/RelatedTerm"},"description":"\"Relacionado a\": termos ligados a este, de qualquer lista."},"coordinates":{"anyOf":[{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"],"additionalProperties":false},{"type":"null"}],"description":"Ponto no mapa em graus decimais, só em listas com mapa."},"attributes":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/components/schemas/TermRef"}]},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/components/schemas/TermRef"}]}}]},"description":"Atributos do modelo da lista (ver `attributes` da lista). Atributo de referência vem como { value, label, active }."},"sortOrder":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Posição fixa na lista, quando definida."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Criação do termo."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Última alteração do termo ou das relações dele."}},"required":["value","label","code","synonyms","active","replacedBy","broader","related","coordinates","attributes","sortOrder","createdAt","updatedAt"],"additionalProperties":false},"TermRef":{"type":"object","properties":{"value":{"type":"string","description":"Chave do termo apontado."},"label":{"type":"string","description":"Rótulo do termo apontado no momento da leitura."},"active":{"type":"boolean","description":"Se o termo apontado está em uso."}},"required":["value","label","active"],"additionalProperties":false,"description":"Termo apontado, já com o rótulo."},"RelatedTerm":{"type":"object","properties":{"vocabularyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Lista do termo relacionado."},"vocabularySlug":{"type":"string","description":"Identificador legível da lista do termo relacionado."},"vocabularyTitle":{"type":"string","description":"Título da lista do termo relacionado."},"value":{"type":"string","description":"Chave do termo relacionado."},"label":{"type":"string","description":"Rótulo do termo relacionado."},"active":{"type":"boolean","description":"Se o termo relacionado está em uso."}},"required":["vocabularyId","vocabularySlug","vocabularyTitle","value","label","active"],"additionalProperties":false},"SearchItem":{"type":"object","properties":{"value":{"type":"string","description":"Chave do termo."},"label":{"type":"string","description":"Nome preferido do termo."},"code":{"description":"Código opcional.","type":["string","null"]},"synonyms":{"type":"array","items":{"type":"string"},"description":"Outros nomes."}},"required":["value","label","code","synonyms"],"additionalProperties":false},"Version":{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Número da versão na lista (use `at=v3`)."},"name":{"type":"string","description":"Nome dado à versão."},"notes":{"description":"Notas da versão.","type":["string","null"]},"origin":{"type":"string","enum":["manual","import"],"description":"`manual`: salva por alguém. `import`: guardada antes de uma importação."},"asOf":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Instante que a versão marca."},"termCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Termos na versão."},"activeTermCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Termos em uso na versão."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Quando a versão foi salva."}},"required":["number","name","notes","origin","asOf","termCount","activeTermCount","createdAt"],"additionalProperties":false},"VocabularyList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Vocabulary"}}},"required":["items"],"additionalProperties":false},"TermPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Term"}},"nextCursor":{"description":"Envie em `cursor` para a próxima página; null quando acabou.","type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Quantos termos atendem ao pedido, somando todas as páginas."},"asOf":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Instante lido."},{"type":"null"}],"description":"Instante lido quando `at` é informado; null = estado atual."},"version":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Versão lida, quando `at` é uma versão."}},"required":["items","nextCursor","total","asOf","version"],"additionalProperties":false},"ChangesPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Term"}},"nextCursor":{"description":"Envie em `cursor` para a próxima página; null quando acabou.","type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Quantos termos atendem ao pedido, somando todas as páginas."},"since":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"O `since` pedido, como foi enviado; null = primeira sincronização (todos os termos)."},"nextSince":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Guarde e envie como `since` na próxima sincronização. Vem igual em todas as páginas."}},"required":["items","nextCursor","total","since","nextSince"],"additionalProperties":false},"SearchResult":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SearchItem"}}},"required":["items"],"additionalProperties":false},"VersionList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Version"}}},"required":["items"],"additionalProperties":false},"Error":{"type":"object","properties":{"statusCode":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Código HTTP."},"message":{"type":"string","description":"O que aconteceu, em português."}},"required":["statusCode","message"],"additionalProperties":false}}}}