1 unstable release

0.0.5	Feb 26, 2024

#2 in #marlowe

Used in 2 crates

Apache-2.0

240KB
5K SLoC

Rust API client for marlowe_client

REST API for Marlowe Runtime

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 0.0.5.1
Package version: 0.0.5.1
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named marlowe_client and add the following to Cargo.toml under [dependencies]:

marlowe_client = { path = "./marlowe_client" }

Documentation for API Endpoints

All URIs are relative to https://marlowe-runtime-preprod-web.scdev.aws.iohkdev.io

Class	Method	HTTP request	Description
DefaultApi	apply_inputs_to_contract	POST /contracts/{contractId}/transactions	Apply inputs to contract
DefaultApi	create_contract	POST /contracts	Create a new contract
DefaultApi	create_contract_sources	POST /contracts/sources	Upload contract sources
DefaultApi	get_contract_by_id	GET /contracts/{contractId}	Get contract by ID
DefaultApi	get_contract_source_adjacency	GET /contracts/sources/{contractSourceId}/adjacency	Get adjacent contract source IDs by ID
DefaultApi	get_contract_source_by_id	GET /contracts/sources/{contractSourceId}	Get contract source by ID
DefaultApi	get_contract_source_closure	GET /contracts/sources/{contractSourceId}/closure	Get contract source closure by ID
DefaultApi	get_contract_transaction_by_id	GET /contracts/{contractId}/transactions/{transactionId}	Get contract transaction by ID
DefaultApi	get_contracts	GET /contracts	Get contracts
DefaultApi	get_next_steps_for_contract	GET /contracts/{contractId}/next	Get next contract steps
DefaultApi	get_payout_by_id	GET /payouts/{payoutId}	Get payout by ID
DefaultApi	get_payouts	GET /payouts	Get role payouts
DefaultApi	get_transactions_for_contract	GET /contracts/{contractId}/transactions	Get transactions for contract
DefaultApi	get_withdrawal_by_id	GET /withdrawals/{withdrawalId}	Get withdrawal by ID
DefaultApi	get_withdrawals	GET /withdrawals	Get withdrawals
DefaultApi	healthcheck	GET /healthcheck	Test server status
DefaultApi	submit_contract	PUT /contracts/{contractId}	Submit contract to chain
DefaultApi	submit_contract_transaction	PUT /contracts/{contractId}/transactions/{transactionId}	Submit contract input application
DefaultApi	submit_withdrawal	PUT /withdrawals/{withdrawalId}	Submit payout withdrawal
DefaultApi	withdraw_payouts	POST /withdrawals	Withdraw payouts

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Dependencies

~5–20MB
~238K SLoC