certusone
/
wormhole-explorer
mirror of https://github.com/certusone/wormhole-explorer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix api doc basepath (#423) 

fix api doc basepath

Co-authored-by: Hernan Gips <hernangips@OnoSendai.local>
This commit is contained in:
gipsh 2023-06-18 13:17:22 -03:00 committed by GitHub
parent 3f823c51ac
commit b490be0f5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 83 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
api/docs/docs.go
View File

@ -1,4 +1,4 @@
// Code generated by swaggo/swag. DO NOT EDIT // Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs package docs
import "github.com/swaggo/swag" import "github.com/swaggo/swag"
@ -574,19 +574,12 @@ const docTemplate = `{
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "status": {
}, "type": "string"
{
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
} }
] }
} }
}, },
"400": { "400": {
@ -899,19 +892,12 @@ const docTemplate = `{
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "ready": {
}, "type": "string"
{
"type": "object",
"properties": {
"ready": {
"type": "string"
}
}
} }
] }
} }
}, },
"400": { "400": {
@ -1625,22 +1611,15 @@ const docTemplate = `{
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "vaaBytes": {
}, "type": "array",
{ "items": {
"type": "object", "type": "integer"
"properties": {
"vaaBytes": {
"type": "array",
"items": {
"type": "integer"
}
}
} }
} }
] }
} }
}, },
"400": { "400": {
@ -1686,22 +1665,15 @@ const docTemplate = `{
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "vaaBytes": {
}, "type": "array",
{ "items": {
"type": "object", "type": "integer"
"properties": {
"vaaBytes": {
"type": "array",
"items": {
"type": "integer"
}
}
} }
} }
] }
} }
}, },
"400": { "400": {
@ -1752,6 +1724,9 @@ const docTemplate = `{
"id": { "id": {
"type": "string" "type": "string"
}, },
"originAddress": {
"type": "string"
},
"originChain": { "originChain": {
"$ref": "#/definitions/vaa.ChainID" "$ref": "#/definitions/vaa.ChainID"
}, },
@ -2782,12 +2757,14 @@ const docTemplate = `{
var SwaggerInfo = &swag.Spec{ var SwaggerInfo = &swag.Spec{
Version: "1.0", Version: "1.0",
Host: "", Host: "",
BasePath: "/v1", BasePath: "/",
Schemes: []string{}, Schemes: []string{},
Title: "Wormhole Guardian API", Title: "Wormhole Guardian API",
Description: "Wormhole Guardian API\nThis is the API for the Wormhole Guardian and Explorer.\nThe API has two namespaces: wormscan and guardian.\nwormscan is the namespace for the explorer and the new endpoints. The prefix is /api/v1.\nguardian is the legacy namespace backguard compatible with guardian node API. The prefix is /v1.\nThis API is public and does not require authentication although some endpoints are rate limited.\nCheck each endpoint documentation for more information.", Description: "Wormhole Guardian API\nThis is the API for the Wormhole Guardian and Explorer.\nThe API has two namespaces: wormscan and guardian.\nwormscan is the namespace for the explorer and the new endpoints. The prefix is /api/v1.\nguardian is the legacy namespace backguard compatible with guardian node API. The prefix is /v1.\nThis API is public and does not require authentication although some endpoints are rate limited.\nCheck each endpoint documentation for more information.",
InfoInstanceName: "swagger", InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate, SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
} }
func init() { func init() {

81
api/docs/swagger.json
View File

@ -15,7 +15,7 @@
}, },
"version": "1.0" "version": "1.0"
}, },
"basePath": "/v1", "basePath": "/",
"paths": { "paths": {
"/api/v1/address/{address}": { "/api/v1/address/{address}": {
"get": { "get": {
@ -567,19 +567,12 @@
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "status": {
}, "type": "string"
{
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
} }
] }
} }
}, },
"400": { "400": {
@ -892,19 +885,12 @@
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "ready": {
}, "type": "string"
{
"type": "object",
"properties": {
"ready": {
"type": "string"
}
}
} }
] }
} }
}, },
"400": { "400": {
@ -1618,22 +1604,15 @@
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "vaaBytes": {
}, "type": "array",
{ "items": {
"type": "object", "type": "integer"
"properties": {
"vaaBytes": {
"type": "array",
"items": {
"type": "integer"
}
}
} }
} }
] }
} }
}, },
"400": { "400": {
@ -1679,22 +1658,15 @@
"200": { "200": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"allOf": [ "type": "object",
{ "properties": {
"type": "object" "vaaBytes": {
}, "type": "array",
{ "items": {
"type": "object", "type": "integer"
"properties": {
"vaaBytes": {
"type": "array",
"items": {
"type": "integer"
}
}
} }
} }
] }
} }
}, },
"400": { "400": {
@ -1745,6 +1717,9 @@
"id": { "id": {
"type": "string" "type": "string"
}, },
"originAddress": {
"type": "string"
},
"originChain": { "originChain": {
"$ref": "#/definitions/vaa.ChainID" "$ref": "#/definitions/vaa.ChainID"
}, },

52
api/docs/swagger.yaml
View File

@ -1,4 +1,4 @@
basePath: /v1 basePath: /
definitions: definitions:
address.AddressOverview: address.AddressOverview:
properties: properties:
@ -24,6 +24,8 @@ definitions:
$ref: '#/definitions/vaa.ChainID' $ref: '#/definitions/vaa.ChainID'
id: id:
type: string type: string
originAddress:
type: string
originChain: originChain:
$ref: '#/definitions/vaa.ChainID' $ref: '#/definitions/vaa.ChainID'
status: status:
@ -1106,12 +1108,10 @@ paths:
"200": "200":
description: OK description: OK
schema: schema:
allOf: properties:
- type: object status:
- properties: type: string
status: type: object
type: string
type: object
"400": "400":
description: Bad Request description: Bad Request
"500": "500":
@ -1323,12 +1323,10 @@ paths:
"200": "200":
description: OK description: OK
schema: schema:
allOf: properties:
- type: object ready:
- properties: type: string
ready: type: object
type: string
type: object
"400": "400":
description: Bad Request description: Bad Request
"500": "500":
@ -1824,14 +1822,12 @@ paths:
"200": "200":
description: OK description: OK
schema: schema:
allOf: properties:
- type: object vaaBytes:
- properties: items:
vaaBytes: type: integer
items: type: array
type: integer type: object
type: array
type: object
"400": "400":
description: Bad Request description: Bad Request
"500": "500":
@ -1862,14 +1858,12 @@ paths:
"200": "200":
description: OK description: OK
schema: schema:
allOf: properties:
- type: object vaaBytes:
- properties: items:
vaaBytes: type: integer
items: type: array
type: integer type: object
type: array
type: object
"400": "400":
description: Bad Request description: Bad Request
"500": "500":

2
api/main.go
View File

@ -86,7 +86,7 @@ func GetSwagger(ctx *fiber.Ctx) error {
// @contact.email info@wormhole.com // @contact.email info@wormhole.com
// @license.name Apache 2.0 // @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html // @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @BasePath /v1 // @BasePath /
func main() { func main() {
appCtx, cancel := context.WithCancel(context.Background()) appCtx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()