Skip to content

Commit 994b4ce

Browse files
fix: use asset_entity_id property to reference asset
1 parent e222287 commit 994b4ce

File tree

9 files changed

+22
-22
lines changed

9 files changed

+22
-22
lines changed

docs/api/lke/create-book.api.mdx

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/api/lke/get-book.api.mdx

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/api/lke/list-books.api.mdx

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/api/lke/lke.openapi.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2637,9 +2637,9 @@ components:
26372637
available:
26382638
$ref: "#/components/schemas/Balance"
26392639
description: Posição do saldo disponível.
2640-
asset_identifier:
2641-
$ref: "#/components/schemas/EntityIdentifier"
2642-
description: Identificador único `entity_id` do **asset** no formato UUIDv7. Alternativamente pode ser utilizado o `external_entity_id`.
2640+
asset_entity_id:
2641+
$ref: "#/components/schemas/EntityID"
2642+
description: Identificador único `entity_id` do **asset** no formato UUIDv7.
26432643
created_at:
26442644
$ref: "#/components/schemas/DateTime"
26452645
updated_at:
@@ -2652,7 +2652,7 @@ components:
26522652
- confirmable
26532653
- provisioned
26542654
- available
2655-
- asset_identifier
2655+
- asset_entity_id
26562656
- created_at
26572657
- updated_at
26582658
BookCreateRequest:

docs/api/lke/schemas/book.schema.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: "Book"
66
hide_title: true
77
hide_table_of_contents: true
88
schema: true
9-
sample: {"entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","entity_type":"BOOK","external_entity_id":"ext:123-456-789-ABCD","version":0,"name":"string","ledger_entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","nature":"CREDITOR","created_at":"2024-07-29T15:51:28.071Z","updated_at":"2024-07-29T15:51:28.071Z","discarded_at":"2024-07-29T15:51:28.071Z","position":{"entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","entity_type":"POSITION","version":0,"reference_date":"2024-07-29T15:51:28.071Z","entry_reference":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","posted":{"amount":0,"credits":0,"debits":0},"confirmable":{"amount":0,"credits":0,"debits":0},"provisioned":{"amount":0,"credits":0,"debits":0},"available":{"amount":0,"credits":0,"debits":0},"asset_identifier":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","created_at":"2024-07-29T15:51:28.071Z","updated_at":"2024-07-29T15:51:28.071Z"},"metadata":{"foo":"bar"}}
9+
sample: {"entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","entity_type":"BOOK","external_entity_id":"ext:123-456-789-ABCD","version":0,"name":"string","ledger_entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","nature":"CREDITOR","created_at":"2024-07-29T15:51:28.071Z","updated_at":"2024-07-29T15:51:28.071Z","discarded_at":"2024-07-29T15:51:28.071Z","position":{"entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","entity_type":"POSITION","version":0,"reference_date":"2024-07-29T15:51:28.071Z","entry_reference":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","posted":{"amount":0,"credits":0,"debits":0},"confirmable":{"amount":0,"credits":0,"debits":0},"provisioned":{"amount":0,"credits":0,"debits":0},"available":{"amount":0,"credits":0,"debits":0},"asset_entity_id":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","created_at":"2024-07-29T15:51:28.071Z","updated_at":"2024-07-29T15:51:28.071Z"},"metadata":{"foo":"bar"}}
1010
custom_edit_url: null
1111
---
1212

@@ -31,7 +31,7 @@ import Heading from "@theme/Heading";
3131

3232

