mirror of
https://github.com/yusing/godoxy.git
synced 2026-03-29 05:11:51 +02:00
refactor(api): better type safety, split homepage override apis, fixed favicon api docs
This commit is contained in:
yusing
@@ -582,25 +582,25 @@ const docTemplate = `{
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"description": "Bad Request: alias is empty or route is not HTTPRoute",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden",
|
||||
"description": "Forbidden: unauthorized",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"description": "Not Found: route or icon not found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"description": "Internal Server Error: internal error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -979,9 +979,9 @@ const docTemplate = `{
|
||||
"x-id": "items"
|
||||
}
|
||||
},
|
||||
"/homepage/set": {
|
||||
"/homepage/set/category_order": {
|
||||
"post": {
|
||||
"description": "Set homepage overrides",
|
||||
"description": "Set homepage category order.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
@@ -991,90 +991,15 @@ const docTemplate = `{
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Set homepage overrides",
|
||||
"summary": "Set homepage category order",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Override single item",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Override multiple items",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemsBatchParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Override category order",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideCategoryOrderParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Override item visibility",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemVisibleParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
"$ref": "#/definitions/HomepageOverrideCategoryOrderParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
@@ -1098,7 +1023,148 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set"
|
||||
"x-id": "set-category-order"
|
||||
}
|
||||
},
|
||||
"/homepage/set/item": {
|
||||
"post": {
|
||||
"description": "Override single homepage item.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Override single homepage item",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Override single item",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/SuccessResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set-item"
|
||||
}
|
||||
},
|
||||
"/homepage/set/item_visible": {
|
||||
"post": {
|
||||
"description": "POST list of item ids and visibility value.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Set homepage item visibility",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Set item visibility",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemVisibleParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/SuccessResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set-item-visible"
|
||||
}
|
||||
},
|
||||
"/homepage/set/items_batch": {
|
||||
"post": {
|
||||
"description": "Override multiple homepage items.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Override multiple homepage items",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Override multiple items",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemsBatchParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/SuccessResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set-items-batch"
|
||||
}
|
||||
},
|
||||
"/icons": {
|
||||
@@ -1168,13 +1234,73 @@ const docTemplate = `{
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Agent address",
|
||||
"name": "agent_addr",
|
||||
"name": "agentAddr",
|
||||
"in": "query"
|
||||
},
|
||||
{
|
||||
"enum": [
|
||||
"cpu_average",
|
||||
"memory_usage",
|
||||
"memory_usage_percent",
|
||||
"disks_read_speed",
|
||||
"disks_write_speed",
|
||||
"disks_iops",
|
||||
"disk_usage",
|
||||
"network_speed",
|
||||
"network_transfer",
|
||||
"sensor_temperature"
|
||||
],
|
||||
"type": "string",
|
||||
"description": "Period",
|
||||
"x-enum-comments": {
|
||||
"SystemInfoAggregateModeCPUAverage": "@name SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeDiskUsage": "@name SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeDisksIOPS": "@name SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDisksReadSpeed": "@name SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed": "@name SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeMemoryUsage": "@name SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent": "@name SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeNetworkSpeed": "@name SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer": "@name SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature": "@name SystemInfoAggregateModeSensorTemperature"
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature"
|
||||
],
|
||||
"name": "aggregate",
|
||||
"in": "query"
|
||||
},
|
||||
{
|
||||
"enum": [
|
||||
"5m",
|
||||
"15m",
|
||||
"1h",
|
||||
"1d",
|
||||
"1mo"
|
||||
],
|
||||
"type": "string",
|
||||
"x-enum-comments": {
|
||||
"MetricsPeriod15m": "@name MetricsPeriod15m",
|
||||
"MetricsPeriod1d": "@name MetricsPeriod1d",
|
||||
"MetricsPeriod1h": "@name MetricsPeriod1h",
|
||||
"MetricsPeriod1mo": "@name MetricsPeriod1mo",
|
||||
"MetricsPeriod5m": "@name MetricsPeriod5m"
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"MetricsPeriod5m",
|
||||
"MetricsPeriod15m",
|
||||
"MetricsPeriod1h",
|
||||
"MetricsPeriod1d",
|
||||
"MetricsPeriod1mo"
|
||||
],
|
||||
"name": "period",
|
||||
"in": "query"
|
||||
}
|
||||
@@ -1742,10 +1868,40 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/ContainerState"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContainerState": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"created",
|
||||
"running",
|
||||
"paused",
|
||||
"restarting",
|
||||
"removing",
|
||||
"exited",
|
||||
"dead"
|
||||
],
|
||||
"x-enum-comments": {
|
||||
"StateCreated": "StateCreated indicates the container is created, but not (yet) started.",
|
||||
"StateDead": "StateDead indicates that the container failed to be deleted. Containers in this state are attempted to be cleaned up when the daemon restarts.",
|
||||
"StateExited": "StateExited indicates that the container exited.",
|
||||
"StatePaused": "StatePaused indicates that the container's current state is paused.",
|
||||
"StateRemoving": "StateRemoving indicates that the container is being removed.",
|
||||
"StateRestarting": "StateRestarting indicates that the container is currently restarting.",
|
||||
"StateRunning": "StateRunning indicates that the container is running."
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"StateCreated",
|
||||
"StateRunning",
|
||||
"StatePaused",
|
||||
"StateRestarting",
|
||||
"StateRemoving",
|
||||
"StateExited",
|
||||
"StateDead"
|
||||
]
|
||||
},
|
||||
"ContainerStats": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -2675,6 +2831,45 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"SystemInfoAggregateMode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"cpu_average",
|
||||
"memory_usage",
|
||||
"memory_usage_percent",
|
||||
"disks_read_speed",
|
||||
"disks_write_speed",
|
||||
"disks_iops",
|
||||
"disk_usage",
|
||||
"network_speed",
|
||||
"network_transfer",
|
||||
"sensor_temperature"
|
||||
],
|
||||
"x-enum-comments": {
|
||||
"SystemInfoAggregateModeCPUAverage": "@name SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeDiskUsage": "@name SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeDisksIOPS": "@name SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDisksReadSpeed": "@name SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed": "@name SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeMemoryUsage": "@name SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent": "@name SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeNetworkSpeed": "@name SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer": "@name SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature": "@name SystemInfoAggregateModeSensorTemperature"
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature"
|
||||
]
|
||||
},
|
||||
"UptimeAggregate": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -2884,48 +3079,28 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"homepage.IconExtra": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"file_type": {
|
||||
"type": "string"
|
||||
},
|
||||
"is_dark": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"is_light": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"key": {
|
||||
"type": "string"
|
||||
},
|
||||
"ref": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"homepage.IconMetaSearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"dark": {
|
||||
"Dark": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"light": {
|
||||
"Light": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"png": {
|
||||
"PNG": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"ref": {
|
||||
"Ref": {
|
||||
"type": "string"
|
||||
},
|
||||
"source": {
|
||||
"$ref": "#/definitions/homepage.IconSource"
|
||||
},
|
||||
"svg": {
|
||||
"SVG": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"webP": {
|
||||
"Source": {
|
||||
"$ref": "#/definitions/homepage.IconSource"
|
||||
},
|
||||
"WebP": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
@@ -2945,26 +3120,6 @@ const docTemplate = `{
|
||||
"IconSourceSelfhSt"
|
||||
]
|
||||
},
|
||||
"homepage.IconURL": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"extra": {
|
||||
"description": "only for walkxcode/selfhst icons",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepage.IconExtra"
|
||||
}
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"$ref": "#/definitions/homepage.IconSource"
|
||||
},
|
||||
"value": {
|
||||
"description": "only for absolute/relative icons",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"homepage.Item": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -2978,7 +3133,7 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"icon": {
|
||||
"$ref": "#/definitions/homepage.IconURL"
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "display name",
|
||||
@@ -3000,7 +3155,12 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"widget_config": {
|
||||
"$ref": "#/definitions/widgets.Config"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/widgets.Config"
|
||||
}
|
||||
],
|
||||
"x-nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -3014,7 +3174,7 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"icon": {
|
||||
"$ref": "#/definitions/homepage.IconURL"
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "display name",
|
||||
@@ -3031,25 +3191,6 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"homepageapi.SetHomePageOverridesRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value",
|
||||
"what"
|
||||
],
|
||||
"properties": {
|
||||
"value": {},
|
||||
"what": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"item",
|
||||
"items_batch",
|
||||
"category_order",
|
||||
"item_visible"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"mem.VirtualMemoryStat": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@@ -578,25 +578,25 @@
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"description": "Bad Request: alias is empty or route is not HTTPRoute",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden",
|
||||
"description": "Forbidden: unauthorized",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"description": "Not Found: route or icon not found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"description": "Internal Server Error: internal error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -983,9 +983,9 @@
|
||||
"operationId": "items"
|
||||
}
|
||||
},
|
||||
"/homepage/set": {
|
||||
"/homepage/set/category_order": {
|
||||
"post": {
|
||||
"description": "Set homepage overrides",
|
||||
"description": "Set homepage category order.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
@@ -995,90 +995,15 @@
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Set homepage overrides",
|
||||
"summary": "Set homepage category order",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Override single item",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Override multiple items",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemsBatchParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Override category order",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideCategoryOrderParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Override item visibility",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepageapi.SetHomePageOverridesRequest"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemVisibleParams"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
"$ref": "#/definitions/HomepageOverrideCategoryOrderParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
@@ -1102,8 +1027,152 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set",
|
||||
"operationId": "set"
|
||||
"x-id": "set-category-order",
|
||||
"operationId": "set-category-order"
|
||||
}
|
||||
},
|
||||
"/homepage/set/item": {
|
||||
"post": {
|
||||
"description": "Override single homepage item.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Override single homepage item",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Override single item",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/SuccessResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set-item",
|
||||
"operationId": "set-item"
|
||||
}
|
||||
},
|
||||
"/homepage/set/item_visible": {
|
||||
"post": {
|
||||
"description": "POST list of item ids and visibility value.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Set homepage item visibility",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Set item visibility",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemVisibleParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/SuccessResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set-item-visible",
|
||||
"operationId": "set-item-visible"
|
||||
}
|
||||
},
|
||||
"/homepage/set/items_batch": {
|
||||
"post": {
|
||||
"description": "Override multiple homepage items.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"homepage"
|
||||
],
|
||||
"summary": "Override multiple homepage items",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Override multiple items",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/HomepageOverrideItemsBatchParams"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/SuccessResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "set-items-batch",
|
||||
"operationId": "set-items-batch"
|
||||
}
|
||||
},
|
||||
"/icons": {
|
||||
@@ -1174,13 +1243,73 @@
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Agent address",
|
||||
"name": "agent_addr",
|
||||
"name": "agentAddr",
|
||||
"in": "query"
|
||||
},
|
||||
{
|
||||
"enum": [
|
||||
"cpu_average",
|
||||
"memory_usage",
|
||||
"memory_usage_percent",
|
||||
"disks_read_speed",
|
||||
"disks_write_speed",
|
||||
"disks_iops",
|
||||
"disk_usage",
|
||||
"network_speed",
|
||||
"network_transfer",
|
||||
"sensor_temperature"
|
||||
],
|
||||
"type": "string",
|
||||
"description": "Period",
|
||||
"x-enum-comments": {
|
||||
"SystemInfoAggregateModeCPUAverage": "@name SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeDiskUsage": "@name SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeDisksIOPS": "@name SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDisksReadSpeed": "@name SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed": "@name SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeMemoryUsage": "@name SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent": "@name SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeNetworkSpeed": "@name SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer": "@name SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature": "@name SystemInfoAggregateModeSensorTemperature"
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature"
|
||||
],
|
||||
"name": "aggregate",
|
||||
"in": "query"
|
||||
},
|
||||
{
|
||||
"enum": [
|
||||
"5m",
|
||||
"15m",
|
||||
"1h",
|
||||
"1d",
|
||||
"1mo"
|
||||
],
|
||||
"type": "string",
|
||||
"x-enum-comments": {
|
||||
"MetricsPeriod15m": "@name MetricsPeriod15m",
|
||||
"MetricsPeriod1d": "@name MetricsPeriod1d",
|
||||
"MetricsPeriod1h": "@name MetricsPeriod1h",
|
||||
"MetricsPeriod1mo": "@name MetricsPeriod1mo",
|
||||
"MetricsPeriod5m": "@name MetricsPeriod5m"
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"MetricsPeriod5m",
|
||||
"MetricsPeriod15m",
|
||||
"MetricsPeriod1h",
|
||||
"MetricsPeriod1d",
|
||||
"MetricsPeriod1mo"
|
||||
],
|
||||
"name": "period",
|
||||
"in": "query"
|
||||
}
|
||||
@@ -1839,7 +1968,7 @@
|
||||
"x-omitempty": false
|
||||
},
|
||||
"state": {
|
||||
"type": "string",
|
||||
"$ref": "#/definitions/ContainerState",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
}
|
||||
@@ -1847,6 +1976,38 @@
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"ContainerState": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"created",
|
||||
"running",
|
||||
"paused",
|
||||
"restarting",
|
||||
"removing",
|
||||
"exited",
|
||||
"dead"
|
||||
],
|
||||
"x-enum-comments": {
|
||||
"StateCreated": "StateCreated indicates the container is created, but not (yet) started.",
|
||||
"StateDead": "StateDead indicates that the container failed to be deleted. Containers in this state are attempted to be cleaned up when the daemon restarts.",
|
||||
"StateExited": "StateExited indicates that the container exited.",
|
||||
"StatePaused": "StatePaused indicates that the container's current state is paused.",
|
||||
"StateRemoving": "StateRemoving indicates that the container is being removed.",
|
||||
"StateRestarting": "StateRestarting indicates that the container is currently restarting.",
|
||||
"StateRunning": "StateRunning indicates that the container is running."
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"StateCreated",
|
||||
"StateRunning",
|
||||
"StatePaused",
|
||||
"StateRestarting",
|
||||
"StateRemoving",
|
||||
"StateExited",
|
||||
"StateDead"
|
||||
],
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"ContainerStats": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -3168,6 +3329,47 @@
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"SystemInfoAggregateMode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"cpu_average",
|
||||
"memory_usage",
|
||||
"memory_usage_percent",
|
||||
"disks_read_speed",
|
||||
"disks_write_speed",
|
||||
"disks_iops",
|
||||
"disk_usage",
|
||||
"network_speed",
|
||||
"network_transfer",
|
||||
"sensor_temperature"
|
||||
],
|
||||
"x-enum-comments": {
|
||||
"SystemInfoAggregateModeCPUAverage": "@name SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeDiskUsage": "@name SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeDisksIOPS": "@name SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDisksReadSpeed": "@name SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed": "@name SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeMemoryUsage": "@name SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent": "@name SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeNetworkSpeed": "@name SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer": "@name SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature": "@name SystemInfoAggregateModeSensorTemperature"
|
||||
},
|
||||
"x-enum-varnames": [
|
||||
"SystemInfoAggregateModeCPUAverage",
|
||||
"SystemInfoAggregateModeMemoryUsage",
|
||||
"SystemInfoAggregateModeMemoryUsagePercent",
|
||||
"SystemInfoAggregateModeDisksReadSpeed",
|
||||
"SystemInfoAggregateModeDisksWriteSpeed",
|
||||
"SystemInfoAggregateModeDisksIOPS",
|
||||
"SystemInfoAggregateModeDiskUsage",
|
||||
"SystemInfoAggregateModeNetworkSpeed",
|
||||
"SystemInfoAggregateModeNetworkTransfer",
|
||||
"SystemInfoAggregateModeSensorTemperature"
|
||||
],
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"UptimeAggregate": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -3475,72 +3677,40 @@
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"homepage.IconExtra": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"file_type": {
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"is_dark": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"is_light": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"ref": {
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
}
|
||||
},
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"homepage.IconMetaSearch": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"dark": {
|
||||
"Dark": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"light": {
|
||||
"Light": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"png": {
|
||||
"PNG": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"ref": {
|
||||
"Ref": {
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"source": {
|
||||
"SVG": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"Source": {
|
||||
"$ref": "#/definitions/homepage.IconSource",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"svg": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"webP": {
|
||||
"WebP": {
|
||||
"type": "boolean",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
@@ -3566,34 +3736,6 @@
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"homepage.IconURL": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"extra": {
|
||||
"description": "only for walkxcode/selfhst icons",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/homepage.IconExtra"
|
||||
}
|
||||
],
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"source": {
|
||||
"$ref": "#/definitions/homepage.IconSource",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"value": {
|
||||
"description": "only for absolute/relative icons",
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
}
|
||||
},
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"homepage.Item": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -3613,7 +3755,7 @@
|
||||
"x-omitempty": false
|
||||
},
|
||||
"icon": {
|
||||
"$ref": "#/definitions/homepage.IconURL",
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
@@ -3649,9 +3791,12 @@
|
||||
"x-omitempty": false
|
||||
},
|
||||
"widget_config": {
|
||||
"$ref": "#/definitions/widgets.Config",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/widgets.Config"
|
||||
}
|
||||
],
|
||||
"x-nullable": true
|
||||
}
|
||||
},
|
||||
"x-nullable": false,
|
||||
@@ -3671,7 +3816,7 @@
|
||||
"x-omitempty": false
|
||||
},
|
||||
"icon": {
|
||||
"$ref": "#/definitions/homepage.IconURL",
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
@@ -3700,32 +3845,6 @@
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"homepageapi.SetHomePageOverridesRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value",
|
||||
"what"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"what": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"item",
|
||||
"items_batch",
|
||||
"category_order",
|
||||
"item_visible"
|
||||
],
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
}
|
||||
},
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"mem.VirtualMemoryStat": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@@ -107,8 +107,36 @@ definitions:
|
||||
server:
|
||||
type: string
|
||||
state:
|
||||
type: string
|
||||
$ref: '#/definitions/ContainerState'
|
||||
type: object
|
||||
ContainerState:
|
||||
enum:
|
||||
- created
|
||||
- running
|
||||
- paused
|
||||
- restarting
|
||||
- removing
|
||||
- exited
|
||||
- dead
|
||||
type: string
|
||||
x-enum-comments:
|
||||
StateCreated: StateCreated indicates the container is created, but not (yet)
|
||||
started.
|
||||
StateDead: StateDead indicates that the container failed to be deleted. Containers
|
||||
in this state are attempted to be cleaned up when the daemon restarts.
|
||||
StateExited: StateExited indicates that the container exited.
|
||||
StatePaused: StatePaused indicates that the container's current state is paused.
|
||||
StateRemoving: StateRemoving indicates that the container is being removed.
|
||||
StateRestarting: StateRestarting indicates that the container is currently restarting.
|
||||
StateRunning: StateRunning indicates that the container is running.
|
||||
x-enum-varnames:
|
||||
- StateCreated
|
||||
- StateRunning
|
||||
- StatePaused
|
||||
- StateRestarting
|
||||
- StateRemoving
|
||||
- StateExited
|
||||
- StateDead
|
||||
ContainerStats:
|
||||
properties:
|
||||
paused:
|
||||
@@ -731,6 +759,41 @@ definitions:
|
||||
total:
|
||||
type: integer
|
||||
type: object
|
||||
SystemInfoAggregateMode:
|
||||
enum:
|
||||
- cpu_average
|
||||
- memory_usage
|
||||
- memory_usage_percent
|
||||
- disks_read_speed
|
||||
- disks_write_speed
|
||||
- disks_iops
|
||||
- disk_usage
|
||||
- network_speed
|
||||
- network_transfer
|
||||
- sensor_temperature
|
||||
type: string
|
||||
x-enum-comments:
|
||||
SystemInfoAggregateModeCPUAverage: '@name SystemInfoAggregateModeCPUAverage'
|
||||
SystemInfoAggregateModeDiskUsage: '@name SystemInfoAggregateModeDiskUsage'
|
||||
SystemInfoAggregateModeDisksIOPS: '@name SystemInfoAggregateModeDisksIOPS'
|
||||
SystemInfoAggregateModeDisksReadSpeed: '@name SystemInfoAggregateModeDisksReadSpeed'
|
||||
SystemInfoAggregateModeDisksWriteSpeed: '@name SystemInfoAggregateModeDisksWriteSpeed'
|
||||
SystemInfoAggregateModeMemoryUsage: '@name SystemInfoAggregateModeMemoryUsage'
|
||||
SystemInfoAggregateModeMemoryUsagePercent: '@name SystemInfoAggregateModeMemoryUsagePercent'
|
||||
SystemInfoAggregateModeNetworkSpeed: '@name SystemInfoAggregateModeNetworkSpeed'
|
||||
SystemInfoAggregateModeNetworkTransfer: '@name SystemInfoAggregateModeNetworkTransfer'
|
||||
SystemInfoAggregateModeSensorTemperature: '@name SystemInfoAggregateModeSensorTemperature'
|
||||
x-enum-varnames:
|
||||
- SystemInfoAggregateModeCPUAverage
|
||||
- SystemInfoAggregateModeMemoryUsage
|
||||
- SystemInfoAggregateModeMemoryUsagePercent
|
||||
- SystemInfoAggregateModeDisksReadSpeed
|
||||
- SystemInfoAggregateModeDisksWriteSpeed
|
||||
- SystemInfoAggregateModeDisksIOPS
|
||||
- SystemInfoAggregateModeDiskUsage
|
||||
- SystemInfoAggregateModeNetworkSpeed
|
||||
- SystemInfoAggregateModeNetworkTransfer
|
||||
- SystemInfoAggregateModeSensorTemperature
|
||||
UptimeAggregate:
|
||||
properties:
|
||||
data:
|
||||
@@ -886,34 +949,21 @@ definitions:
|
||||
statusCode:
|
||||
type: integer
|
||||
type: object
|
||||
homepage.IconExtra:
|
||||
properties:
|
||||
file_type:
|
||||
type: string
|
||||
is_dark:
|
||||
type: boolean
|
||||
is_light:
|
||||
type: boolean
|
||||
key:
|
||||
type: string
|
||||
ref:
|
||||
type: string
|
||||
type: object
|
||||
homepage.IconMetaSearch:
|
||||
properties:
|
||||
dark:
|
||||
Dark:
|
||||
type: boolean
|
||||
light:
|
||||
Light:
|
||||
type: boolean
|
||||
png:
|
||||
PNG:
|
||||
type: boolean
|
||||
ref:
|
||||
Ref:
|
||||
type: string
|
||||
source:
|
||||
$ref: '#/definitions/homepage.IconSource'
|
||||
svg:
|
||||
SVG:
|
||||
type: boolean
|
||||
webP:
|
||||
Source:
|
||||
$ref: '#/definitions/homepage.IconSource'
|
||||
WebP:
|
||||
type: boolean
|
||||
type: object
|
||||
homepage.IconSource:
|
||||
@@ -928,18 +978,6 @@ definitions:
|
||||
- IconSourceRelative
|
||||
- IconSourceWalkXCode
|
||||
- IconSourceSelfhSt
|
||||
homepage.IconURL:
|
||||
properties:
|
||||
extra:
|
||||
allOf:
|
||||
- $ref: '#/definitions/homepage.IconExtra'
|
||||
description: only for walkxcode/selfhst icons
|
||||
source:
|
||||
$ref: '#/definitions/homepage.IconSource'
|
||||
value:
|
||||
description: only for absolute/relative icons
|
||||
type: string
|
||||
type: object
|
||||
homepage.Item:
|
||||
properties:
|
||||
alias:
|
||||
@@ -949,7 +987,7 @@ definitions:
|
||||
description:
|
||||
type: string
|
||||
icon:
|
||||
$ref: '#/definitions/homepage.IconURL'
|
||||
type: string
|
||||
name:
|
||||
description: display name
|
||||
type: string
|
||||
@@ -964,7 +1002,9 @@ definitions:
|
||||
url:
|
||||
type: string
|
||||
widget_config:
|
||||
$ref: '#/definitions/widgets.Config'
|
||||
allOf:
|
||||
- $ref: '#/definitions/widgets.Config'
|
||||
x-nullable: true
|
||||
type: object
|
||||
homepage.ItemConfig:
|
||||
properties:
|
||||
@@ -973,7 +1013,7 @@ definitions:
|
||||
description:
|
||||
type: string
|
||||
icon:
|
||||
$ref: '#/definitions/homepage.IconURL'
|
||||
type: string
|
||||
name:
|
||||
description: display name
|
||||
type: string
|
||||
@@ -984,20 +1024,6 @@ definitions:
|
||||
url:
|
||||
type: string
|
||||
type: object
|
||||
homepageapi.SetHomePageOverridesRequest:
|
||||
properties:
|
||||
value: {}
|
||||
what:
|
||||
enum:
|
||||
- item
|
||||
- items_batch
|
||||
- category_order
|
||||
- item_visible
|
||||
type: string
|
||||
required:
|
||||
- value
|
||||
- what
|
||||
type: object
|
||||
mem.VirtualMemoryStat:
|
||||
properties:
|
||||
available:
|
||||
@@ -1602,19 +1628,19 @@ paths:
|
||||
$ref: '#/definitions/homepage.FetchResult'
|
||||
type: array
|
||||
"400":
|
||||
description: Bad Request
|
||||
description: 'Bad Request: alias is empty or route is not HTTPRoute'
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
"403":
|
||||
description: Forbidden
|
||||
description: 'Forbidden: unauthorized'
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
"404":
|
||||
description: Not Found
|
||||
description: 'Not Found: route or icon not found'
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
description: 'Internal Server Error: internal error'
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
summary: Get favicon
|
||||
@@ -1872,56 +1898,18 @@ paths:
|
||||
tags:
|
||||
- homepage
|
||||
x-id: items
|
||||
/homepage/set:
|
||||
/homepage/set/category_order:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Set homepage overrides
|
||||
description: Set homepage category order.
|
||||
parameters:
|
||||
- description: Override single item
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/homepageapi.SetHomePageOverridesRequest'
|
||||
- properties:
|
||||
value:
|
||||
$ref: '#/definitions/HomepageOverrideItemParams'
|
||||
type: object
|
||||
- description: Override multiple items
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/homepageapi.SetHomePageOverridesRequest'
|
||||
- properties:
|
||||
value:
|
||||
$ref: '#/definitions/HomepageOverrideItemsBatchParams'
|
||||
type: object
|
||||
- description: Override category order
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/homepageapi.SetHomePageOverridesRequest'
|
||||
- properties:
|
||||
value:
|
||||
$ref: '#/definitions/HomepageOverrideCategoryOrderParams'
|
||||
type: object
|
||||
- description: Override item visibility
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/homepageapi.SetHomePageOverridesRequest'
|
||||
- properties:
|
||||
value:
|
||||
$ref: '#/definitions/HomepageOverrideItemVisibleParams'
|
||||
type: object
|
||||
$ref: '#/definitions/HomepageOverrideCategoryOrderParams'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -1937,10 +1925,103 @@ paths:
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
summary: Set homepage overrides
|
||||
summary: Set homepage category order
|
||||
tags:
|
||||
- homepage
|
||||
x-id: set
|
||||
x-id: set-category-order
|
||||
/homepage/set/item:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Override single homepage item.
|
||||
parameters:
|
||||
- description: Override single item
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/HomepageOverrideItemParams'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/SuccessResponse'
|
||||
"400":
|
||||
description: Bad Request
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
summary: Override single homepage item
|
||||
tags:
|
||||
- homepage
|
||||
x-id: set-item
|
||||
/homepage/set/item_visible:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: POST list of item ids and visibility value.
|
||||
parameters:
|
||||
- description: Set item visibility
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/HomepageOverrideItemVisibleParams'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/SuccessResponse'
|
||||
"400":
|
||||
description: Bad Request
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
summary: Set homepage item visibility
|
||||
tags:
|
||||
- homepage
|
||||
x-id: set-item-visible
|
||||
/homepage/set/items_batch:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Override multiple homepage items.
|
||||
parameters:
|
||||
- description: Override multiple items
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/HomepageOverrideItemsBatchParams'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/SuccessResponse'
|
||||
"400":
|
||||
description: Bad Request
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/ErrorResponse'
|
||||
summary: Override multiple homepage items
|
||||
tags:
|
||||
- homepage
|
||||
x-id: set-items-batch
|
||||
/icons:
|
||||
get:
|
||||
consumes:
|
||||
@@ -1980,14 +2061,66 @@ paths:
|
||||
get:
|
||||
description: Get system info
|
||||
parameters:
|
||||
- description: Agent address
|
||||
in: query
|
||||
name: agent_addr
|
||||
- in: query
|
||||
name: agentAddr
|
||||
type: string
|
||||
- description: Period
|
||||
- enum:
|
||||
- cpu_average
|
||||
- memory_usage
|
||||
- memory_usage_percent
|
||||
- disks_read_speed
|
||||
- disks_write_speed
|
||||
- disks_iops
|
||||
- disk_usage
|
||||
- network_speed
|
||||
- network_transfer
|
||||
- sensor_temperature
|
||||
in: query
|
||||
name: aggregate
|
||||
type: string
|
||||
x-enum-comments:
|
||||
SystemInfoAggregateModeCPUAverage: '@name SystemInfoAggregateModeCPUAverage'
|
||||
SystemInfoAggregateModeDiskUsage: '@name SystemInfoAggregateModeDiskUsage'
|
||||
SystemInfoAggregateModeDisksIOPS: '@name SystemInfoAggregateModeDisksIOPS'
|
||||
SystemInfoAggregateModeDisksReadSpeed: '@name SystemInfoAggregateModeDisksReadSpeed'
|
||||
SystemInfoAggregateModeDisksWriteSpeed: '@name SystemInfoAggregateModeDisksWriteSpeed'
|
||||
SystemInfoAggregateModeMemoryUsage: '@name SystemInfoAggregateModeMemoryUsage'
|
||||
SystemInfoAggregateModeMemoryUsagePercent: '@name SystemInfoAggregateModeMemoryUsagePercent'
|
||||
SystemInfoAggregateModeNetworkSpeed: '@name SystemInfoAggregateModeNetworkSpeed'
|
||||
SystemInfoAggregateModeNetworkTransfer: '@name SystemInfoAggregateModeNetworkTransfer'
|
||||
SystemInfoAggregateModeSensorTemperature: '@name SystemInfoAggregateModeSensorTemperature'
|
||||
x-enum-varnames:
|
||||
- SystemInfoAggregateModeCPUAverage
|
||||
- SystemInfoAggregateModeMemoryUsage
|
||||
- SystemInfoAggregateModeMemoryUsagePercent
|
||||
- SystemInfoAggregateModeDisksReadSpeed
|
||||
- SystemInfoAggregateModeDisksWriteSpeed
|
||||
- SystemInfoAggregateModeDisksIOPS
|
||||
- SystemInfoAggregateModeDiskUsage
|
||||
- SystemInfoAggregateModeNetworkSpeed
|
||||
- SystemInfoAggregateModeNetworkTransfer
|
||||
- SystemInfoAggregateModeSensorTemperature
|
||||
- enum:
|
||||
- 5m
|
||||
- 15m
|
||||
- 1h
|
||||
- 1d
|
||||
- 1mo
|
||||
in: query
|
||||
name: period
|
||||
type: string
|
||||
x-enum-comments:
|
||||
MetricsPeriod15m: '@name MetricsPeriod15m'
|
||||
MetricsPeriod1d: '@name MetricsPeriod1d'
|
||||
MetricsPeriod1h: '@name MetricsPeriod1h'
|
||||
MetricsPeriod1mo: '@name MetricsPeriod1mo'
|
||||
MetricsPeriod5m: '@name MetricsPeriod5m'
|
||||
x-enum-varnames:
|
||||
- MetricsPeriod5m
|
||||
- MetricsPeriod15m
|
||||
- MetricsPeriod1h
|
||||
- MetricsPeriod1d
|
||||
- MetricsPeriod1mo
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -2031,11 +2164,11 @@ paths:
|
||||
name: interval
|
||||
type: string
|
||||
x-enum-comments:
|
||||
MetricsPeriod15m: '@name MetricsPeriod15m'
|
||||
MetricsPeriod1d: '@name MetricsPeriod1d'
|
||||
MetricsPeriod1h: '@name MetricsPeriod1h'
|
||||
MetricsPeriod1mo: '@name MetricsPeriod1mo'
|
||||
MetricsPeriod5m: '@name MetricsPeriod5m'
|
||||
MetricsPeriod15m: '@name MetricsPeriod15m'
|
||||
MetricsPeriod1d: '@name MetricsPeriod1d'
|
||||
x-enum-varnames:
|
||||
- MetricsPeriod5m
|
||||
- MetricsPeriod15m
|
||||
|
||||
Reference in New Issue
Block a user