Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: openapi client #203

Merged
merged 1 commit into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions openapi/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.o
*.a
*.so

# Folders
_obj
_test

# Architecture specific extensions/prefixes
*.[568vq]
[568vq].out

*.cgo1.go
*.cgo2.c
_cgo_defun.c
_cgo_gotypes.go
_cgo_export.*

_testmain.go

*.exe
*.test
*.prof
23 changes: 23 additions & 0 deletions openapi/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -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
33 changes: 33 additions & 0 deletions openapi/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.gitignore
.travis.yml
README.md
api/openapi.yaml
api_chainsync.go
api_default.go
api_localstatequery.go
api_localtxmonitor.go
client.go
configuration.go
docs/ApiResponseApiError.md
docs/ApiResponseLocalStateQueryCurrentEra.md
docs/ApiResponseLocalStateQuerySystemStart.md
docs/ApiResponseLocalStateQueryTip.md
docs/ApiResponseLocalTxMonitorHasTx.md
docs/ApiResponseLocalTxMonitorSizes.md
docs/ApiResponseLocalTxMonitorTxs.md
docs/ChainsyncAPI.md
docs/DefaultAPI.md
docs/LocalstatequeryAPI.md
docs/LocaltxmonitorAPI.md
git_push.sh
go.mod
go.sum
model_api_response_api_error.go
model_api_response_local_state_query_current_era.go
model_api_response_local_state_query_system_start.go
model_api_response_local_state_query_tip.go
model_api_response_local_tx_monitor_has_tx.go
model_api_response_local_tx_monitor_sizes.go
model_api_response_local_tx_monitor_txs.go
response.go
utils.go
1 change: 1 addition & 0 deletions openapi/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.8.0-SNAPSHOT
3 changes: 3 additions & 0 deletions openapi/.openapi-generator/go-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
enumClassPrefix: true
generateInterfaces: true
structPrefix: true
8 changes: 8 additions & 0 deletions openapi/.travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
language: go

install:
- go get -d -v .

script:
- go build -v ./

130 changes: 130 additions & 0 deletions openapi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Go API client for openapi

Cardano Node API

## Overview
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.

- API version: 1.0
- Package version: 1.0.0
- Generator version: 7.8.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://blinklabs.io](https://blinklabs.io)

## Installation

Install the following dependencies:

```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```go
import openapi "github.com/blinklabs-io/cardano-node-api/openapi"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `openapi.ContextServerIndex` of type `int`.

```go
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `openapi.ContextServerVariables` of type `map[string]string`.

```go
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `openapi.ContextOperationServerIndices` and `openapi.ContextOperationServerVariables` context maps.

```go
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ChainsyncAPI* | [**ChainsyncSyncGet**](docs/ChainsyncAPI.md#chainsyncsyncget) | **Get** /chainsync/sync | Start a chain-sync using a websocket for events
*DefaultAPI* | [**LocaltxsubmissionTxPost**](docs/DefaultAPI.md#localtxsubmissiontxpost) | **Post** /localtxsubmission/tx | Submit Tx
*LocalstatequeryAPI* | [**LocalstatequeryCurrentEraGet**](docs/LocalstatequeryAPI.md#localstatequerycurrenteraget) | **Get** /localstatequery/current-era | Query Current Era
*LocalstatequeryAPI* | [**LocalstatequeryEraHistoryGet**](docs/LocalstatequeryAPI.md#localstatequeryerahistoryget) | **Get** /localstatequery/era-history | Query Era History
*LocalstatequeryAPI* | [**LocalstatequeryGenesisConfigGet**](docs/LocalstatequeryAPI.md#localstatequerygenesisconfigget) | **Get** /localstatequery/genesis-config | Query Genesis Config
*LocalstatequeryAPI* | [**LocalstatequeryProtocolParamsGet**](docs/LocalstatequeryAPI.md#localstatequeryprotocolparamsget) | **Get** /localstatequery/protocol-params | Query Current Protocol Parameters
*LocalstatequeryAPI* | [**LocalstatequerySystemStartGet**](docs/LocalstatequeryAPI.md#localstatequerysystemstartget) | **Get** /localstatequery/system-start | Query System Start
*LocalstatequeryAPI* | [**LocalstatequeryTipGet**](docs/LocalstatequeryAPI.md#localstatequerytipget) | **Get** /localstatequery/tip | Query Chain Tip
*LocaltxmonitorAPI* | [**LocaltxmonitorHasTxTxHashGet**](docs/LocaltxmonitorAPI.md#localtxmonitorhastxtxhashget) | **Get** /localtxmonitor/has_tx/{tx_hash} | Check if a particular TX exists in the mempool
*LocaltxmonitorAPI* | [**LocaltxmonitorSizesGet**](docs/LocaltxmonitorAPI.md#localtxmonitorsizesget) | **Get** /localtxmonitor/sizes | Get mempool capacity, size, and TX count
*LocaltxmonitorAPI* | [**LocaltxmonitorTxsGet**](docs/LocaltxmonitorAPI.md#localtxmonitortxsget) | **Get** /localtxmonitor/txs | List all transactions in the mempool


## Documentation For Models

- [ApiResponseApiError](docs/ApiResponseApiError.md)
- [ApiResponseLocalStateQueryCurrentEra](docs/ApiResponseLocalStateQueryCurrentEra.md)
- [ApiResponseLocalStateQuerySystemStart](docs/ApiResponseLocalStateQuerySystemStart.md)
- [ApiResponseLocalStateQueryTip](docs/ApiResponseLocalStateQueryTip.md)
- [ApiResponseLocalTxMonitorHasTx](docs/ApiResponseLocalTxMonitorHasTx.md)
- [ApiResponseLocalTxMonitorSizes](docs/ApiResponseLocalTxMonitorSizes.md)
- [ApiResponseLocalTxMonitorTxs](docs/ApiResponseLocalTxMonitorTxs.md)


## Documentation For Authorization

Endpoints do not require authorization.


## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`

## Author

[email protected]

Loading