3333
<Schema
34-
schema={{"type":"object","properties":{"entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"entity_type":{"type":"string","enum":["BOOK"]},"external_entity_id":{"type":"string","description":"Identificador externo da entidade para interoperabilidade com outros sistemas.","minLength":1,"maxLength":36,"example":"ext:123-456-789-ABCD","nullable":true,"title":"ExternalEntityID"},"version":{"type":"integer","minimum":0,"maximum":128,"default":0,"title":"Version"},"name":{"type":"string","minLength":3,"maxLength":128,"description":"Nome único do book dentro do ledger."},"ledger_entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"nature":{"type":"string","enum":["CREDITOR","DEBITOR"],"description":"Natureza do book."},"created_at":{"nullable":false,"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"updated_at":{"nullable":false,"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"discarded_at":{"nullable":true,"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"position":{"description":"Posição de saldo associada ao book quando criado.","type":"object","properties":{"entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"entity_type":{"type":"string","enum":["POSITION"]},"version":{"type":"integer","minimum":0,"maximum":128,"default":0,"title":"Version"},"reference_date":{"description":"Data de referência da posição de saldo. Quando não informada durante uma transação, será a data de criação da transação.","type":"string","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"entry_reference":{"description":"Identificador do último lançamento que atualizou a posição do saldo. É nulo quando a posição do saldo é inicializada.","nullable":true,"type":"string","pattern":"^(([a-zA-Z_-]+:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})|(ext:[a-zA-Z0-9_-]{1,32}))$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityIdentifier"},"posted":{"description":"Posição do saldo lançado.","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"confirmable":{"description":"Posição do saldo a ser confirmado.","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"provisioned":{"description":"Posição do saldo provisionado (lançado e a ser confirmado).","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"available":{"description":"Posição do saldo disponível.","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"asset_identifier":{"description":"Identificador único `entity_id` do **asset** no formato UUIDv7. Alternativamente pode ser utilizado o `external_entity_id`.","type":"string","pattern":"^(([a-zA-Z_-]+:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})|(ext:[a-zA-Z0-9_-]{1,32}))$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityIdentifier"},"created_at":{"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"updated_at":{"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"}},"required":["entity_id","entity_type","reference_date","posted","confirmable","provisioned","available","asset_identifier","created_at","updated_at"],"title":"Position"},"metadata":{"type":"object","description":"Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings. O tamanho maximo do objeto deve ser 1MB.","additionalProperties":{"type":"string"},"maxProperties":10,"example":{"foo":"bar"},"title":"Metadata"}},"title":"Book"}}
34+
schema={{"type":"object","properties":{"entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"entity_type":{"type":"string","enum":["BOOK"]},"external_entity_id":{"type":"string","description":"Identificador externo da entidade para interoperabilidade com outros sistemas.","minLength":1,"maxLength":36,"example":"ext:123-456-789-ABCD","nullable":true,"title":"ExternalEntityID"},"version":{"type":"integer","minimum":0,"maximum":128,"default":0,"title":"Version"},"name":{"type":"string","minLength":3,"maxLength":128,"description":"Nome único do book dentro do ledger."},"ledger_entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"nature":{"type":"string","enum":["CREDITOR","DEBITOR"],"description":"Natureza do book."},"created_at":{"nullable":false,"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"updated_at":{"nullable":false,"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"discarded_at":{"nullable":true,"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"position":{"description":"Posição de saldo associada ao book quando criado.","type":"object","properties":{"entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"entity_type":{"type":"string","enum":["POSITION"]},"version":{"type":"integer","minimum":0,"maximum":128,"default":0,"title":"Version"},"reference_date":{"description":"Data de referência da posição de saldo. Quando não informada durante uma transação, será a data de criação da transação.","type":"string","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"entry_reference":{"description":"Identificador do último lançamento que atualizou a posição do saldo. É nulo quando a posição do saldo é inicializada.","nullable":true,"type":"string","pattern":"^(([a-zA-Z_-]+:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})|(ext:[a-zA-Z0-9_-]{1,32}))$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityIdentifier"},"posted":{"description":"Posição do saldo lançado.","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"confirmable":{"description":"Posição do saldo a ser confirmado.","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"provisioned":{"description":"Posição do saldo provisionado (lançado e a ser confirmado).","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"available":{"description":"Posição do saldo disponível.","type":"object","properties":{"amount":{"type":"integer","description":"Valor do saldo em centavos.","example":0},"credits":{"type":"integer","description":"Total de creditos da posicao de saldo.","example":0},"debits":{"type":"integer","description":"Total de debitos da posicao de saldo.","example":0}},"required":["amount","credits","debits"],"title":"Balance"},"asset_entity_id":{"type":"string","description":"Identificador único da entidade no formato `{entity_type}:{uuid_v7}`.","pattern":"^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$","example":"{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e","title":"EntityID"},"created_at":{"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"},"updated_at":{"type":"string","description":"Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).","format":"date-time","pattern":"^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\\.(?<fraction>[0-9]{1,9}))?Z$","title":"DateTime"}},"required":["entity_id","entity_type","reference_date","posted","confirmable","provisioned","available","asset_entity_id","created_at","updated_at"],"title":"Position"},"metadata":{"type":"object","description":"Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings. O tamanho maximo do objeto deve ser 1MB.","additionalProperties":{"type":"string"},"maxProperties":10,"example":{"foo":"bar"},"title":"Metadata"}},"title":"Book"}}
3535
schemaType={"response"}
3636
>
3737

0 commit comments

Comments
 (0)