1个不稳定版本

0.0.5	2024年2月26日

#2755 在魔法豆

用于 2 crates

Apache-2.0

240KB
5K SLoC

Rust API客户端为marlowe_client

Marlowe运行时的REST API

概述

此API客户端是由OpenAPI Generator项目生成的。通过使用来自远程服务器的openapi-spec，您可以轻松生成API客户端。

API版本：0.0.5.1
包版本：0.0.5.1
构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在您的项目文件夹中名为 marlowe_client 的目录下，并在 Cargo.toml 中的 [dependencies] 下添加以下内容：

marlowe_client = { path = "./marlowe_client" }

API端点文档

所有URI都是相对于 https://marlowe-runtime-preprod-web.scdev.aws.iohkdev.io

类	方法	HTTP请求	描述
DefaultApi	apply_inputs_to_contract	POST /contracts/{contractId}/transactions	将输入应用于合同
DefaultApi	create_contract	POST /contracts	创建一个新的合同
DefaultApi	create_contract_sources	POST /contracts/sources	上传合同源文件
DefaultApi	get_contract_by_id	GET /contracts/{contractId}	通过ID获取合同
DefaultApi	get_contract_source_adjacency	GET /contracts/sources/{contractSourceId}/adjacency	通过ID获取相邻合同源ID
DefaultApi	get_contract_source_by_id	GET /contracts/sources/{contractSourceId}	通过ID获取合同源
DefaultApi	get_contract_source_closure	GET /contracts/sources/{contractSourceId}/closure	通过ID获取合同源闭包
DefaultApi	get_contract_transaction_by_id	GET /contracts/{contractId}/transactions/{transactionId}	通过ID获取合同交易
DefaultApi	get_contracts	GET /contracts	获取合同
DefaultApi	get_next_steps_for_contract	GET /contracts/{contractId}/next	获取下一个合同步骤
DefaultApi	get_payout_by_id	GET /payouts/{payoutId}	通过ID获取支付
DefaultApi	get_payouts	GET /payouts	获取角色支付
DefaultApi	get_transactions_for_contract	GET /contracts/{contractId}/transactions	获取合同交易
DefaultApi	get_withdrawal_by_id	GET /withdrawals/{withdrawalId}	通过ID获取提款
DefaultApi	get_withdrawals	GET /withdrawals	获取提款
DefaultApi	healthcheck	GET /healthcheck	测试服务器状态
DefaultApi	submit_contract	PUT /contracts/{contractId}	将合同提交到链上
DefaultApi	submit_contract_transaction	PUT /contracts/{contractId}/transactions/{transactionId}	提交合同输入申请
DefaultApi	submit_withdrawal	PUT /withdrawals/{withdrawalId}	提交支付提款
DefaultApi	withdraw_payouts	POST /withdrawals	提款支付

模型文档

要获取 crate 生成的文档，请使用

cargo doc --open

依赖关系

~4-19MB
~256K SLoC