Skip to content

Commit 0c9fa26

Browse files
MCarlomagnoMCarlomagno
authored
fix: update docs & client (#96)
* feat: update openapi to lts version * feat: update openapi to lts version * fix: stellar examples * fix: openapi generator * fix: stellar example
1 parent 6b4c5f4 commit 0c9fa26

147 files changed

Lines changed: 2407 additions & 1227 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/.openapi-generator/FILES‎

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,44 @@
11
Apis/HealthApi.md
22
Apis/MetricsApi.md
3+
Apis/PluginsApi.md
34
Apis/RelayersApi.md
45
Models/ApiResponse_BalanceResponse.md
56
Models/ApiResponse_BalanceResponse_data.md
7+
Models/ApiResponse_DeletePendingTransactionsResponse.md
8+
Models/ApiResponse_DeletePendingTransactionsResponse_data.md
9+
Models/ApiResponse_PluginCallResponse.md
10+
Models/ApiResponse_PluginCallResponse_data.md
611
Models/ApiResponse_RelayerResponse.md
712
Models/ApiResponse_RelayerResponse_data.md
13+
Models/ApiResponse_RelayerStatus.md
14+
Models/ApiResponse_RelayerStatus_data.md
15+
Models/ApiResponse_RelayerStatus_data_oneOf.md
16+
Models/ApiResponse_RelayerStatus_data_oneOf_1.md
817
Models/ApiResponse_SignDataResponse.md
918
Models/ApiResponse_SignDataResponse_data.md
1019
Models/ApiResponse_String.md
1120
Models/ApiResponse_TransactionResponse.md
1221
Models/ApiResponse_TransactionResponse_data.md
1322
Models/ApiResponse_Vec_RelayerResponse.md
1423
Models/ApiResponse_Vec_TransactionResponse.md
15-
Models/ApiResponse_bool.md
1624
Models/AssetSpec.md
1725
Models/AssetSpec_oneOf.md
1826
Models/AssetSpec_oneOf_1.md
19-
Models/AssetSpec_oneOf_CREDIT4.md
27+
Models/AssetSpec_oneOf_2.md
28+
Models/AuthSpec.md
29+
Models/AuthSpec_oneOf.md
30+
Models/AuthSpec_oneOf_1.md
31+
Models/AuthSpec_oneOf_2.md
32+
Models/AuthSpec_oneOf_3.md
2033
Models/BalanceResponse.md
34+
Models/ContractSource.md
35+
Models/ContractSource_oneOf.md
36+
Models/ContractSource_oneOf_1.md
37+
Models/DeletePendingTransactionsResponse.md
2138
Models/EvmPolicyResponse.md
2239
Models/EvmRpcRequest.md
2340
Models/EvmRpcRequest_oneOf.md
24-
Models/EvmRpcResult.md
41+
Models/EvmRpcRequest_oneOf_1.md
2542
Models/EvmTransactionRequest.md
2643
Models/EvmTransactionResponse.md
2744
Models/FeeEstimateRequestParams.md
@@ -30,10 +47,13 @@ Models/GetFeaturesEnabledResult.md
3047
Models/GetSupportedTokensItem.md
3148
Models/GetSupportedTokensResult.md
3249
Models/JsonRpcError.md
50+
Models/JsonRpcId.md
3351
Models/JsonRpcRequest_NetworkRpcRequest.md
3452
Models/JsonRpcResponse_NetworkRpcResult.md
3553
Models/JsonRpcResponse_NetworkRpcResult_result.md
3654
Models/JupiterSwapOptions.md
55+
Models/LogEntry.md
56+
Models/LogLevel.md
3757
Models/MemoSpec.md
3858
Models/MemoSpec_oneOf.md
3959
Models/MemoSpec_oneOf_1.md
@@ -47,11 +67,19 @@ Models/NetworkTransactionRequest.md
4767
Models/NetworkType.md
4868
Models/OperationSpec.md
4969
Models/OperationSpec_oneOf.md
70+
Models/OperationSpec_oneOf_1.md
71+
Models/OperationSpec_oneOf_2.md
72+
Models/OperationSpec_oneOf_3.md
5073
Models/PaginationMeta.md
74+
Models/PluginCallRequest.md
75+
Models/PluginCallResponse.md
5176
Models/PrepareTransactionRequestParams.md
5277
Models/PrepareTransactionResult.md
5378
Models/RelayerResponse.md
5479
Models/RelayerSolanaSwapConfig.md
80+
Models/RelayerSolanaSwapConfig_jupiter_swap_options.md
81+
Models/RelayerSolanaSwapConfig_strategy.md
82+
Models/RelayerStatus.md
5583
Models/RelayerUpdateRequest.md
5684
Models/SignAndSendTransactionRequestParams.md
5785
Models/SignAndSendTransactionResult.md
@@ -81,11 +109,15 @@ Models/SolanaTransactionResponse.md
81109
Models/Speed.md
82110
Models/StellarPolicyResponse.md
83111
Models/StellarRpcRequest.md
112+
Models/StellarRpcRequest_oneOf.md
84113
Models/StellarRpcResult.md
85114
Models/StellarTransactionRequest.md
86115
Models/StellarTransactionResponse.md
87116
Models/TransactionResponse.md
88117
Models/TransactionStatus.md
89118
Models/TransferTransactionRequestParams.md
90119
Models/TransferTransactionResult.md
120+
Models/WasmSource.md
121+
Models/WasmSource_oneOf.md
122+
Models/WasmSource_oneOf_1.md
91123
README.md

‎docs/Apis/HealthApi.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
# HealthApi
22

3-
All URIs are relative to _http://localhost_
3+
All URIs are relative to *http://localhost*
44

5-
| Method | HTTP request | Description |
6-
| --------------------------------- | ------------------ | ---------------------------- |
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
77
| [**health**](HealthApi.md#health) | **GET** /v1/health | Health routes implementation |
88

9-
<a name="health"></a>
109

10+
<a name="health"></a>
1111
# **health**
12-
1312
> String health()
1413
1514
Health routes implementation
1615

1716
Note: OpenAPI documentation for these endpoints can be found in the &#x60;openapi.rs&#x60; file Handles the &#x60;/health&#x60; endpoint. Returns an &#x60;HttpResponse&#x60; with a status of &#x60;200 OK&#x60; and a body of &#x60;\&quot;OK\&quot;&#x60;.
1817

1918
### Parameters
20-
2119
This endpoint does not need any parameter.
2220

2321
### Return type
@@ -32,3 +30,4 @@ No authorization required
3230

3331
- **Content-Type**: Not defined
3432
- **Accept**: text/plain
33+

‎docs/Apis/MetricsApi.md‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
# MetricsApi
22

3-
All URIs are relative to _http://localhost_
3+
All URIs are relative to *http://localhost*
44

5-
| Method | HTTP request | Description |
6-
| ------------------------------------------------ | ------------------------------ | --------------------------------------------------------------------------------- |
7-
| [**listMetrics**](MetricsApi.md#listMetrics) | **GET** /metrics | Metrics routes implementation |
8-
| [**metricDetail**](MetricsApi.md#metricDetail) | **GET** /metrics/{metric_name} | Returns the details of a specific metric in plain text format. |
9-
| [**scrapeMetrics**](MetricsApi.md#scrapeMetrics) | **GET** /debug/metrics/scrape | Triggers an update of system metrics and returns the result in plain text format. |
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
7+
| [**listMetrics**](MetricsApi.md#listMetrics) | **GET** /metrics | Metrics routes implementation |
8+
| [**metricDetail**](MetricsApi.md#metricDetail) | **GET** /metrics/{metric_name} | Returns the details of a specific metric in plain text format. |
9+
| [**scrapeMetrics**](MetricsApi.md#scrapeMetrics) | **GET** /debug/metrics/scrape | Triggers an update of system metrics and returns the result in plain text format. |
1010

11-
<a name="listMetrics"></a>
1211

12+
<a name="listMetrics"></a>
1313
# **listMetrics**
14-
1514
> List listMetrics()
1615
1716
Metrics routes implementation
1817

1918
Note: OpenAPI documentation for these endpoints can be found in the &#x60;openapi.rs&#x60; file Returns a list of all available metric names in JSON format. # Returns An &#x60;HttpResponse&#x60; containing a JSON array of metric names.
2019

2120
### Parameters
22-
2321
This endpoint does not need any parameter.
2422

2523
### Return type
@@ -36,20 +34,18 @@ No authorization required
3634
- **Accept**: application/json
3735

3836
<a name="metricDetail"></a>
39-
4037
# **metricDetail**
41-
42-
> String metricDetail(metric_name)
38+
> String metricDetail(metric\_name)
4339
4440
Returns the details of a specific metric in plain text format.
4541

4642
# Parameters - &#x60;path&#x60;: The name of the metric to retrieve details for. # Returns An &#x60;HttpResponse&#x60; containing the metric details in plain text, or a 404 error if the metric is not found.
4743

4844
### Parameters
4945

50-
| Name | Type | Description | Notes |
51-
| --------------- | ---------- | -------------------------------------------------------------- | ----------------- |
52-
| **metric_name** | **String** | Name of the metric to retrieve, e.g. utopia_transactions_total | [default to null] |
46+
|Name | Type | Description | Notes |
47+
|------------- | ------------- | ------------- | -------------|
48+
| **metric\_name** | **String**| Name of the metric to retrieve, e.g. utopia_transactions_total | [default to null] |
5349

5450
### Return type
5551

@@ -65,17 +61,14 @@ Returns the details of a specific metric in plain text format.
6561
- **Accept**: text/plain
6662

6763
<a name="scrapeMetrics"></a>
68-
6964
# **scrapeMetrics**
70-
7165
> String scrapeMetrics()
7266
7367
Triggers an update of system metrics and returns the result in plain text format.
7468

7569
# Returns An &#x60;HttpResponse&#x60; containing the updated metrics in plain text, or an error message if the update fails.
7670

7771
### Parameters
78-
7972
This endpoint does not need any parameter.
8073

8174
### Return type
@@ -90,3 +83,4 @@ No authorization required
9083

9184
- **Content-Type**: Not defined
9285
- **Accept**: text/plain
86+

‎docs/Apis/PluginsApi.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# PluginsApi
2+
3+
All URIs are relative to *http://localhost*
4+
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
7+
| [**callPlugin**](PluginsApi.md#callPlugin) | **POST** /api/v1/plugins/{plugin_id}/call | Calls a plugin method. |
8+
9+
10+
<a name="callPlugin"></a>
11+
# **callPlugin**
12+
> ApiResponse_PluginCallResponse callPlugin(plugin\_id, PluginCallRequest)
13+
14+
Calls a plugin method.
15+
16+
### Parameters
17+
18+
|Name | Type | Description | Notes |
19+
|------------- | ------------- | ------------- | -------------|
20+
| **plugin\_id** | **String**| The unique identifier of the plugin | [default to null] |
21+
| **PluginCallRequest** | [**PluginCallRequest**](../Models/PluginCallRequest.md)| | |
22+
23+
### Return type
24+
25+
[**ApiResponse_PluginCallResponse**](../Models/ApiResponse_PluginCallResponse.md)
26+
27+
### Authorization
28+
29+
[bearer_auth](../README.md#bearer_auth)
30+
31+
### HTTP request headers
32+
33+
- **Content-Type**: application/json
34+
- **Accept**: application/json
35+

0 commit comments

Comments
 (0)