-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from blinklabs-io/feat/swagger
feat: swagger using swaggo/swag and gin-swagger
- Loading branch information
Showing
7 changed files
with
354 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
{ | ||
"schemes": [ | ||
"http" | ||
], | ||
"swagger": "2.0", | ||
"info": { | ||
"description": "Programmable Cardano Wallet API", | ||
"title": "bursa", | ||
"contact": { | ||
"name": "Blink Labs", | ||
"url": "https://blinklabs.io", | ||
"email": "[email protected]" | ||
}, | ||
"license": { | ||
"name": "Apache 2.0", | ||
"url": "http://www.apache.org/licenses/LICENSE-2.0.html" | ||
}, | ||
"version": "v0" | ||
}, | ||
"basePath": "/", | ||
"paths": { | ||
"/api/wallet/create": { | ||
"get": { | ||
"description": "Create a wallet and return details", | ||
"produces": [ | ||
"application/json" | ||
], | ||
"summary": "CreateWallet", | ||
"responses": { | ||
"200": { | ||
"description": "Ok", | ||
"schema": { | ||
"$ref": "#/definitions/bursa.Wallet" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"definitions": { | ||
"bursa.KeyFile": { | ||
"type": "object", | ||
"properties": { | ||
"cborHex": { | ||
"type": "string" | ||
}, | ||
"description": { | ||
"type": "string" | ||
}, | ||
"type": { | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"bursa.Wallet": { | ||
"type": "object", | ||
"properties": { | ||
"mnemonic": { | ||
"type": "string" | ||
}, | ||
"payment_address": { | ||
"type": "string" | ||
}, | ||
"payment_kvey": { | ||
"$ref": "#/definitions/bursa.KeyFile" | ||
}, | ||
"payment_skey": { | ||
"$ref": "#/definitions/bursa.KeyFile" | ||
}, | ||
"stake_address": { | ||
"type": "string" | ||
}, | ||
"stake_skey": { | ||
"$ref": "#/definitions/bursa.KeyFile" | ||
}, | ||
"stake_vkey": { | ||
"$ref": "#/definitions/bursa.KeyFile" | ||
} | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
basePath: / | ||
definitions: | ||
bursa.KeyFile: | ||
properties: | ||
cborHex: | ||
type: string | ||
description: | ||
type: string | ||
type: | ||
type: string | ||
type: object | ||
bursa.Wallet: | ||
properties: | ||
mnemonic: | ||
type: string | ||
payment_address: | ||
type: string | ||
payment_kvey: | ||
$ref: '#/definitions/bursa.KeyFile' | ||
payment_skey: | ||
$ref: '#/definitions/bursa.KeyFile' | ||
stake_address: | ||
type: string | ||
stake_skey: | ||
$ref: '#/definitions/bursa.KeyFile' | ||
stake_vkey: | ||
$ref: '#/definitions/bursa.KeyFile' | ||
type: object | ||
info: | ||
contact: | ||
email: [email protected] | ||
name: Blink Labs | ||
url: https://blinklabs.io | ||
description: Programmable Cardano Wallet API | ||
license: | ||
name: Apache 2.0 | ||
url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
title: bursa | ||
version: v0 | ||
paths: | ||
/api/wallet/create: | ||
get: | ||
description: Create a wallet and return details | ||
produces: | ||
- application/json | ||
responses: | ||
"200": | ||
description: Ok | ||
schema: | ||
$ref: '#/definitions/bursa.Wallet' | ||
summary: CreateWallet | ||
schemes: | ||
- http | ||
swagger: "2.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.