feat: openapi client and autogeneration script (#457)

Signed-off-by: Chris Gianelloni <[email protected]>

Author: wolf31o2

openapi-config.yml

@@ -0,0 +1,4 @@
+enumClassPrefix: true
+generateInterfaces: true
+structPrefix: true
+isGoSubmodule: true

openapi.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate -i /local/docs/swagger.yaml --git-user-id blinklabs-io --git-repo-id adder -g go -o /local/openapi -c /local/openapi-config.yml
+make format golines
+cd openapi && go mod tidy

openapi/.gitignore

@@ -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

openapi/.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

openapi/.openapi-generator/FILES

@@ -0,0 +1,19 @@
+.gitignore
+.travis.yml
+README.md
+api/openapi.yaml
+api_default.go
+client.go
+configuration.go
+docs/DefaultAPI.md
+docs/PushErrorResponse.md
+docs/PushTokenRequest.md
+docs/PushTokenResponse.md
+git_push.sh
+go.mod
+go.sum
+model_push_error_response.go
+model_push_token_request.go
+model_push_token_response.go
+response.go
+utils.go

openapi/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.14.0

openapi/.travis.yml

@@ -0,0 +1,8 @@
+language: go
+
+install:
+  - go get -d -v .
+
+script:
+  - go build -v ./
+

openapi/README.md

@@ -0,0 +1,118 @@
+# Go API client for openapi
+
+Adder 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: v1
+- Package version: 1.0.0
+- Generator version: 7.14.0
+- 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 */v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DefaultAPI* | [**FcmPost**](docs/DefaultAPI.md#fcmpost) | **Post** /fcm | Store FCM Token
+*DefaultAPI* | [**FcmTokenDelete**](docs/DefaultAPI.md#fcmtokendelete) | **Delete** /fcm/{token} | Delete FCM Token
+*DefaultAPI* | [**FcmTokenGet**](docs/DefaultAPI.md#fcmtokenget) | **Get** /fcm/{token} | Get FCM Token
+
+
+## Documentation For Models
+
+ - [PushErrorResponse](docs/PushErrorResponse.md)
+ - [PushTokenRequest](docs/PushTokenRequest.md)
+ - [PushTokenResponse](docs/PushTokenResponse.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]
+

openapi/api/openapi.yaml

@@ -0,0 +1,111 @@
+openapi: 3.0.1
+info:
+  contact:
+    email: [email protected]
+    name: Blink Labs
+    url: https://blinklabs.io
+  description: Adder API
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  title: Adder API
+  version: v1
+servers:
+- url: /v1
+paths:
+  /fcm:
+    post:
+      description: Store a new FCM token
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/push.TokenRequest"
+        description: FCM Token Request
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                type: string
+          description: Created
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/push.ErrorResponse"
+          description: Bad Request
+      summary: Store FCM Token
+      x-codegen-request-body-name: body
+  /fcm/{token}:
+    delete:
+      description: Delete an FCM token by its value
+      parameters:
+      - description: FCM Token
+        in: path
+        name: token
+        required: true
+        schema:
+          type: string
+      responses:
+        "204":
+          content:
+            application/json:
+              schema:
+                type: string
+          description: No Content
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/push.ErrorResponse"
+          description: Not Found
+      summary: Delete FCM Token
+    get:
+      description: Get an FCM token by its value
+      parameters:
+      - description: FCM Token
+        in: path
+        name: token
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/push.TokenResponse"
+          description: OK
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/push.ErrorResponse"
+          description: Not Found
+      summary: Get FCM Token
+components:
+  schemas:
+    push.ErrorResponse:
+      example:
+        error: error
+      properties:
+        error:
+          type: string
+      type: object
+    push.TokenRequest:
+      properties:
+        fcmToken:
+          type: string
+      required:
+      - fcmToken
+      type: object
+    push.TokenResponse:
+      example:
+        fcmToken: fcmToken
+      properties:
+        fcmToken:
+          type: string
+      type: object
+x-original-swagger-version: "2.0"