Skip to content

Commit 2864f59

Browse files
krustowskikrustowski
committed
update docs
1 parent 3c6a6ed commit 2864f59

File tree

3 files changed

+86
-3
lines changed

3 files changed

+86
-3
lines changed

‎.env.example‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
APP_NAME=swis-api
66
APP_ROOT=/opt/${APP_NAME}
7-
APP_VERSION=5.17.7
7+
APP_VERSION=5.17.8
88

99

1010
#

‎api/swagger.json‎

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"name": "MIT",
1414
"url": "https://github.com/vxn-dev/swis-api/blob/master/LICENSE"
1515
},
16-
"version": "5.17.5"
16+
"version": "5.17.8"
1717
},
1818
"host": "swis-api-run-prod:8050",
1919
"basePath": "/",
@@ -762,6 +762,12 @@
762762
"name": "reason",
763763
"in": "query"
764764
},
765+
{
766+
"type": "number",
767+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
768+
"name": "sla_time",
769+
"in": "query"
770+
},
765771
{
766772
"type": "string",
767773
"description": "ID of the referencing socket(s).\nSocketID []string `json:\"socket_id\"`",
@@ -872,6 +878,12 @@
872878
"name": "reason",
873879
"in": "query"
874880
},
881+
{
882+
"type": "number",
883+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
884+
"name": "sla_time",
885+
"in": "query"
886+
},
875887
{
876888
"type": "string",
877889
"description": "ID of the referencing socket(s).\nSocketID []string `json:\"socket_id\"`",
@@ -1090,6 +1102,12 @@
10901102
"name": "response_time",
10911103
"in": "query"
10921104
},
1105+
{
1106+
"type": "number",
1107+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
1108+
"name": "sla_time",
1109+
"in": "query"
1110+
},
10931111
{
10941112
"type": "string",
10951113
"description": "More verbose name/description of the socket.",
@@ -1184,6 +1202,12 @@
11841202
"name": "reason",
11851203
"in": "query"
11861204
},
1205+
{
1206+
"type": "number",
1207+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
1208+
"name": "sla_time",
1209+
"in": "query"
1210+
},
11871211
{
11881212
"type": "string",
11891213
"description": "ID of the referencing socket(s).\nSocketID []string `json:\"socket_id\"`",
@@ -1289,6 +1313,12 @@
12891313
"name": "reason",
12901314
"in": "query"
12911315
},
1316+
{
1317+
"type": "number",
1318+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
1319+
"name": "sla_time",
1320+
"in": "query"
1321+
},
12921322
{
12931323
"type": "string",
12941324
"description": "ID of the referencing socket(s).\nSocketID []string `json:\"socket_id\"`",
@@ -1726,6 +1756,38 @@
17261756
}
17271757
}
17281758
},
1759+
"/dish/streamer/stats": {
1760+
"get": {
1761+
"description": "get SSE streamer statistics",
1762+
"produces": [
1763+
"application/json"
1764+
],
1765+
"tags": [
1766+
"dish"
1767+
],
1768+
"summary": "Get SSE streamer statistics",
1769+
"responses": {
1770+
"200": {
1771+
"description": "OK",
1772+
"schema": {
1773+
"$ref": "#/definitions/pkg_dish.StreamerStats"
1774+
}
1775+
},
1776+
"404": {
1777+
"description": "Not Found",
1778+
"schema": {
1779+
"$ref": "#/definitions/pkg_dish.StreamerStats"
1780+
}
1781+
},
1782+
"500": {
1783+
"description": "Internal Server Error",
1784+
"schema": {
1785+
"$ref": "#/definitions/pkg_dish.StreamerStats"
1786+
}
1787+
}
1788+
}
1789+
}
1790+
},
17291791
"/finance": {
17301792
"get": {
17311793
"description": "get whole finance package content",
@@ -3987,6 +4049,10 @@
39874049
"timestamp": {
39884050
"description": "UNIX timestamp of the last provided backup.",
39894051
"type": "integer"
4052+
},
4053+
"ttl": {
4054+
"description": "TimeToLive aka the tolerable age of last backup in hours.",
4055+
"type": "number"
39904056
}
39914057
}
39924058
},
@@ -4107,6 +4173,10 @@
41074173
"description": "Reason of the incident that happened.",
41084174
"type": "string"
41094175
},
4176+
"sla_time": {
4177+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
4178+
"type": "number"
4179+
},
41104180
"socket_id": {
41114181
"description": "ID of the referencing socket(s).\nSocketID []string `json:\"socket_id\"`",
41124182
"type": "string"
@@ -4223,6 +4293,10 @@
42234293
"description": "ResponseTime is the time for the request to be processed.",
42244294
"type": "number"
42254295
},
4296+
"sla_time": {
4297+
"description": "SLA time duration in hours since the start of such incident, (0 = disabled).",
4298+
"type": "number"
4299+
},
42264300
"socket_description": {
42274301
"description": "More verbose name/description of the socket.",
42284302
"type": "string"
@@ -4237,6 +4311,15 @@
42374311
}
42384312
}
42394313
},
4314+
"pkg_dish.StreamerStats": {
4315+
"type": "object",
4316+
"properties": {
4317+
"client_count": {
4318+
"description": "Total number of the SSE stream clients/listeners.",
4319+
"type": "integer"
4320+
}
4321+
}
4322+
},
42404323
"pkg_finance.Account": {
42414324
"type": "object",
42424325
"required": [

‎cmd/swis-api/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// @title swis-api (swapi) v5
2-
// @version 5.17.7
2+
// @version 5.17.8
33
// @description sakalWeb Information System v5 RESTful API documentation
44
// @termsOfService http://swagger.io/terms/
55

0 commit comments

Comments
 (0)