Catalisa.Building Blocks
Catálogo/Data Store/API

API do Data Store

13 endpoints em 4 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

15 endpoints

Coleções

/data-store/api/v1/collections4
  • POST/data-store/api/v1/collectionsCria coleçãoDATASTORE_ADMIN
  • GET/data-store/api/v1/collectionsLista coleções do tenantDATASTORE_READ
  • GET/data-store/api/v1/collections/:nameMetadado de uma coleçãoDATASTORE_READ
  • DELETE/data-store/api/v1/collections/:nameExclusão lógica da coleção e dos documentos delaDATASTORE_ADMIN

Documentos

/data-store/api/v1/collections6
  • POST/data-store/api/v1/collections/:name/documentsInsere documentoDATASTORE_WRITE
  • POST/data-store/api/v1/collections/:name/documents/ensureGet-or-create por docKey, idempotenteDATASTORE_WRITE
  • GET/data-store/api/v1/collections/:name/documents/:idLê documento por UUIDDATASTORE_READ
  • PUT/data-store/api/v1/collections/:name/documents/:idSubstitui documento, com concorrência otimistaDATASTORE_WRITE
  • DELETE/data-store/api/v1/collections/:name/documents/:idExclusão lógicaDATASTORE_WRITE
  • POST/data-store/api/v1/collections/:name/documents/queryFiltra, ordena e pagina por conteúdoDATASTORE_READ

Fast-path KV

/data-store/api/v1/kv3
  • PUT/data-store/api/v1/kv/:namespace/:keyGrava valor, cria a coleção de apoio se precisoDATASTORE_WRITE
  • GET/data-store/api/v1/kv/:namespace/:keyLê valorDATASTORE_READ
  • DELETE/data-store/api/v1/kv/:namespace/:keyExclusão lógica do valorDATASTORE_WRITE

Uso e saúde

/data-store2
  • GET/data-store/api/v1/usageDocumentos e bytes usados contra a quota do tenantDATASTORE_READ
  • GET/data-store/healthSonda de saúde do serviçoPública