|
| 1 | +# Go API client for cactus-plugin-ledger-connector-daml |
| 2 | + |
| 3 | +Can perform basic tasks on a DAML ledger |
| 4 | + |
| 5 | +## Overview |
| 6 | +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. |
| 7 | + |
| 8 | +- API version: 2.0.0-rc.3 |
| 9 | +- Package version: 1.0.0 |
| 10 | +- Build package: org.openapitools.codegen.languages.GoClientCodegen |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +Install the following dependencies: |
| 15 | + |
| 16 | +```shell |
| 17 | +go get github.com/stretchr/testify/assert |
| 18 | +go get golang.org/x/net/context |
| 19 | +``` |
| 20 | + |
| 21 | +Put the package under your project folder and add the following in import: |
| 22 | + |
| 23 | +```golang |
| 24 | +import cactus-plugin-ledger-connector-daml "github.com/hyperledger/cactus-plugin-ledger-connector-daml/src/main/go/generated/openapi/go-client" |
| 25 | +``` |
| 26 | + |
| 27 | +To use a proxy, set the environment variable `HTTP_PROXY`: |
| 28 | + |
| 29 | +```golang |
| 30 | +os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") |
| 31 | +``` |
| 32 | + |
| 33 | +## Configuration of Server URL |
| 34 | + |
| 35 | +Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. |
| 36 | + |
| 37 | +### Select Server Configuration |
| 38 | + |
| 39 | +For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`. |
| 40 | + |
| 41 | +```golang |
| 42 | +ctx := context.WithValue(context.Background(), cactus-plugin-ledger-connector-daml.ContextServerIndex, 1) |
| 43 | +``` |
| 44 | + |
| 45 | +### Templated Server URL |
| 46 | + |
| 47 | +Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`. |
| 48 | + |
| 49 | +```golang |
| 50 | +ctx := context.WithValue(context.Background(), cactus-plugin-ledger-connector-daml.ContextServerVariables, map[string]string{ |
| 51 | + "basePath": "v2", |
| 52 | +}) |
| 53 | +``` |
| 54 | + |
| 55 | +Note, enum values are always validated and all unused variables are silently ignored. |
| 56 | + |
| 57 | +### URLs Configuration per Operation |
| 58 | + |
| 59 | +Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. |
| 60 | +An operation is uniquely identified by `"{classname}Service.{nickname}"` string. |
| 61 | +Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. |
| 62 | + |
| 63 | +```golang |
| 64 | +ctx := context.WithValue(context.Background(), cactus-plugin-ledger-connector-daml.ContextOperationServerIndices, map[string]int{ |
| 65 | + "{classname}Service.{nickname}": 2, |
| 66 | +}) |
| 67 | +ctx = context.WithValue(context.Background(), cactus-plugin-ledger-connector-daml.ContextOperationServerVariables, map[string]map[string]string{ |
| 68 | + "{classname}Service.{nickname}": { |
| 69 | + "port": "8443", |
| 70 | + }, |
| 71 | +}) |
| 72 | +``` |
| 73 | + |
| 74 | +## Documentation for API Endpoints |
| 75 | + |
| 76 | +All URIs are relative to *http://localhost* |
| 77 | + |
| 78 | +Class | Method | HTTP request | Description |
| 79 | +------------ | ------------- | ------------- | ------------- |
| 80 | +*DefaultApi* | [**CreateIou**](docs/DefaultApi.md#createiou) | **Post** /api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-daml/create-iou-endpoint | This method creates a simple iou countract |
| 81 | +*DefaultApi* | [**ExerciseChoice**](docs/DefaultApi.md#exercisechoice) | **Post** /api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-daml/exercise-iou-endpoint | This method creates a simple iou countract |
| 82 | +*DefaultApi* | [**GetPartiesInvolved**](docs/DefaultApi.md#getpartiesinvolved) | **Get** /api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-daml/get-parties-involved-endpoint | This method queries DAML contracts |
| 83 | +*DefaultApi* | [**QueryContract**](docs/DefaultApi.md#querycontract) | **Post** /api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-daml/query-iou-endpoint | This method queries DAML contracts |
| 84 | +*DefaultApi* | [**QueryRawContract**](docs/DefaultApi.md#queryrawcontract) | **Get** /api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-daml/query-raw-iou-endpoint | This method queries DAML contracts |
| 85 | + |
| 86 | + |
| 87 | +## Documentation For Models |
| 88 | + |
| 89 | + - [CreateIOUEndpointRequest](docs/CreateIOUEndpointRequest.md) |
| 90 | + - [CreateIOUEndpointRequestPayload](docs/CreateIOUEndpointRequestPayload.md) |
| 91 | + - [CreateIOUEndpointResponse](docs/CreateIOUEndpointResponse.md) |
| 92 | + - [ExerciseIOUEndpointRequest](docs/ExerciseIOUEndpointRequest.md) |
| 93 | + - [ExerciseIOUEndpointRequestArgument](docs/ExerciseIOUEndpointRequestArgument.md) |
| 94 | + - [ExerciseIOUEndpointResponse](docs/ExerciseIOUEndpointResponse.md) |
| 95 | + - [GetPartiesInvolvedEndpointRequest](docs/GetPartiesInvolvedEndpointRequest.md) |
| 96 | + - [QueryIOUEndpointRequest](docs/QueryIOUEndpointRequest.md) |
| 97 | + - [QueryIOUEndpointRequestQuery](docs/QueryIOUEndpointRequestQuery.md) |
| 98 | + - [QueryIOUEndpointResponse](docs/QueryIOUEndpointResponse.md) |
| 99 | + - [QueryIOUEndpointResponseEventsInner](docs/QueryIOUEndpointResponseEventsInner.md) |
| 100 | + - [QueryIOUEndpointResponseEventsInnerArchived](docs/QueryIOUEndpointResponseEventsInnerArchived.md) |
| 101 | + - [QueryRawIOUEndpointRequest](docs/QueryRawIOUEndpointRequest.md) |
| 102 | + |
| 103 | + |
| 104 | +## Documentation For Authorization |
| 105 | + |
| 106 | +Endpoints do not require authorization. |
| 107 | + |
| 108 | + |
| 109 | +## Documentation for Utility Methods |
| 110 | + |
| 111 | +Due to the fact that model structure members are all pointers, this package contains |
| 112 | +a number of utility functions to easily obtain pointers to values of basic types. |
| 113 | +Each of these functions takes a value of the given basic type and returns a pointer to it: |
| 114 | + |
| 115 | +* `PtrBool` |
| 116 | +* `PtrInt` |
| 117 | +* `PtrInt32` |
| 118 | +* `PtrInt64` |
| 119 | +* `PtrFloat` |
| 120 | +* `PtrFloat32` |
| 121 | +* `PtrFloat64` |
| 122 | +* `PtrString` |
| 123 | +* `PtrTime` |
| 124 | + |
| 125 | +## Author |
| 126 | + |
| 127 | + |
| 128 | + |
0 commit comments