Merge pull request #36 from nymtech/fix/correct-banner
Corrected swag @title
This commit is contained in:
Dave Hrycyszyn
GitHub
commit
160ff1aaf3
14
docs/docs.go
14
docs/docs.go
|
|
@ -1,6 +1,6 @@
|
|||
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
|
||||
// This file was generated by swaggo/swag at
|
||||
// 2020-10-28 15:44:19.4192076 +0000 GMT m=+0.057120601
|
||||
// 2020-11-12 11:31:47.2571781 +0000 GMT m=+0.055881401
|
||||
|
||||
package docs
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ var doc = `{
|
|||
"contact": {},
|
||||
"license": {
|
||||
"name": "Apache 2.0",
|
||||
"url": "https://github.com/nymtech/nym-directory/license"
|
||||
"url": "https://github.com/nymtech/nym-metrics-server/"
|
||||
},
|
||||
"version": "{{.Version}}"
|
||||
},
|
||||
|
|
@ -32,7 +32,7 @@ var doc = `{
|
|||
"paths": {
|
||||
"/api/healthcheck": {
|
||||
"get": {
|
||||
"description": "Returns a 200 if the directory server is available. Good route to use for automated monitoring.",
|
||||
"description": "Returns a 200 if the metrics server is available. Good route to use for automated monitoring.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
|
|
@ -42,7 +42,7 @@ var doc = `{
|
|||
"tags": [
|
||||
"healthcheck"
|
||||
],
|
||||
"summary": "Lets the directory server tell the world it's alive.",
|
||||
"summary": "Lets the metrics server tell the world it's alive.",
|
||||
"operationId": "healthCheck",
|
||||
"responses": {
|
||||
"200": {}
|
||||
|
|
@ -199,12 +199,12 @@ type swaggerInfo struct {
|
|||
|
||||
// SwaggerInfo holds exported Swagger Info so clients can modify it
|
||||
var SwaggerInfo = swaggerInfo{
|
||||
Version: "0.9.0-dev",
|
||||
Version: "0.9.0",
|
||||
Host: "",
|
||||
BasePath: "",
|
||||
Schemes: []string{},
|
||||
Title: "Nym Directory API",
|
||||
Description: "This is a temporarily centralized directory/PKI/metrics API to allow us to get the other Nym node types running. Its functionality will eventually be folded into other parts of Nym.",
|
||||
Title: "Nym Metrics API",
|
||||
Description: "This is a temporarily centralized metrics API to allow us to get the other Nym node types running. Its functionality will eventually be folded into other parts of Nym.",
|
||||
}
|
||||
|
||||
type s struct{}
|
||||
|
|
|
|||
|
|
@ -1,20 +1,20 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "This is a temporarily centralized directory/PKI/metrics API to allow us to get the other Nym node types running. Its functionality will eventually be folded into other parts of Nym.",
|
||||
"title": "Nym Directory API",
|
||||
"description": "This is a temporarily centralized metrics API to allow us to get the other Nym node types running. Its functionality will eventually be folded into other parts of Nym.",
|
||||
"title": "Nym Metrics API",
|
||||
"termsOfService": "http://swagger.io/terms/",
|
||||
"contact": {},
|
||||
"license": {
|
||||
"name": "Apache 2.0",
|
||||
"url": "https://github.com/nymtech/nym-directory/license"
|
||||
"url": "https://github.com/nymtech/nym-metrics-server/"
|
||||
},
|
||||
"version": "0.9.0-dev"
|
||||
"version": "0.9.0"
|
||||
},
|
||||
"paths": {
|
||||
"/api/healthcheck": {
|
||||
"get": {
|
||||
"description": "Returns a 200 if the directory server is available. Good route to use for automated monitoring.",
|
||||
"description": "Returns a 200 if the metrics server is available. Good route to use for automated monitoring.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
"tags": [
|
||||
"healthcheck"
|
||||
],
|
||||
"summary": "Lets the directory server tell the world it's alive.",
|
||||
"summary": "Lets the metrics server tell the world it's alive.",
|
||||
"operationId": "healthCheck",
|
||||
"responses": {
|
||||
"200": {}
|
||||
|
|
|
|||
|
|
@ -26,28 +26,28 @@ definitions:
|
|||
type: object
|
||||
info:
|
||||
contact: {}
|
||||
description: This is a temporarily centralized directory/PKI/metrics API to allow
|
||||
us to get the other Nym node types running. Its functionality will eventually
|
||||
be folded into other parts of Nym.
|
||||
description: This is a temporarily centralized metrics API to allow us to get the
|
||||
other Nym node types running. Its functionality will eventually be folded into
|
||||
other parts of Nym.
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: https://github.com/nymtech/nym-directory/license
|
||||
url: https://github.com/nymtech/nym-metrics-server/
|
||||
termsOfService: http://swagger.io/terms/
|
||||
title: Nym Directory API
|
||||
version: 0.9.0-dev
|
||||
title: Nym Metrics API
|
||||
version: 0.9.0
|
||||
paths:
|
||||
/api/healthcheck:
|
||||
get:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Returns a 200 if the directory server is available. Good route
|
||||
to use for automated monitoring.
|
||||
description: Returns a 200 if the metrics server is available. Good route to
|
||||
use for automated monitoring.
|
||||
operationId: healthCheck
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200": {}
|
||||
summary: Lets the directory server tell the world it's alive.
|
||||
summary: Lets the metrics server tell the world it's alive.
|
||||
tags:
|
||||
- healthcheck
|
||||
/api/metrics/mixes:
|
||||
|
|
|
|||
|
|
@ -25,8 +25,8 @@ func (controller *controller) RegisterRoutes(router *gin.Engine) {
|
|||
}
|
||||
|
||||
// HealthCheck ...
|
||||
// @Summary Lets the directory server tell the world it's alive.
|
||||
// @Description Returns a 200 if the directory server is available. Good route to use for automated monitoring.
|
||||
// @Summary Lets the metrics server tell the world it's alive.
|
||||
// @Description Returns a 200 if the metrics server is available. Good route to use for automated monitoring.
|
||||
// @ID healthCheck
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
|
|
|
|||
11
main.go
11
main.go
|
|
@ -2,19 +2,20 @@ package main
|
|||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
_ "github.com/nymtech/nym-directory/docs"
|
||||
"github.com/nymtech/nym-directory/metrics"
|
||||
"github.com/nymtech/nym-directory/server"
|
||||
"os"
|
||||
)
|
||||
|
||||
// @title Nym Directory API
|
||||
// @version 0.9.0-dev
|
||||
// @description This is a temporarily centralized directory/PKI/metrics API to allow us to get the other Nym node types running. Its functionality will eventually be folded into other parts of Nym.
|
||||
// @title Nym Metrics API
|
||||
// @version 0.9.0
|
||||
// @description This is a temporarily centralized metrics API to allow us to get the other Nym node types running. Its functionality will eventually be folded into other parts of Nym.
|
||||
// @termsOfService http://swagger.io/terms/
|
||||
|
||||
// @license.name Apache 2.0
|
||||
// @license.url https://github.com/nymtech/nym-directory/license
|
||||
// @license.url https://github.com/nymtech/nym-metrics-server/
|
||||
func main() {
|
||||
args := os.Args[1:]
|
||||
if len(args) != 1 {
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ type MixMetric struct {
|
|||
}
|
||||
|
||||
// PersistedMixMetric is a saved MixMetric with a timestamp recording when it
|
||||
// was seen by the directory server. It can be used to build visualizations of
|
||||
// was seen by the metrics server. It can be used to build visualizations of
|
||||
// mixnet traffic.
|
||||
type PersistedMixMetric struct {
|
||||
MixMetric
|
||||
|
|
|
|||
Loading…
Reference in New Issue