docs(api docs): add api docs

Author: zeljkoX

README.md

@@ -62,7 +62,10 @@ For more examples, check the [examples directory](examples).
 
 ## API Documentation
 
-The SDK is built on top of an OpenAPI specification which can be found in the [openapi.json](openapi.json) file. For detailed API documentation, please refer to the OpenZeppelin Relayer documentation.
+The SDK is built on top of an OpenAPI specification which can be found in the [openapi.json](openapi.json) file.
+
+For detailed API documentation, please refer to the [API Reference](docs/README.md) in the docs folder. This documentation provides comprehensive information about all available endpoints, request parameters, and response types.
+
 
 ## Development
 

docs/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

docs/.openapi-generator/FILES

@@ -0,0 +1,73 @@
+Apis/MetricsApi.md
+Apis/RelayersApi.md
+Models/ApiResponse_BalanceResponse.md
+Models/ApiResponse_BalanceResponse_data.md
+Models/ApiResponse_RelayerResponse.md
+Models/ApiResponse_RelayerResponse_data.md
+Models/ApiResponse_SignDataResponse.md
+Models/ApiResponse_SignDataResponse_data.md
+Models/ApiResponse_String.md
+Models/ApiResponse_TransactionResponse.md
+Models/ApiResponse_TransactionResponse_data.md
+Models/ApiResponse_Vec_RelayerResponse.md
+Models/ApiResponse_Vec_TransactionResponse.md
+Models/ApiResponse_bool.md
+Models/BalanceResponse.md
+Models/EvmPolicyResponse.md
+Models/EvmRpcRequest.md
+Models/EvmRpcRequest_oneOf.md
+Models/EvmRpcResult.md
+Models/EvmTransactionRequest.md
+Models/EvmTransactionResponse.md
+Models/FeeEstimateRequestParams.md
+Models/FeeEstimateResult.md
+Models/GetFeaturesEnabledResult.md
+Models/GetSupportedTokensItem.md
+Models/GetSupportedTokensResult.md
+Models/JsonRpcError.md
+Models/JsonRpcRequest_NetworkRpcRequest.md
+Models/JsonRpcResponse_NetworkRpcResult.md
+Models/JsonRpcResponse_NetworkRpcResult_result.md
+Models/NetworkPolicyResponse.md
+Models/NetworkRpcRequest.md
+Models/NetworkRpcResult.md
+Models/NetworkTransactionRequest.md
+Models/NetworkType.md
+Models/PaginationMeta.md
+Models/PrepareTransactionRequestParams.md
+Models/PrepareTransactionResult.md
+Models/RelayerResponse.md
+Models/RelayerUpdateRequest.md
+Models/SignAndSendTransactionRequestParams.md
+Models/SignAndSendTransactionResult.md
+Models/SignDataRequest.md
+Models/SignDataResponse.md
+Models/SignDataResponseEvm.md
+Models/SignDataResponseSolana.md
+Models/SignTransactionRequestParams.md
+Models/SignTransactionResult.md
+Models/SignTypedDataRequest.md
+Models/SolanaAllowedTokensPolicy.md
+Models/SolanaPolicyResponse.md
+Models/SolanaRpcRequest.md
+Models/SolanaRpcRequest_oneOf.md
+Models/SolanaRpcRequest_oneOf_1.md
+Models/SolanaRpcRequest_oneOf_2.md
+Models/SolanaRpcRequest_oneOf_3.md
+Models/SolanaRpcRequest_oneOf_4.md
+Models/SolanaRpcRequest_oneOf_5.md
+Models/SolanaRpcRequest_oneOf_6.md
+Models/SolanaRpcResult.md
+Models/SolanaTransactionRequest.md
+Models/SolanaTransactionResponse.md
+Models/Speed.md
+Models/StellarPolicyResponse.md
+Models/StellarRpcRequest.md
+Models/StellarRpcResult.md
+Models/StellarTransactionRequest.md
+Models/StellarTransactionResponse.md
+Models/TransactionResponse.md
+Models/TransactionStatus.md
+Models/TransferTransactionRequestParams.md
+Models/TransferTransactionResult.md
+README.md

docs/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.12.0

docs/Apis/MetricsApi.md

@@ -0,0 +1,86 @@
+# MetricsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listMetrics**](MetricsApi.md#listMetrics) | **GET** /metrics | Returns a list of all available metric names in JSON format. |
+| [**metricDetail**](MetricsApi.md#metricDetail) | **GET** /metrics/{metric_name} | Returns the details of a specific metric in plain text format. |
+| [**scrapeMetrics**](MetricsApi.md#scrapeMetrics) | **GET** /debug/metrics/scrape | Triggers an update of system metrics and returns the result in plain text format. |
+
+
+<a name="listMetrics"></a>
+# **listMetrics**
+> List listMetrics()
+
+Returns a list of all available metric names in JSON format.
+
+    # Returns  An &#x60;HttpResponse&#x60; containing a JSON array of metric names.
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**List**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="metricDetail"></a>
+# **metricDetail**
+> String metricDetail(metric\_name)
+
+Returns the details of a specific metric in plain text format.
+
+    # 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.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **metric\_name** | **String**| Name of the metric to retrieve, e.g. utopia_transactions_total | [default to null] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+<a name="scrapeMetrics"></a>
+# **scrapeMetrics**
+> String scrapeMetrics()
+
+Triggers an update of system metrics and returns the result in plain text format.
+
+    # Returns  An &#x60;HttpResponse&#x60; containing the updated metrics in plain text, or an error message if the update fails.
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+