From 52d4f091b4636fdf7de6eb6ddbbdd0c865192deb Mon Sep 17 00:00:00 2001 From: tamirms Date: Mon, 31 Jul 2023 23:21:09 +0100 Subject: [PATCH] Update openapi schema to include missing fields in asset schema (#94) * Update openapi schema to include missing fields in asset schema * update other pages * update build api docs script name * Including redocly as a devDependency, re-organizing some scripts * Now includes scripts to clean, bundle, and generate api-docs, and one "umbrella" script to run them all. * Updating the redocly config to use the most up-to-date conventsion. * Updating the bundled openapi spec, and generated files * Re-generate bundled file * Update README for openapi * Adding some clarifying README files to help with generating api docs * Updating api generation commands * Regenerating API pages Co-authored-by: Tyler van der Hoeven Co-authored-by: Gleb Co-authored-by: Elliot Voris Co-authored-by: Elliot Voris --- api/anchor-platform/callbacks/get-rates.api.mdx | 2 +- api/anchor-platform/callbacks/put-customer.api.mdx | 2 +- .../resources/get-transaction.api.mdx | 2 +- .../resources/get-transactions.api.mdx | 2 +- .../resources/patch-transactions.api.mdx | 4 ++-- api/horizon/resources/assets/object.mdx | 14 +++++++++++++- api/horizon/resources/list-all-assets.api.mdx | 4 ++-- openapi/horizon/README.md | 7 +++++++ openapi/horizon/bundled.yml | 10 ++++++++++ .../examples/responses/Assets/ListAllAssets.yml | 6 ++++++ openapi/horizon/components/schemas/assetSchema.yml | 4 ++++ redocly.yaml | 2 +- 12 files changed, 49 insertions(+), 10 deletions(-) diff --git a/api/anchor-platform/callbacks/get-rates.api.mdx b/api/anchor-platform/callbacks/get-rates.api.mdx index 0999cd6cc..45511c512 100644 --- a/api/anchor-platform/callbacks/get-rates.api.mdx +++ b/api/anchor-platform/callbacks/get-rates.api.mdx @@ -52,7 +52,7 @@ Success. An object describing the fees added on top of the rate provided via the `price` attribute. -
details object[]
  • Array [
  • ]
  • +
    details object[]
  • Array [
  • ]
  • Unprocessable Entity. This status should be returned when the anchor understood the request but cannot return a success response. diff --git a/api/anchor-platform/callbacks/put-customer.api.mdx b/api/anchor-platform/callbacks/put-customer.api.mdx index ae14e2391..9ae269b4b 100644 --- a/api/anchor-platform/callbacks/put-customer.api.mdx +++ b/api/anchor-platform/callbacks/put-customer.api.mdx @@ -5,7 +5,7 @@ description: "**The Anchor Platform does not persist any customer KYC data.**" sidebar_label: "Create or Update Customer Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-06-30","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-06-30","id_expiration_date":"2023-06-30","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-07-31","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-07-31","id_expiration_date":"2023-07-31","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null diff --git a/api/anchor-platform/resources/get-transaction.api.mdx b/api/anchor-platform/resources/get-transaction.api.mdx index 74b55f5e0..ef27b40fa 100644 --- a/api/anchor-platform/resources/get-transaction.api.mdx +++ b/api/anchor-platform/resources/get-transaction.api.mdx @@ -67,7 +67,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
    +
    Bad Request diff --git a/api/anchor-platform/resources/get-transactions.api.mdx b/api/anchor-platform/resources/get-transactions.api.mdx index 1ac21a159..26f3fd97c 100644 --- a/api/anchor-platform/resources/get-transactions.api.mdx +++ b/api/anchor-platform/resources/get-transactions.api.mdx @@ -67,7 +67,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
  • ]
  • +
  • ]
  • Bad Request diff --git a/api/anchor-platform/resources/patch-transactions.api.mdx b/api/anchor-platform/resources/patch-transactions.api.mdx index 0add52d38..61ce8864c 100644 --- a/api/anchor-platform/resources/patch-transactions.api.mdx +++ b/api/anchor-platform/resources/patch-transactions.api.mdx @@ -5,7 +5,7 @@ description: "Accepts one or more objects containing updated information on tran sidebar_label: "Update Transactions Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"patchTransactions","description":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","responses":{"200":{"description":"Transaction(s) updated.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"}}},"title":"TransactionListSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}}},"title":"TransactionListSEP31"}]}}}},"400":{"description":"Invalid request body. The error returned pertains to the transaction first determined to be invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string","description":"The `id` of the transaction first determined to be invalid."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP24"}}}}},"title":"PatchTransactionSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"message":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP31"}}}}},"title":"PatchTransactionSEP31"}]}}}},"method":"patch","path":"/transactions","jsonRequestBodyExample":{"records":[{"transaction":{"id":"string","sep":"24","status":"incomplete","amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-06-30T17:21:24.043Z","updated_at":"2023-06-30T17:21:24.043Z","completed_at":"2023-06-30T17:21:24.043Z","transfer_received_at":"2023-06-30T17:21:24.043Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-06-30T17:21:24.043Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"memo":"string","memo_type":"text id hash","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2023-06-30T17:21:24.043Z","refunded_at":"2023-06-30T17:21:24.043Z"}]}}}]},"info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Update Transactions Info","description":{"content":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"patchTransactions","description":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","responses":{"200":{"description":"Transaction(s) updated.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"}}},"title":"TransactionListSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}}},"title":"TransactionListSEP31"}]}}}},"400":{"description":"Invalid request body. The error returned pertains to the transaction first determined to be invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string","description":"The `id` of the transaction first determined to be invalid."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP24"}}}}},"title":"PatchTransactionSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"message":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP31"}}}}},"title":"PatchTransactionSEP31"}]}}}},"method":"patch","path":"/transactions","jsonRequestBodyExample":{"records":[{"transaction":{"id":"string","sep":"24","status":"incomplete","amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-07-31T22:10:29.899Z","updated_at":"2023-07-31T22:10:29.899Z","completed_at":"2023-07-31T22:10:29.899Z","transfer_received_at":"2023-07-31T22:10:29.899Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-07-31T22:10:29.899Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"memo":"string","memo_type":"text id hash","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2023-07-31T22:10:29.899Z","refunded_at":"2023-07-31T22:10:29.899Z"}]}}}]},"info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Update Transactions Info","description":{"content":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: api/anchor-platform/resources/platform-api custom_edit_url: null @@ -100,7 +100,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
  • ]
  • +
  • ]
  • Invalid request body. The error returned pertains to the transaction first determined to be invalid. diff --git a/api/horizon/resources/assets/object.mdx b/api/horizon/resources/assets/object.mdx index 3498a6428..9bdd3cd8c 100644 --- a/api/horizon/resources/assets/object.mdx +++ b/api/horizon/resources/assets/object.mdx @@ -28,12 +28,24 @@ When Horizon returns information about an asset, it uses the following format: - num_claimable_balances - number - The current number of claimable_balances for this asset. +- num_contracts + - number + - The current number of Soroban contracts holding this asset. +- num_liquidity_pools + - number + - The current number of liquidity pools holding this asset. - balances - object - The number of units issued for this asset grouped by each trustline flag state. - claimable_balances_amount - string - - The number of units in claimable balances for this asset. + - The number of units for this asset held by all claimable balances. +- contracts_amount + - string + - The number of units for this asset held by all Soroban contracts. +- liquidity_pools_amount + - string + - The number of units for this asset held by all liquidity pools. - amount - string - The number of authorized units issued for this asset. This will be deprecated in Horizon v3. diff --git a/api/horizon/resources/list-all-assets.api.mdx b/api/horizon/resources/list-all-assets.api.mdx index cbf603337..73e8b83d9 100644 --- a/api/horizon/resources/list-all-assets.api.mdx +++ b/api/horizon/resources/list-all-assets.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all assets." sidebar_label: "List all Assets" hide_title: true hide_table_of_contents: true -api: {"tags":["Assets"],"description":"This endpoint lists all assets.","operationId":"ListAllAssets","parameters":[{"name":"asset_code","in":"query","required":false,"description":"The code of the asset you would like to filter by."},{"name":"asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer for the asset you would like to filter by."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"toml":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"asset_type":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"},"accounts":{"type":"object","properties":{"authorized":{"type":"integer"},"authorized_to_maintain_liabilities":{"type":"integer"},"unauthorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"num_liquidity_pools":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unauthorized":{"type":"string"}}},"claimable_balances_amount":{"type":"string"},"liquidity_pools_amount":{"type":"string"},"amount":{"type":"string"},"num_accounts":{"type":"integer"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"}}}}}}}}},"title":"Asset"}]},"examples":{"ListAllAssets":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"toml":{"href":"https://swisscustodys.org/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A","paging_token":"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4","num_accounts":10,"num_claimable_balances":0,"num_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"899996000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}},{"_links":{"toml":{"href":"https://StellarAssets.org/fx/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N","paging_token":"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4","num_accounts":43,"num_claimable_balances":0,"num_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"1.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":true}},{"_links":{"toml":{"href":"https://masterstellar.com/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I","paging_token":"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4","num_accounts":1,"num_claimable_balances":0,"num_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"65000000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/assets","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Assets","description":{"content":"This endpoint lists all assets.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The code of the asset you would like to filter by.","type":"text/plain"},"key":"asset_code","value":""},{"description":{"content":"The Stellar address of the issuer for the asset you would like to filter by.","type":"text/plain"},"key":"asset_issuer","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Assets"],"description":"This endpoint lists all assets.","operationId":"ListAllAssets","parameters":[{"name":"asset_code","in":"query","required":false,"description":"The code of the asset you would like to filter by."},{"name":"asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer for the asset you would like to filter by."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"toml":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"asset_type":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"},"accounts":{"type":"object","properties":{"authorized":{"type":"integer"},"authorized_to_maintain_liabilities":{"type":"integer"},"unauthorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"num_contracts":{"type":"integer"},"num_liquidity_pools":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unauthorized":{"type":"string"}}},"claimable_balances_amount":{"type":"string"},"contracts_amount":{"type":"string"},"liquidity_pools_amount":{"type":"string"},"amount":{"type":"string"},"num_accounts":{"type":"integer"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"}}}}}}}}},"title":"Asset"}]},"examples":{"ListAllAssets":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"toml":{"href":"https://swisscustodys.org/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A","paging_token":"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4","num_accounts":10,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"899996000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}},{"_links":{"toml":{"href":"https://StellarAssets.org/fx/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N","paging_token":"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4","num_accounts":43,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"1.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":true}},{"_links":{"toml":{"href":"https://masterstellar.com/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I","paging_token":"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4","num_accounts":1,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"65000000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/assets","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Assets","description":{"content":"This endpoint lists all assets.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The code of the asset you would like to filter by.","type":"text/plain"},"key":"asset_code","value":""},{"description":{"content":"The Stellar address of the issuer for the asset you would like to filter by.","type":"text/plain"},"key":"asset_issuer","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null @@ -30,5 +30,5 @@ This endpoint lists all assets. Success -
    Schema
      _links object
      self object
      next object
      prev object
      _embedded object
      records object[]
    • Array [
    • _links object
      toml object
      accounts object
      balances object
      flags object
    • ]
    +
    Schema
      _links object
      self object
      next object
      prev object
      _embedded object
      records object[]
    • Array [
    • _links object
      toml object
      accounts object
      balances object
      flags object
    • ]
    \ No newline at end of file diff --git a/openapi/horizon/README.md b/openapi/horizon/README.md index cde5bbe9a..bd63fd808 100644 --- a/openapi/horizon/README.md +++ b/openapi/horizon/README.md @@ -65,6 +65,13 @@ yarn api:clean yarn api:bundle ``` +If you don't have `redocly` installed, you can use `npx` to accomplish the same +thing: + +```bash +npx @redocly/cli@latest bundle openapi/main.yml --output openapi/bundled.yml +``` + 3. Generate the new `.mdx` files that will be read and parsed for people to use. ```bash diff --git a/openapi/horizon/bundled.yml b/openapi/horizon/bundled.yml index a3af5c1ed..a38aa9c09 100644 --- a/openapi/horizon/bundled.yml +++ b/openapi/horizon/bundled.yml @@ -2616,6 +2616,8 @@ components: type: integer num_claimable_balances: type: integer + num_contracts: + type: integer num_liquidity_pools: type: integer balances: @@ -2629,6 +2631,8 @@ components: type: string claimable_balances_amount: type: string + contracts_amount: + type: string liquidity_pools_amount: type: string amount: @@ -4943,6 +4947,7 @@ components: paging_token: CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4 num_accounts: 10 num_claimable_balances: 0 + num_contracts: 0 num_liquidity_pools: 0 amount: '899996000000.0000000' accounts: @@ -4950,6 +4955,7 @@ components: authorized_to_maintain_liabilities: 0 unauthorized: 0 claimable_balances_amount: '0.0000000' + contracts_amount: '0.0000000' liquidity_pools_amount: '0.0000000' balances: authorized: '899996000000.0000000' @@ -4969,6 +4975,7 @@ components: paging_token: CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4 num_accounts: 43 num_claimable_balances: 0 + num_contracts: 0 num_liquidity_pools: 0 amount: '1.0000000' accounts: @@ -4976,6 +4983,7 @@ components: authorized_to_maintain_liabilities: 0 unauthorized: 0 claimable_balances_amount: '0.0000000' + contracts_amount: '0.0000000' liquidity_pools_amount: '0.0000000' balances: authorized: '1.0000000' @@ -4995,6 +5003,7 @@ components: paging_token: CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4 num_accounts: 1 num_claimable_balances: 0 + num_contracts: 0 num_liquidity_pools: 0 amount: '65000000000.0000000' accounts: @@ -5002,6 +5011,7 @@ components: authorized_to_maintain_liabilities: 0 unauthorized: 0 claimable_balances_amount: '0.0000000' + contracts_amount: '0.0000000' liquidity_pools_amount: '0.0000000' balances: authorized: '65000000000.0000000' diff --git a/openapi/horizon/components/examples/responses/Assets/ListAllAssets.yml b/openapi/horizon/components/examples/responses/Assets/ListAllAssets.yml index a5dbd7d4f..571ef41db 100644 --- a/openapi/horizon/components/examples/responses/Assets/ListAllAssets.yml +++ b/openapi/horizon/components/examples/responses/Assets/ListAllAssets.yml @@ -20,6 +20,7 @@ components: paging_token: CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4 num_accounts: 10 num_claimable_balances: 0 + num_contracts: 0 num_liquidity_pools: 0 amount: '899996000000.0000000' accounts: @@ -27,6 +28,7 @@ components: authorized_to_maintain_liabilities: 0 unauthorized: 0 claimable_balances_amount: '0.0000000' + contracts_amount: '0.0000000' liquidity_pools_amount: '0.0000000' balances: authorized: '899996000000.0000000' @@ -46,6 +48,7 @@ components: paging_token: CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4 num_accounts: 43 num_claimable_balances: 0 + num_contracts: 0 num_liquidity_pools: 0 amount: '1.0000000' accounts: @@ -53,6 +56,7 @@ components: authorized_to_maintain_liabilities: 0 unauthorized: 0 claimable_balances_amount: '0.0000000' + contracts_amount: '0.0000000' liquidity_pools_amount: '0.0000000' balances: authorized: '1.0000000' @@ -72,6 +76,7 @@ components: paging_token: CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4 num_accounts: 1 num_claimable_balances: 0 + num_contracts: 0 num_liquidity_pools: 0 amount: '65000000000.0000000' accounts: @@ -79,6 +84,7 @@ components: authorized_to_maintain_liabilities: 0 unauthorized: 0 claimable_balances_amount: '0.0000000' + contracts_amount: '0.0000000' liquidity_pools_amount: '0.0000000' balances: authorized: '65000000000.0000000' diff --git a/openapi/horizon/components/schemas/assetSchema.yml b/openapi/horizon/components/schemas/assetSchema.yml index 4d98dfca5..55e01b106 100644 --- a/openapi/horizon/components/schemas/assetSchema.yml +++ b/openapi/horizon/components/schemas/assetSchema.yml @@ -33,6 +33,8 @@ components: type: integer num_claimable_balances: type: integer + num_contracts: + type: integer num_liquidity_pools: type: integer balances: @@ -46,6 +48,8 @@ components: type: string claimable_balances_amount: type: string + contracts_amount: + type: string liquidity_pools_amount: type: string amount: diff --git a/redocly.yaml b/redocly.yaml index ecbb0a3db..47ae6edaa 100644 --- a/redocly.yaml +++ b/redocly.yaml @@ -28,4 +28,4 @@ theme: languages: - lang: curl - lang: Node.js - - lang: Python \ No newline at end of file + - lang: Python