Skip to content

Commit

Permalink
swagger docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pschork committed Sep 16, 2024
1 parent 4e15470 commit 1e56ba9
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 2 deletions.
25 changes: 25 additions & 0 deletions disperser/dataapi/docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,31 @@ const docTemplate = `{
}
}
},
"/operators-info/hostinfo-scan": {
"get": {
"produces": [
"application/json"
],
"tags": [
"OperatorsInfo"
],
"summary": "Active operator semver report",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dataapi.OperatorPortCheckResponse"
}
},
"500": {
"description": "error: Server error",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
}
}
}
}
},
"/operators-info/port-check": {
"get": {
"produces": [
Expand Down
25 changes: 25 additions & 0 deletions disperser/dataapi/docs/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,31 @@
}
}
},
"/operators-info/hostinfo-scan": {
"get": {
"produces": [
"application/json"
],
"tags": [
"OperatorsInfo"
],
"summary": "Active operator semver report",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dataapi.OperatorPortCheckResponse"
}
},
"500": {
"description": "error: Server error",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
}
}
}
}
},
"/operators-info/port-check": {
"get": {
"produces": [
Expand Down
16 changes: 16 additions & 0 deletions disperser/dataapi/docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,22 @@ paths:
is a query parameter with a default value of 14 and max value of 30.
tags:
- OperatorsInfo
/operators-info/hostinfo-scan:
get:
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dataapi.OperatorPortCheckResponse'
"500":
description: 'error: Server error'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
summary: Active operator semver report
tags:
- OperatorsInfo
/operators-info/port-check:
get:
parameters:
Expand Down
4 changes: 2 additions & 2 deletions disperser/dataapi/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -813,8 +813,8 @@ func (s *server) OperatorPortCheck(c *gin.Context) {
// @Summary Active operator semver report
// @Tags OperatorsInfo
// @Produce json
// @Success 200 {object} OperatorPortCheckResponse
// @Failure 500 {object} ErrorResponse "error: Server error"
// @Success 200 {object} OperatorPortCheckResponse
// @Failure 500 {object} ErrorResponse "error: Server error"
// @Router /operators-info/hostinfo-scan [get]
func (s *server) SemverReport(c *gin.Context) {
timer := prometheus.NewTimer(prometheus.ObserverFunc(func(f float64) {
Expand Down

0 comments on commit 1e56ba9

Please sign in to comment.