diff --git a/api-docs/openapi/v3_0/aggregated.json b/api-docs/openapi/v3_0/aggregated.json index d07c4b85c6..3296993b1f 100644 --- a/api-docs/openapi/v3_0/aggregated.json +++ b/api-docs/openapi/v3_0/aggregated.json @@ -6559,7 +6559,7 @@ } }, "tags": [ - "api.notification.halo.run/v1alpha1/Subscription" + "NotificationV1alpha1Public" ] } }, @@ -15679,6 +15679,31 @@ "AttachmentV1alpha1Uc" ] } + }, + "/system/setup": { + "get": { + "description": "Jump to setup page", + "operationId": "JumpToSetupPage", + "responses": { + "default": { + "content": { + "text/html": { + "schema": { + "type": "string" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "SystemV1alpha1Public" + ] + }, + "post": { + "operationId": "SetNoCacheForSetUpPage", + "responses": {} + } } }, "components": { diff --git a/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json index 84340604dc..0652eb77db 100644 --- a/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json +++ b/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json @@ -4757,10 +4757,10 @@ ] } }, - "/apis/plugin.halo.run/v1alpha1/extensiondefinitions": { + "/apis/notification.halo.run/v1alpha1/notifications": { "get": { - "description": "List ExtensionDefinition", - "operationId": "listExtensionDefinition", + "description": "List Notification", + "operationId": "listNotification", "parameters": [ { "description": "Page number. Default is 0.", @@ -4819,54 +4819,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinitionList" + "$ref": "#/components/schemas/NotificationList" } } }, - "description": "Response extensiondefinitions" + "description": "Response notifications" } }, "tags": [ - "ExtensionDefinitionV1alpha1" + "NotificationV1alpha1" ] }, "post": { - "description": "Create ExtensionDefinition", - "operationId": "createExtensionDefinition", + "description": "Create Notification", + "operationId": "createNotification", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinition" + "$ref": "#/components/schemas/Notification" } } }, - "description": "Fresh extensiondefinition" + "description": "Fresh notification" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinition" + "$ref": "#/components/schemas/Notification" } } }, - "description": "Response extensiondefinitions created just now" + "description": "Response notifications created just now" } }, "tags": [ - "ExtensionDefinitionV1alpha1" + "NotificationV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/extensiondefinitions/{name}": { + "/apis/notification.halo.run/v1alpha1/notifications/{name}": { "delete": { - "description": "Delete ExtensionDefinition", - "operationId": "deleteExtensionDefinition", + "description": "Delete Notification", + "operationId": "deleteNotification", "parameters": [ { - "description": "Name of extensiondefinition", + "description": "Name of notification", "in": "path", "name": "name", "required": true, @@ -4877,19 +4877,19 @@ ], "responses": { "200": { - "description": "Response extensiondefinition deleted just now" + "description": "Response notification deleted just now" } }, "tags": [ - "ExtensionDefinitionV1alpha1" + "NotificationV1alpha1" ] }, "get": { - "description": "Get ExtensionDefinition", - "operationId": "getExtensionDefinition", + "description": "Get Notification", + "operationId": "getNotification", "parameters": [ { - "description": "Name of extensiondefinition", + "description": "Name of notification", "in": "path", "name": "name", "required": true, @@ -4903,23 +4903,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinition" + "$ref": "#/components/schemas/Notification" } } }, - "description": "Response single extensiondefinition" + "description": "Response single notification" } }, "tags": [ - "ExtensionDefinitionV1alpha1" + "NotificationV1alpha1" ] }, "patch": { - "description": "Patch ExtensionDefinition", - "operationId": "patchExtensionDefinition", + "description": "Patch Notification", + "operationId": "patchNotification", "parameters": [ { - "description": "Name of extensiondefinition", + "description": "Name of notification", "in": "path", "name": "name", "required": true, @@ -4942,23 +4942,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinition" + "$ref": "#/components/schemas/Notification" } } }, - "description": "Response extensiondefinition patched just now" + "description": "Response notification patched just now" } }, "tags": [ - "ExtensionDefinitionV1alpha1" + "NotificationV1alpha1" ] }, "put": { - "description": "Update ExtensionDefinition", - "operationId": "updateExtensionDefinition", + "description": "Update Notification", + "operationId": "updateNotification", "parameters": [ { - "description": "Name of extensiondefinition", + "description": "Name of notification", "in": "path", "name": "name", "required": true, @@ -4971,33 +4971,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinition" + "$ref": "#/components/schemas/Notification" } } }, - "description": "Updated extensiondefinition" + "description": "Updated notification" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionDefinition" + "$ref": "#/components/schemas/Notification" } } }, - "description": "Response extensiondefinitions updated just now" + "description": "Response notifications updated just now" } }, "tags": [ - "ExtensionDefinitionV1alpha1" + "NotificationV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/extensionpointdefinitions": { + "/apis/notification.halo.run/v1alpha1/notificationtemplates": { "get": { - "description": "List ExtensionPointDefinition", - "operationId": "listExtensionPointDefinition", + "description": "List NotificationTemplate", + "operationId": "listNotificationTemplate", "parameters": [ { "description": "Page number. Default is 0.", @@ -5056,54 +5056,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinitionList" + "$ref": "#/components/schemas/NotificationTemplateList" } } }, - "description": "Response extensionpointdefinitions" + "description": "Response notificationtemplates" } }, "tags": [ - "ExtensionPointDefinitionV1alpha1" + "NotificationTemplateV1alpha1" ] }, "post": { - "description": "Create ExtensionPointDefinition", - "operationId": "createExtensionPointDefinition", + "description": "Create NotificationTemplate", + "operationId": "createNotificationTemplate", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/NotificationTemplate" } } }, - "description": "Fresh extensionpointdefinition" + "description": "Fresh notificationtemplate" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/NotificationTemplate" } } }, - "description": "Response extensionpointdefinitions created just now" + "description": "Response notificationtemplates created just now" } }, "tags": [ - "ExtensionPointDefinitionV1alpha1" + "NotificationTemplateV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}": { + "/apis/notification.halo.run/v1alpha1/notificationtemplates/{name}": { "delete": { - "description": "Delete ExtensionPointDefinition", - "operationId": "deleteExtensionPointDefinition", + "description": "Delete NotificationTemplate", + "operationId": "deleteNotificationTemplate", "parameters": [ { - "description": "Name of extensionpointdefinition", + "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, @@ -5114,19 +5114,19 @@ ], "responses": { "200": { - "description": "Response extensionpointdefinition deleted just now" + "description": "Response notificationtemplate deleted just now" } }, "tags": [ - "ExtensionPointDefinitionV1alpha1" + "NotificationTemplateV1alpha1" ] }, "get": { - "description": "Get ExtensionPointDefinition", - "operationId": "getExtensionPointDefinition", + "description": "Get NotificationTemplate", + "operationId": "getNotificationTemplate", "parameters": [ { - "description": "Name of extensionpointdefinition", + "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, @@ -5140,23 +5140,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/NotificationTemplate" } } }, - "description": "Response single extensionpointdefinition" + "description": "Response single notificationtemplate" } }, "tags": [ - "ExtensionPointDefinitionV1alpha1" + "NotificationTemplateV1alpha1" ] }, "patch": { - "description": "Patch ExtensionPointDefinition", - "operationId": "patchExtensionPointDefinition", + "description": "Patch NotificationTemplate", + "operationId": "patchNotificationTemplate", "parameters": [ { - "description": "Name of extensionpointdefinition", + "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, @@ -5179,23 +5179,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/NotificationTemplate" } } }, - "description": "Response extensionpointdefinition patched just now" + "description": "Response notificationtemplate patched just now" } }, "tags": [ - "ExtensionPointDefinitionV1alpha1" + "NotificationTemplateV1alpha1" ] }, "put": { - "description": "Update ExtensionPointDefinition", - "operationId": "updateExtensionPointDefinition", + "description": "Update NotificationTemplate", + "operationId": "updateNotificationTemplate", "parameters": [ { - "description": "Name of extensionpointdefinition", + "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, @@ -5208,33 +5208,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/NotificationTemplate" } } }, - "description": "Updated extensionpointdefinition" + "description": "Updated notificationtemplate" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/NotificationTemplate" } } }, - "description": "Response extensionpointdefinitions updated just now" + "description": "Response notificationtemplates updated just now" } }, "tags": [ - "ExtensionPointDefinitionV1alpha1" + "NotificationTemplateV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/plugins": { + "/apis/notification.halo.run/v1alpha1/notifierDescriptors": { "get": { - "description": "List Plugin", - "operationId": "listPlugin", + "description": "List NotifierDescriptor", + "operationId": "listNotifierDescriptor", "parameters": [ { "description": "Page number. Default is 0.", @@ -5293,54 +5293,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PluginList" + "$ref": "#/components/schemas/NotifierDescriptorList" } } }, - "description": "Response plugins" + "description": "Response notifierDescriptors" } }, "tags": [ - "PluginV1alpha1" + "NotifierDescriptorV1alpha1" ] }, "post": { - "description": "Create Plugin", - "operationId": "createPlugin", + "description": "Create NotifierDescriptor", + "operationId": "createNotifierDescriptor", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/NotifierDescriptor" } } }, - "description": "Fresh plugin" + "description": "Fresh notifierDescriptor" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/NotifierDescriptor" } } }, - "description": "Response plugins created just now" + "description": "Response notifierDescriptors created just now" } }, "tags": [ - "PluginV1alpha1" + "NotifierDescriptorV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/plugins/{name}": { + "/apis/notification.halo.run/v1alpha1/notifierDescriptors/{name}": { "delete": { - "description": "Delete Plugin", - "operationId": "deletePlugin", + "description": "Delete NotifierDescriptor", + "operationId": "deleteNotifierDescriptor", "parameters": [ { - "description": "Name of plugin", + "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, @@ -5351,19 +5351,19 @@ ], "responses": { "200": { - "description": "Response plugin deleted just now" + "description": "Response notifierDescriptor deleted just now" } }, "tags": [ - "PluginV1alpha1" + "NotifierDescriptorV1alpha1" ] }, "get": { - "description": "Get Plugin", - "operationId": "getPlugin", + "description": "Get NotifierDescriptor", + "operationId": "getNotifierDescriptor", "parameters": [ { - "description": "Name of plugin", + "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, @@ -5377,23 +5377,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/NotifierDescriptor" } } }, - "description": "Response single plugin" + "description": "Response single notifierDescriptor" } }, "tags": [ - "PluginV1alpha1" + "NotifierDescriptorV1alpha1" ] }, "patch": { - "description": "Patch Plugin", - "operationId": "patchPlugin", + "description": "Patch NotifierDescriptor", + "operationId": "patchNotifierDescriptor", "parameters": [ { - "description": "Name of plugin", + "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, @@ -5416,23 +5416,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/NotifierDescriptor" } } }, - "description": "Response plugin patched just now" + "description": "Response notifierDescriptor patched just now" } }, "tags": [ - "PluginV1alpha1" + "NotifierDescriptorV1alpha1" ] }, "put": { - "description": "Update Plugin", - "operationId": "updatePlugin", + "description": "Update NotifierDescriptor", + "operationId": "updateNotifierDescriptor", "parameters": [ { - "description": "Name of plugin", + "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, @@ -5445,33 +5445,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/NotifierDescriptor" } } }, - "description": "Updated plugin" + "description": "Updated notifierDescriptor" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/NotifierDescriptor" } } }, - "description": "Response plugins updated just now" + "description": "Response notifierDescriptors updated just now" } }, "tags": [ - "PluginV1alpha1" + "NotifierDescriptorV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/reverseproxies": { + "/apis/notification.halo.run/v1alpha1/reasons": { "get": { - "description": "List ReverseProxy", - "operationId": "listReverseProxy", + "description": "List Reason", + "operationId": "listReason", "parameters": [ { "description": "Page number. Default is 0.", @@ -5530,54 +5530,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxyList" + "$ref": "#/components/schemas/ReasonList" } } }, - "description": "Response reverseproxies" + "description": "Response reasons" } }, "tags": [ - "ReverseProxyV1alpha1" + "ReasonV1alpha1" ] }, "post": { - "description": "Create ReverseProxy", - "operationId": "createReverseProxy", + "description": "Create Reason", + "operationId": "createReason", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxy" + "$ref": "#/components/schemas/Reason" } } }, - "description": "Fresh reverseproxy" + "description": "Fresh reason" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxy" + "$ref": "#/components/schemas/Reason" } } }, - "description": "Response reverseproxies created just now" + "description": "Response reasons created just now" } }, "tags": [ - "ReverseProxyV1alpha1" + "ReasonV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/reverseproxies/{name}": { + "/apis/notification.halo.run/v1alpha1/reasons/{name}": { "delete": { - "description": "Delete ReverseProxy", - "operationId": "deleteReverseProxy", + "description": "Delete Reason", + "operationId": "deleteReason", "parameters": [ { - "description": "Name of reverseproxy", + "description": "Name of reason", "in": "path", "name": "name", "required": true, @@ -5588,19 +5588,19 @@ ], "responses": { "200": { - "description": "Response reverseproxy deleted just now" + "description": "Response reason deleted just now" } }, "tags": [ - "ReverseProxyV1alpha1" + "ReasonV1alpha1" ] }, "get": { - "description": "Get ReverseProxy", - "operationId": "getReverseProxy", + "description": "Get Reason", + "operationId": "getReason", "parameters": [ { - "description": "Name of reverseproxy", + "description": "Name of reason", "in": "path", "name": "name", "required": true, @@ -5614,23 +5614,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxy" + "$ref": "#/components/schemas/Reason" } } }, - "description": "Response single reverseproxy" + "description": "Response single reason" } }, "tags": [ - "ReverseProxyV1alpha1" + "ReasonV1alpha1" ] }, "patch": { - "description": "Patch ReverseProxy", - "operationId": "patchReverseProxy", + "description": "Patch Reason", + "operationId": "patchReason", "parameters": [ { - "description": "Name of reverseproxy", + "description": "Name of reason", "in": "path", "name": "name", "required": true, @@ -5653,23 +5653,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxy" + "$ref": "#/components/schemas/Reason" } } }, - "description": "Response reverseproxy patched just now" + "description": "Response reason patched just now" } }, "tags": [ - "ReverseProxyV1alpha1" + "ReasonV1alpha1" ] }, "put": { - "description": "Update ReverseProxy", - "operationId": "updateReverseProxy", + "description": "Update Reason", + "operationId": "updateReason", "parameters": [ { - "description": "Name of reverseproxy", + "description": "Name of reason", "in": "path", "name": "name", "required": true, @@ -5682,33 +5682,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxy" + "$ref": "#/components/schemas/Reason" } } }, - "description": "Updated reverseproxy" + "description": "Updated reason" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ReverseProxy" + "$ref": "#/components/schemas/Reason" } } }, - "description": "Response reverseproxies updated just now" + "description": "Response reasons updated just now" } }, "tags": [ - "ReverseProxyV1alpha1" + "ReasonV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/searchengines": { + "/apis/notification.halo.run/v1alpha1/reasontypes": { "get": { - "description": "List SearchEngine", - "operationId": "listSearchEngine", + "description": "List ReasonType", + "operationId": "listReasonType", "parameters": [ { "description": "Page number. Default is 0.", @@ -5767,54 +5767,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngineList" + "$ref": "#/components/schemas/ReasonTypeList" } } }, - "description": "Response searchengines" + "description": "Response reasontypes" } }, "tags": [ - "SearchEngineV1alpha1" + "ReasonTypeV1alpha1" ] }, "post": { - "description": "Create SearchEngine", - "operationId": "createSearchEngine", + "description": "Create ReasonType", + "operationId": "createReasonType", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngine" + "$ref": "#/components/schemas/ReasonType" } } }, - "description": "Fresh searchengine" + "description": "Fresh reasontype" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngine" + "$ref": "#/components/schemas/ReasonType" } } }, - "description": "Response searchengines created just now" + "description": "Response reasontypes created just now" } }, "tags": [ - "SearchEngineV1alpha1" + "ReasonTypeV1alpha1" ] } }, - "/apis/plugin.halo.run/v1alpha1/searchengines/{name}": { + "/apis/notification.halo.run/v1alpha1/reasontypes/{name}": { "delete": { - "description": "Delete SearchEngine", - "operationId": "deleteSearchEngine", + "description": "Delete ReasonType", + "operationId": "deleteReasonType", "parameters": [ { - "description": "Name of searchengine", + "description": "Name of reasontype", "in": "path", "name": "name", "required": true, @@ -5825,19 +5825,19 @@ ], "responses": { "200": { - "description": "Response searchengine deleted just now" + "description": "Response reasontype deleted just now" } }, "tags": [ - "SearchEngineV1alpha1" + "ReasonTypeV1alpha1" ] }, "get": { - "description": "Get SearchEngine", - "operationId": "getSearchEngine", + "description": "Get ReasonType", + "operationId": "getReasonType", "parameters": [ { - "description": "Name of searchengine", + "description": "Name of reasontype", "in": "path", "name": "name", "required": true, @@ -5851,23 +5851,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngine" + "$ref": "#/components/schemas/ReasonType" } } }, - "description": "Response single searchengine" + "description": "Response single reasontype" } }, "tags": [ - "SearchEngineV1alpha1" + "ReasonTypeV1alpha1" ] }, "patch": { - "description": "Patch SearchEngine", - "operationId": "patchSearchEngine", + "description": "Patch ReasonType", + "operationId": "patchReasonType", "parameters": [ { - "description": "Name of searchengine", + "description": "Name of reasontype", "in": "path", "name": "name", "required": true, @@ -5890,23 +5890,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngine" + "$ref": "#/components/schemas/ReasonType" } } }, - "description": "Response searchengine patched just now" + "description": "Response reasontype patched just now" } }, "tags": [ - "SearchEngineV1alpha1" + "ReasonTypeV1alpha1" ] }, "put": { - "description": "Update SearchEngine", - "operationId": "updateSearchEngine", + "description": "Update ReasonType", + "operationId": "updateReasonType", "parameters": [ { - "description": "Name of searchengine", + "description": "Name of reasontype", "in": "path", "name": "name", "required": true, @@ -5919,33 +5919,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngine" + "$ref": "#/components/schemas/ReasonType" } } }, - "description": "Updated searchengine" + "description": "Updated reasontype" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchEngine" + "$ref": "#/components/schemas/ReasonType" } } }, - "description": "Response searchengines updated just now" + "description": "Response reasontypes updated just now" } }, "tags": [ - "SearchEngineV1alpha1" + "ReasonTypeV1alpha1" ] } }, - "/apis/security.halo.run/v1alpha1/devices": { + "/apis/notification.halo.run/v1alpha1/subscriptions": { "get": { - "description": "List Device", - "operationId": "listDevice", + "description": "List Subscription", + "operationId": "listSubscription", "parameters": [ { "description": "Page number. Default is 0.", @@ -6004,54 +6004,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/DeviceList" + "$ref": "#/components/schemas/SubscriptionList" } } }, - "description": "Response devices" + "description": "Response subscriptions" } }, "tags": [ - "DeviceV1alpha1" + "SubscriptionV1alpha1" ] }, "post": { - "description": "Create Device", - "operationId": "createDevice", + "description": "Create Subscription", + "operationId": "createSubscription", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } } }, - "description": "Fresh device" + "description": "Fresh subscription" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } } }, - "description": "Response devices created just now" + "description": "Response subscriptions created just now" } }, "tags": [ - "DeviceV1alpha1" + "SubscriptionV1alpha1" ] } }, - "/apis/security.halo.run/v1alpha1/devices/{name}": { + "/apis/notification.halo.run/v1alpha1/subscriptions/{name}": { "delete": { - "description": "Delete Device", - "operationId": "deleteDevice", + "description": "Delete Subscription", + "operationId": "deleteSubscription", "parameters": [ { - "description": "Name of device", + "description": "Name of subscription", "in": "path", "name": "name", "required": true, @@ -6062,19 +6062,19 @@ ], "responses": { "200": { - "description": "Response device deleted just now" + "description": "Response subscription deleted just now" } }, "tags": [ - "DeviceV1alpha1" + "SubscriptionV1alpha1" ] }, "get": { - "description": "Get Device", - "operationId": "getDevice", + "description": "Get Subscription", + "operationId": "getSubscription", "parameters": [ { - "description": "Name of device", + "description": "Name of subscription", "in": "path", "name": "name", "required": true, @@ -6088,23 +6088,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } } }, - "description": "Response single device" + "description": "Response single subscription" } }, "tags": [ - "DeviceV1alpha1" + "SubscriptionV1alpha1" ] }, "patch": { - "description": "Patch Device", - "operationId": "patchDevice", + "description": "Patch Subscription", + "operationId": "patchSubscription", "parameters": [ { - "description": "Name of device", + "description": "Name of subscription", "in": "path", "name": "name", "required": true, @@ -6127,23 +6127,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } } }, - "description": "Response device patched just now" + "description": "Response subscription patched just now" } }, "tags": [ - "DeviceV1alpha1" + "SubscriptionV1alpha1" ] }, "put": { - "description": "Update Device", - "operationId": "updateDevice", + "description": "Update Subscription", + "operationId": "updateSubscription", "parameters": [ { - "description": "Name of device", + "description": "Name of subscription", "in": "path", "name": "name", "required": true, @@ -6156,33 +6156,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } } }, - "description": "Updated device" + "description": "Updated subscription" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } } }, - "description": "Response devices updated just now" + "description": "Response subscriptions updated just now" } }, "tags": [ - "DeviceV1alpha1" + "SubscriptionV1alpha1" ] } }, - "/apis/security.halo.run/v1alpha1/personalaccesstokens": { + "/apis/plugin.halo.run/v1alpha1/extensiondefinitions": { "get": { - "description": "List PersonalAccessToken", - "operationId": "listPersonalAccessToken", + "description": "List ExtensionDefinition", + "operationId": "listExtensionDefinition", "parameters": [ { "description": "Page number. Default is 0.", @@ -6241,54 +6241,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessTokenList" + "$ref": "#/components/schemas/ExtensionDefinitionList" } } }, - "description": "Response personalaccesstokens" + "description": "Response extensiondefinitions" } }, "tags": [ - "PersonalAccessTokenV1alpha1" + "ExtensionDefinitionV1alpha1" ] }, "post": { - "description": "Create PersonalAccessToken", - "operationId": "createPersonalAccessToken", + "description": "Create ExtensionDefinition", + "operationId": "createExtensionDefinition", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessToken" + "$ref": "#/components/schemas/ExtensionDefinition" } } }, - "description": "Fresh personalaccesstoken" + "description": "Fresh extensiondefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessToken" + "$ref": "#/components/schemas/ExtensionDefinition" } } }, - "description": "Response personalaccesstokens created just now" + "description": "Response extensiondefinitions created just now" } }, "tags": [ - "PersonalAccessTokenV1alpha1" + "ExtensionDefinitionV1alpha1" ] } }, - "/apis/security.halo.run/v1alpha1/personalaccesstokens/{name}": { + "/apis/plugin.halo.run/v1alpha1/extensiondefinitions/{name}": { "delete": { - "description": "Delete PersonalAccessToken", - "operationId": "deletePersonalAccessToken", + "description": "Delete ExtensionDefinition", + "operationId": "deleteExtensionDefinition", "parameters": [ { - "description": "Name of personalaccesstoken", + "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, @@ -6299,19 +6299,19 @@ ], "responses": { "200": { - "description": "Response personalaccesstoken deleted just now" + "description": "Response extensiondefinition deleted just now" } }, "tags": [ - "PersonalAccessTokenV1alpha1" + "ExtensionDefinitionV1alpha1" ] }, "get": { - "description": "Get PersonalAccessToken", - "operationId": "getPersonalAccessToken", + "description": "Get ExtensionDefinition", + "operationId": "getExtensionDefinition", "parameters": [ { - "description": "Name of personalaccesstoken", + "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, @@ -6325,23 +6325,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessToken" + "$ref": "#/components/schemas/ExtensionDefinition" } } }, - "description": "Response single personalaccesstoken" + "description": "Response single extensiondefinition" } }, "tags": [ - "PersonalAccessTokenV1alpha1" + "ExtensionDefinitionV1alpha1" ] }, "patch": { - "description": "Patch PersonalAccessToken", - "operationId": "patchPersonalAccessToken", + "description": "Patch ExtensionDefinition", + "operationId": "patchExtensionDefinition", "parameters": [ { - "description": "Name of personalaccesstoken", + "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, @@ -6364,23 +6364,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessToken" + "$ref": "#/components/schemas/ExtensionDefinition" } } }, - "description": "Response personalaccesstoken patched just now" + "description": "Response extensiondefinition patched just now" } }, "tags": [ - "PersonalAccessTokenV1alpha1" + "ExtensionDefinitionV1alpha1" ] }, "put": { - "description": "Update PersonalAccessToken", - "operationId": "updatePersonalAccessToken", + "description": "Update ExtensionDefinition", + "operationId": "updateExtensionDefinition", "parameters": [ { - "description": "Name of personalaccesstoken", + "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, @@ -6393,33 +6393,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessToken" + "$ref": "#/components/schemas/ExtensionDefinition" } } }, - "description": "Updated personalaccesstoken" + "description": "Updated extensiondefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PersonalAccessToken" + "$ref": "#/components/schemas/ExtensionDefinition" } } }, - "description": "Response personalaccesstokens updated just now" + "description": "Response extensiondefinitions updated just now" } }, "tags": [ - "PersonalAccessTokenV1alpha1" + "ExtensionDefinitionV1alpha1" ] } }, - "/apis/security.halo.run/v1alpha1/remembermetokens": { + "/apis/plugin.halo.run/v1alpha1/extensionpointdefinitions": { "get": { - "description": "List RememberMeToken", - "operationId": "listRememberMeToken", + "description": "List ExtensionPointDefinition", + "operationId": "listExtensionPointDefinition", "parameters": [ { "description": "Page number. Default is 0.", @@ -6478,54 +6478,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeTokenList" + "$ref": "#/components/schemas/ExtensionPointDefinitionList" } } }, - "description": "Response remembermetokens" + "description": "Response extensionpointdefinitions" } }, "tags": [ - "RememberMeTokenV1alpha1" + "ExtensionPointDefinitionV1alpha1" ] }, "post": { - "description": "Create RememberMeToken", - "operationId": "createRememberMeToken", + "description": "Create ExtensionPointDefinition", + "operationId": "createExtensionPointDefinition", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeToken" + "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, - "description": "Fresh remembermetoken" + "description": "Fresh extensionpointdefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeToken" + "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, - "description": "Response remembermetokens created just now" + "description": "Response extensionpointdefinitions created just now" } }, "tags": [ - "RememberMeTokenV1alpha1" + "ExtensionPointDefinitionV1alpha1" ] } }, - "/apis/security.halo.run/v1alpha1/remembermetokens/{name}": { + "/apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}": { "delete": { - "description": "Delete RememberMeToken", - "operationId": "deleteRememberMeToken", + "description": "Delete ExtensionPointDefinition", + "operationId": "deleteExtensionPointDefinition", "parameters": [ { - "description": "Name of remembermetoken", + "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, @@ -6536,19 +6536,19 @@ ], "responses": { "200": { - "description": "Response remembermetoken deleted just now" + "description": "Response extensionpointdefinition deleted just now" } }, "tags": [ - "RememberMeTokenV1alpha1" + "ExtensionPointDefinitionV1alpha1" ] }, "get": { - "description": "Get RememberMeToken", - "operationId": "getRememberMeToken", + "description": "Get ExtensionPointDefinition", + "operationId": "getExtensionPointDefinition", "parameters": [ { - "description": "Name of remembermetoken", + "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, @@ -6562,23 +6562,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeToken" + "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, - "description": "Response single remembermetoken" + "description": "Response single extensionpointdefinition" } }, "tags": [ - "RememberMeTokenV1alpha1" + "ExtensionPointDefinitionV1alpha1" ] }, "patch": { - "description": "Patch RememberMeToken", - "operationId": "patchRememberMeToken", + "description": "Patch ExtensionPointDefinition", + "operationId": "patchExtensionPointDefinition", "parameters": [ { - "description": "Name of remembermetoken", + "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, @@ -6601,23 +6601,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeToken" + "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, - "description": "Response remembermetoken patched just now" + "description": "Response extensionpointdefinition patched just now" } }, "tags": [ - "RememberMeTokenV1alpha1" + "ExtensionPointDefinitionV1alpha1" ] }, "put": { - "description": "Update RememberMeToken", - "operationId": "updateRememberMeToken", + "description": "Update ExtensionPointDefinition", + "operationId": "updateExtensionPointDefinition", "parameters": [ { - "description": "Name of remembermetoken", + "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, @@ -6630,33 +6630,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeToken" + "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, - "description": "Updated remembermetoken" + "description": "Updated extensionpointdefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/RememberMeToken" + "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, - "description": "Response remembermetokens updated just now" + "description": "Response extensionpointdefinitions updated just now" } }, "tags": [ - "RememberMeTokenV1alpha1" + "ExtensionPointDefinitionV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/attachments": { + "/apis/plugin.halo.run/v1alpha1/plugins": { "get": { - "description": "List Attachment", - "operationId": "listAttachment", + "description": "List Plugin", + "operationId": "listPlugin", "parameters": [ { "description": "Page number. Default is 0.", @@ -6715,54 +6715,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/AttachmentList" + "$ref": "#/components/schemas/PluginList" } } }, - "description": "Response attachments" + "description": "Response plugins" } }, "tags": [ - "AttachmentV1alpha1" + "PluginV1alpha1" ] }, "post": { - "description": "Create Attachment", - "operationId": "createAttachment", + "description": "Create Plugin", + "operationId": "createPlugin", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Plugin" } } }, - "description": "Fresh attachment" + "description": "Fresh plugin" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Plugin" } } }, - "description": "Response attachments created just now" + "description": "Response plugins created just now" } }, "tags": [ - "AttachmentV1alpha1" + "PluginV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/attachments/{name}": { + "/apis/plugin.halo.run/v1alpha1/plugins/{name}": { "delete": { - "description": "Delete Attachment", - "operationId": "deleteAttachment", + "description": "Delete Plugin", + "operationId": "deletePlugin", "parameters": [ { - "description": "Name of attachment", + "description": "Name of plugin", "in": "path", "name": "name", "required": true, @@ -6773,19 +6773,19 @@ ], "responses": { "200": { - "description": "Response attachment deleted just now" + "description": "Response plugin deleted just now" } }, "tags": [ - "AttachmentV1alpha1" + "PluginV1alpha1" ] }, "get": { - "description": "Get Attachment", - "operationId": "getAttachment", + "description": "Get Plugin", + "operationId": "getPlugin", "parameters": [ { - "description": "Name of attachment", + "description": "Name of plugin", "in": "path", "name": "name", "required": true, @@ -6799,23 +6799,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Plugin" } } }, - "description": "Response single attachment" + "description": "Response single plugin" } }, "tags": [ - "AttachmentV1alpha1" + "PluginV1alpha1" ] }, "patch": { - "description": "Patch Attachment", - "operationId": "patchAttachment", + "description": "Patch Plugin", + "operationId": "patchPlugin", "parameters": [ { - "description": "Name of attachment", + "description": "Name of plugin", "in": "path", "name": "name", "required": true, @@ -6838,23 +6838,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Plugin" } } }, - "description": "Response attachment patched just now" + "description": "Response plugin patched just now" } }, "tags": [ - "AttachmentV1alpha1" + "PluginV1alpha1" ] }, "put": { - "description": "Update Attachment", - "operationId": "updateAttachment", + "description": "Update Plugin", + "operationId": "updatePlugin", "parameters": [ { - "description": "Name of attachment", + "description": "Name of plugin", "in": "path", "name": "name", "required": true, @@ -6867,33 +6867,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Plugin" } } }, - "description": "Updated attachment" + "description": "Updated plugin" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Plugin" } } }, - "description": "Response attachments updated just now" + "description": "Response plugins updated just now" } }, "tags": [ - "AttachmentV1alpha1" + "PluginV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/groups": { + "/apis/plugin.halo.run/v1alpha1/reverseproxies": { "get": { - "description": "List Group", - "operationId": "listGroup", + "description": "List ReverseProxy", + "operationId": "listReverseProxy", "parameters": [ { "description": "Page number. Default is 0.", @@ -6952,54 +6952,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/GroupList" + "$ref": "#/components/schemas/ReverseProxyList" } } }, - "description": "Response groups" + "description": "Response reverseproxies" } }, "tags": [ - "GroupV1alpha1" + "ReverseProxyV1alpha1" ] }, "post": { - "description": "Create Group", - "operationId": "createGroup", + "description": "Create ReverseProxy", + "operationId": "createReverseProxy", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/ReverseProxy" } } }, - "description": "Fresh group" + "description": "Fresh reverseproxy" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/ReverseProxy" } } }, - "description": "Response groups created just now" + "description": "Response reverseproxies created just now" } }, "tags": [ - "GroupV1alpha1" + "ReverseProxyV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/groups/{name}": { + "/apis/plugin.halo.run/v1alpha1/reverseproxies/{name}": { "delete": { - "description": "Delete Group", - "operationId": "deleteGroup", + "description": "Delete ReverseProxy", + "operationId": "deleteReverseProxy", "parameters": [ { - "description": "Name of group", + "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, @@ -7010,19 +7010,19 @@ ], "responses": { "200": { - "description": "Response group deleted just now" + "description": "Response reverseproxy deleted just now" } }, "tags": [ - "GroupV1alpha1" + "ReverseProxyV1alpha1" ] }, "get": { - "description": "Get Group", - "operationId": "getGroup", + "description": "Get ReverseProxy", + "operationId": "getReverseProxy", "parameters": [ { - "description": "Name of group", + "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, @@ -7036,23 +7036,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/ReverseProxy" } } }, - "description": "Response single group" + "description": "Response single reverseproxy" } }, "tags": [ - "GroupV1alpha1" + "ReverseProxyV1alpha1" ] }, "patch": { - "description": "Patch Group", - "operationId": "patchGroup", + "description": "Patch ReverseProxy", + "operationId": "patchReverseProxy", "parameters": [ { - "description": "Name of group", + "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, @@ -7075,23 +7075,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/ReverseProxy" } } }, - "description": "Response group patched just now" + "description": "Response reverseproxy patched just now" } }, "tags": [ - "GroupV1alpha1" + "ReverseProxyV1alpha1" ] }, "put": { - "description": "Update Group", - "operationId": "updateGroup", + "description": "Update ReverseProxy", + "operationId": "updateReverseProxy", "parameters": [ { - "description": "Name of group", + "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, @@ -7104,33 +7104,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/ReverseProxy" } } }, - "description": "Updated group" + "description": "Updated reverseproxy" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/ReverseProxy" } } }, - "description": "Response groups updated just now" + "description": "Response reverseproxies updated just now" } }, "tags": [ - "GroupV1alpha1" + "ReverseProxyV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/localthumbnails": { + "/apis/plugin.halo.run/v1alpha1/searchengines": { "get": { - "description": "List LocalThumbnail", - "operationId": "listLocalThumbnail", + "description": "List SearchEngine", + "operationId": "listSearchEngine", "parameters": [ { "description": "Page number. Default is 0.", @@ -7189,54 +7189,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnailList" + "$ref": "#/components/schemas/SearchEngineList" } } }, - "description": "Response localthumbnails" + "description": "Response searchengines" } }, "tags": [ - "LocalThumbnailV1alpha1" + "SearchEngineV1alpha1" ] }, "post": { - "description": "Create LocalThumbnail", - "operationId": "createLocalThumbnail", + "description": "Create SearchEngine", + "operationId": "createSearchEngine", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/SearchEngine" } } }, - "description": "Fresh localthumbnail" + "description": "Fresh searchengine" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/SearchEngine" } } }, - "description": "Response localthumbnails created just now" + "description": "Response searchengines created just now" } }, "tags": [ - "LocalThumbnailV1alpha1" + "SearchEngineV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/localthumbnails/{name}": { + "/apis/plugin.halo.run/v1alpha1/searchengines/{name}": { "delete": { - "description": "Delete LocalThumbnail", - "operationId": "deleteLocalThumbnail", + "description": "Delete SearchEngine", + "operationId": "deleteSearchEngine", "parameters": [ { - "description": "Name of localthumbnail", + "description": "Name of searchengine", "in": "path", "name": "name", "required": true, @@ -7247,19 +7247,19 @@ ], "responses": { "200": { - "description": "Response localthumbnail deleted just now" + "description": "Response searchengine deleted just now" } }, "tags": [ - "LocalThumbnailV1alpha1" + "SearchEngineV1alpha1" ] }, "get": { - "description": "Get LocalThumbnail", - "operationId": "getLocalThumbnail", + "description": "Get SearchEngine", + "operationId": "getSearchEngine", "parameters": [ { - "description": "Name of localthumbnail", + "description": "Name of searchengine", "in": "path", "name": "name", "required": true, @@ -7273,23 +7273,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/SearchEngine" } } }, - "description": "Response single localthumbnail" + "description": "Response single searchengine" } }, "tags": [ - "LocalThumbnailV1alpha1" + "SearchEngineV1alpha1" ] }, "patch": { - "description": "Patch LocalThumbnail", - "operationId": "patchLocalThumbnail", + "description": "Patch SearchEngine", + "operationId": "patchSearchEngine", "parameters": [ { - "description": "Name of localthumbnail", + "description": "Name of searchengine", "in": "path", "name": "name", "required": true, @@ -7312,23 +7312,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/SearchEngine" } } }, - "description": "Response localthumbnail patched just now" + "description": "Response searchengine patched just now" } }, "tags": [ - "LocalThumbnailV1alpha1" + "SearchEngineV1alpha1" ] }, "put": { - "description": "Update LocalThumbnail", - "operationId": "updateLocalThumbnail", + "description": "Update SearchEngine", + "operationId": "updateSearchEngine", "parameters": [ { - "description": "Name of localthumbnail", + "description": "Name of searchengine", "in": "path", "name": "name", "required": true, @@ -7341,33 +7341,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/SearchEngine" } } }, - "description": "Updated localthumbnail" + "description": "Updated searchengine" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/SearchEngine" } } }, - "description": "Response localthumbnails updated just now" + "description": "Response searchengines updated just now" } }, "tags": [ - "LocalThumbnailV1alpha1" + "SearchEngineV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/policies": { + "/apis/security.halo.run/v1alpha1/devices": { "get": { - "description": "List Policy", - "operationId": "listPolicy", + "description": "List Device", + "operationId": "listDevice", "parameters": [ { "description": "Page number. Default is 0.", @@ -7426,54 +7426,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyList" + "$ref": "#/components/schemas/DeviceList" } } }, - "description": "Response policies" + "description": "Response devices" } }, "tags": [ - "PolicyV1alpha1" + "DeviceV1alpha1" ] }, "post": { - "description": "Create Policy", - "operationId": "createPolicy", + "description": "Create Device", + "operationId": "createDevice", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Device" } } }, - "description": "Fresh policy" + "description": "Fresh device" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Device" } } }, - "description": "Response policies created just now" + "description": "Response devices created just now" } }, "tags": [ - "PolicyV1alpha1" + "DeviceV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/policies/{name}": { + "/apis/security.halo.run/v1alpha1/devices/{name}": { "delete": { - "description": "Delete Policy", - "operationId": "deletePolicy", + "description": "Delete Device", + "operationId": "deleteDevice", "parameters": [ { - "description": "Name of policy", + "description": "Name of device", "in": "path", "name": "name", "required": true, @@ -7484,19 +7484,19 @@ ], "responses": { "200": { - "description": "Response policy deleted just now" + "description": "Response device deleted just now" } }, "tags": [ - "PolicyV1alpha1" + "DeviceV1alpha1" ] }, "get": { - "description": "Get Policy", - "operationId": "getPolicy", + "description": "Get Device", + "operationId": "getDevice", "parameters": [ { - "description": "Name of policy", + "description": "Name of device", "in": "path", "name": "name", "required": true, @@ -7510,23 +7510,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Device" } } }, - "description": "Response single policy" + "description": "Response single device" } }, "tags": [ - "PolicyV1alpha1" + "DeviceV1alpha1" ] }, "patch": { - "description": "Patch Policy", - "operationId": "patchPolicy", + "description": "Patch Device", + "operationId": "patchDevice", "parameters": [ { - "description": "Name of policy", + "description": "Name of device", "in": "path", "name": "name", "required": true, @@ -7549,23 +7549,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Device" } } }, - "description": "Response policy patched just now" + "description": "Response device patched just now" } }, "tags": [ - "PolicyV1alpha1" + "DeviceV1alpha1" ] }, "put": { - "description": "Update Policy", - "operationId": "updatePolicy", + "description": "Update Device", + "operationId": "updateDevice", "parameters": [ { - "description": "Name of policy", + "description": "Name of device", "in": "path", "name": "name", "required": true, @@ -7578,33 +7578,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Device" } } }, - "description": "Updated policy" + "description": "Updated device" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Device" } } }, - "description": "Response policies updated just now" + "description": "Response devices updated just now" } }, "tags": [ - "PolicyV1alpha1" + "DeviceV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/policytemplates": { + "/apis/security.halo.run/v1alpha1/personalaccesstokens": { "get": { - "description": "List PolicyTemplate", - "operationId": "listPolicyTemplate", + "description": "List PersonalAccessToken", + "operationId": "listPersonalAccessToken", "parameters": [ { "description": "Page number. Default is 0.", @@ -7663,54 +7663,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplateList" + "$ref": "#/components/schemas/PersonalAccessTokenList" } } }, - "description": "Response policytemplates" + "description": "Response personalaccesstokens" } }, "tags": [ - "PolicyTemplateV1alpha1" + "PersonalAccessTokenV1alpha1" ] }, "post": { - "description": "Create PolicyTemplate", - "operationId": "createPolicyTemplate", + "description": "Create PersonalAccessToken", + "operationId": "createPersonalAccessToken", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/PersonalAccessToken" } } }, - "description": "Fresh policytemplate" + "description": "Fresh personalaccesstoken" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/PersonalAccessToken" } } }, - "description": "Response policytemplates created just now" + "description": "Response personalaccesstokens created just now" } }, "tags": [ - "PolicyTemplateV1alpha1" + "PersonalAccessTokenV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/policytemplates/{name}": { + "/apis/security.halo.run/v1alpha1/personalaccesstokens/{name}": { "delete": { - "description": "Delete PolicyTemplate", - "operationId": "deletePolicyTemplate", + "description": "Delete PersonalAccessToken", + "operationId": "deletePersonalAccessToken", "parameters": [ { - "description": "Name of policytemplate", + "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, @@ -7721,19 +7721,19 @@ ], "responses": { "200": { - "description": "Response policytemplate deleted just now" + "description": "Response personalaccesstoken deleted just now" } }, "tags": [ - "PolicyTemplateV1alpha1" + "PersonalAccessTokenV1alpha1" ] }, "get": { - "description": "Get PolicyTemplate", - "operationId": "getPolicyTemplate", + "description": "Get PersonalAccessToken", + "operationId": "getPersonalAccessToken", "parameters": [ { - "description": "Name of policytemplate", + "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, @@ -7747,23 +7747,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/PersonalAccessToken" } } }, - "description": "Response single policytemplate" + "description": "Response single personalaccesstoken" } }, "tags": [ - "PolicyTemplateV1alpha1" + "PersonalAccessTokenV1alpha1" ] }, "patch": { - "description": "Patch PolicyTemplate", - "operationId": "patchPolicyTemplate", + "description": "Patch PersonalAccessToken", + "operationId": "patchPersonalAccessToken", "parameters": [ { - "description": "Name of policytemplate", + "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, @@ -7786,23 +7786,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/PersonalAccessToken" } } }, - "description": "Response policytemplate patched just now" + "description": "Response personalaccesstoken patched just now" } }, "tags": [ - "PolicyTemplateV1alpha1" + "PersonalAccessTokenV1alpha1" ] }, "put": { - "description": "Update PolicyTemplate", - "operationId": "updatePolicyTemplate", + "description": "Update PersonalAccessToken", + "operationId": "updatePersonalAccessToken", "parameters": [ { - "description": "Name of policytemplate", + "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, @@ -7815,33 +7815,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/PersonalAccessToken" } } }, - "description": "Updated policytemplate" + "description": "Updated personalaccesstoken" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/PersonalAccessToken" } } }, - "description": "Response policytemplates updated just now" + "description": "Response personalaccesstokens updated just now" } }, "tags": [ - "PolicyTemplateV1alpha1" + "PersonalAccessTokenV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/thumbnails": { + "/apis/security.halo.run/v1alpha1/remembermetokens": { "get": { - "description": "List Thumbnail", - "operationId": "listThumbnail", + "description": "List RememberMeToken", + "operationId": "listRememberMeToken", "parameters": [ { "description": "Page number. Default is 0.", @@ -7900,54 +7900,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ThumbnailList" + "$ref": "#/components/schemas/RememberMeTokenList" } } }, - "description": "Response thumbnails" + "description": "Response remembermetokens" } }, "tags": [ - "ThumbnailV1alpha1" + "RememberMeTokenV1alpha1" ] }, "post": { - "description": "Create Thumbnail", - "operationId": "createThumbnail", + "description": "Create RememberMeToken", + "operationId": "createRememberMeToken", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Thumbnail" + "$ref": "#/components/schemas/RememberMeToken" } } }, - "description": "Fresh thumbnail" + "description": "Fresh remembermetoken" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Thumbnail" + "$ref": "#/components/schemas/RememberMeToken" } } }, - "description": "Response thumbnails created just now" + "description": "Response remembermetokens created just now" } }, "tags": [ - "ThumbnailV1alpha1" + "RememberMeTokenV1alpha1" ] } }, - "/apis/storage.halo.run/v1alpha1/thumbnails/{name}": { + "/apis/security.halo.run/v1alpha1/remembermetokens/{name}": { "delete": { - "description": "Delete Thumbnail", - "operationId": "deleteThumbnail", + "description": "Delete RememberMeToken", + "operationId": "deleteRememberMeToken", "parameters": [ { - "description": "Name of thumbnail", + "description": "Name of remembermetoken", "in": "path", "name": "name", "required": true, @@ -7958,19 +7958,19 @@ ], "responses": { "200": { - "description": "Response thumbnail deleted just now" + "description": "Response remembermetoken deleted just now" } }, "tags": [ - "ThumbnailV1alpha1" + "RememberMeTokenV1alpha1" ] }, "get": { - "description": "Get Thumbnail", - "operationId": "getThumbnail", + "description": "Get RememberMeToken", + "operationId": "getRememberMeToken", "parameters": [ { - "description": "Name of thumbnail", + "description": "Name of remembermetoken", "in": "path", "name": "name", "required": true, @@ -7984,23 +7984,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Thumbnail" + "$ref": "#/components/schemas/RememberMeToken" } } }, - "description": "Response single thumbnail" + "description": "Response single remembermetoken" } }, "tags": [ - "ThumbnailV1alpha1" + "RememberMeTokenV1alpha1" ] }, "patch": { - "description": "Patch Thumbnail", - "operationId": "patchThumbnail", + "description": "Patch RememberMeToken", + "operationId": "patchRememberMeToken", "parameters": [ { - "description": "Name of thumbnail", + "description": "Name of remembermetoken", "in": "path", "name": "name", "required": true, @@ -8023,23 +8023,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Thumbnail" + "$ref": "#/components/schemas/RememberMeToken" } } }, - "description": "Response thumbnail patched just now" + "description": "Response remembermetoken patched just now" } }, "tags": [ - "ThumbnailV1alpha1" + "RememberMeTokenV1alpha1" ] }, "put": { - "description": "Update Thumbnail", - "operationId": "updateThumbnail", + "description": "Update RememberMeToken", + "operationId": "updateRememberMeToken", "parameters": [ { - "description": "Name of thumbnail", + "description": "Name of remembermetoken", "in": "path", "name": "name", "required": true, @@ -8052,33 +8052,33 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Thumbnail" + "$ref": "#/components/schemas/RememberMeToken" } } }, - "description": "Updated thumbnail" + "description": "Updated remembermetoken" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Thumbnail" + "$ref": "#/components/schemas/RememberMeToken" } } }, - "description": "Response thumbnails updated just now" + "description": "Response remembermetokens updated just now" } }, "tags": [ - "ThumbnailV1alpha1" + "RememberMeTokenV1alpha1" ] } }, - "/apis/theme.halo.run/v1alpha1/themes": { + "/apis/storage.halo.run/v1alpha1/attachments": { "get": { - "description": "List Theme", - "operationId": "listTheme", + "description": "List Attachment", + "operationId": "listAttachment", "parameters": [ { "description": "Page number. Default is 0.", @@ -8137,54 +8137,54 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ThemeList" + "$ref": "#/components/schemas/AttachmentList" } } }, - "description": "Response themes" + "description": "Response attachments" } }, "tags": [ - "ThemeV1alpha1" + "AttachmentV1alpha1" ] }, "post": { - "description": "Create Theme", - "operationId": "createTheme", + "description": "Create Attachment", + "operationId": "createAttachment", "requestBody": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Attachment" } } }, - "description": "Fresh theme" + "description": "Fresh attachment" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Attachment" } } }, - "description": "Response themes created just now" + "description": "Response attachments created just now" } }, "tags": [ - "ThemeV1alpha1" + "AttachmentV1alpha1" ] } }, - "/apis/theme.halo.run/v1alpha1/themes/{name}": { + "/apis/storage.halo.run/v1alpha1/attachments/{name}": { "delete": { - "description": "Delete Theme", - "operationId": "deleteTheme", + "description": "Delete Attachment", + "operationId": "deleteAttachment", "parameters": [ { - "description": "Name of theme", + "description": "Name of attachment", "in": "path", "name": "name", "required": true, @@ -8195,19 +8195,19 @@ ], "responses": { "200": { - "description": "Response theme deleted just now" + "description": "Response attachment deleted just now" } }, "tags": [ - "ThemeV1alpha1" + "AttachmentV1alpha1" ] }, "get": { - "description": "Get Theme", - "operationId": "getTheme", + "description": "Get Attachment", + "operationId": "getAttachment", "parameters": [ { - "description": "Name of theme", + "description": "Name of attachment", "in": "path", "name": "name", "required": true, @@ -8221,23 +8221,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Attachment" } } }, - "description": "Response single theme" + "description": "Response single attachment" } }, "tags": [ - "ThemeV1alpha1" + "AttachmentV1alpha1" ] }, "patch": { - "description": "Patch Theme", - "operationId": "patchTheme", + "description": "Patch Attachment", + "operationId": "patchAttachment", "parameters": [ { - "description": "Name of theme", + "description": "Name of attachment", "in": "path", "name": "name", "required": true, @@ -8260,23 +8260,23 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Attachment" } } }, - "description": "Response theme patched just now" + "description": "Response attachment patched just now" } }, "tags": [ - "ThemeV1alpha1" + "AttachmentV1alpha1" ] }, "put": { - "description": "Update Theme", - "operationId": "updateTheme", + "description": "Update Attachment", + "operationId": "updateAttachment", "parameters": [ { - "description": "Name of theme", + "description": "Name of attachment", "in": "path", "name": "name", "required": true, @@ -8289,81 +8289,1745 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Attachment" } } }, - "description": "Updated theme" + "description": "Updated attachment" }, "responses": { "200": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Attachment" } } }, - "description": "Response themes updated just now" + "description": "Response attachments updated just now" } }, "tags": [ - "ThemeV1alpha1" + "AttachmentV1alpha1" ] } - } - }, - "components": { - "schemas": { - "AddOperation": { - "required": [ - "op", - "path", - "value" - ], - "type": "object", - "properties": { - "op": { - "type": "string", - "enum": [ - "add" - ] - }, - "path": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" + }, + "/apis/storage.halo.run/v1alpha1/groups": { + "get": { + "description": "List Group", + "operationId": "listGroup", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } }, - "value": { - "description": "Value can be any JSON value" - } - } - }, - "AnnotationSetting": { - "required": [ - "apiVersion", - "kind", - "metadata", - "spec" - ], - "type": "object", - "properties": { - "apiVersion": { - "type": "string" + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } }, - "kind": { - "type": "string" + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, - "metadata": { - "$ref": "#/components/schemas/Metadata" + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, - "spec": { - "$ref": "#/components/schemas/AnnotationSettingSpec" - } + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GroupList" + } + } + }, + "description": "Response groups" + } + }, + "tags": [ + "GroupV1alpha1" + ] + }, + "post": { + "description": "Create Group", + "operationId": "createGroup", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Fresh group" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Response groups created just now" + } + }, + "tags": [ + "GroupV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/groups/{name}": { + "delete": { + "description": "Delete Group", + "operationId": "deleteGroup", + "parameters": [ + { + "description": "Name of group", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response group deleted just now" + } + }, + "tags": [ + "GroupV1alpha1" + ] + }, + "get": { + "description": "Get Group", + "operationId": "getGroup", + "parameters": [ + { + "description": "Name of group", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Response single group" + } + }, + "tags": [ + "GroupV1alpha1" + ] + }, + "patch": { + "description": "Patch Group", + "operationId": "patchGroup", + "parameters": [ + { + "description": "Name of group", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/JsonPatch" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Response group patched just now" + } + }, + "tags": [ + "GroupV1alpha1" + ] + }, + "put": { + "description": "Update Group", + "operationId": "updateGroup", + "parameters": [ + { + "description": "Name of group", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Updated group" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Response groups updated just now" + } + }, + "tags": [ + "GroupV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/localthumbnails": { + "get": { + "description": "List LocalThumbnail", + "operationId": "listLocalThumbnail", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnailList" + } + } + }, + "description": "Response localthumbnails" + } + }, + "tags": [ + "LocalThumbnailV1alpha1" + ] + }, + "post": { + "description": "Create LocalThumbnail", + "operationId": "createLocalThumbnail", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnail" + } + } + }, + "description": "Fresh localthumbnail" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnail" + } + } + }, + "description": "Response localthumbnails created just now" + } + }, + "tags": [ + "LocalThumbnailV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/localthumbnails/{name}": { + "delete": { + "description": "Delete LocalThumbnail", + "operationId": "deleteLocalThumbnail", + "parameters": [ + { + "description": "Name of localthumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response localthumbnail deleted just now" + } + }, + "tags": [ + "LocalThumbnailV1alpha1" + ] + }, + "get": { + "description": "Get LocalThumbnail", + "operationId": "getLocalThumbnail", + "parameters": [ + { + "description": "Name of localthumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnail" + } + } + }, + "description": "Response single localthumbnail" + } + }, + "tags": [ + "LocalThumbnailV1alpha1" + ] + }, + "patch": { + "description": "Patch LocalThumbnail", + "operationId": "patchLocalThumbnail", + "parameters": [ + { + "description": "Name of localthumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/JsonPatch" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnail" + } + } + }, + "description": "Response localthumbnail patched just now" + } + }, + "tags": [ + "LocalThumbnailV1alpha1" + ] + }, + "put": { + "description": "Update LocalThumbnail", + "operationId": "updateLocalThumbnail", + "parameters": [ + { + "description": "Name of localthumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnail" + } + } + }, + "description": "Updated localthumbnail" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/LocalThumbnail" + } + } + }, + "description": "Response localthumbnails updated just now" + } + }, + "tags": [ + "LocalThumbnailV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/policies": { + "get": { + "description": "List Policy", + "operationId": "listPolicy", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyList" + } + } + }, + "description": "Response policies" + } + }, + "tags": [ + "PolicyV1alpha1" + ] + }, + "post": { + "description": "Create Policy", + "operationId": "createPolicy", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Fresh policy" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Response policies created just now" + } + }, + "tags": [ + "PolicyV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/policies/{name}": { + "delete": { + "description": "Delete Policy", + "operationId": "deletePolicy", + "parameters": [ + { + "description": "Name of policy", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response policy deleted just now" + } + }, + "tags": [ + "PolicyV1alpha1" + ] + }, + "get": { + "description": "Get Policy", + "operationId": "getPolicy", + "parameters": [ + { + "description": "Name of policy", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Response single policy" + } + }, + "tags": [ + "PolicyV1alpha1" + ] + }, + "patch": { + "description": "Patch Policy", + "operationId": "patchPolicy", + "parameters": [ + { + "description": "Name of policy", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/JsonPatch" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Response policy patched just now" + } + }, + "tags": [ + "PolicyV1alpha1" + ] + }, + "put": { + "description": "Update Policy", + "operationId": "updatePolicy", + "parameters": [ + { + "description": "Name of policy", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Updated policy" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Response policies updated just now" + } + }, + "tags": [ + "PolicyV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/policytemplates": { + "get": { + "description": "List PolicyTemplate", + "operationId": "listPolicyTemplate", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplateList" + } + } + }, + "description": "Response policytemplates" + } + }, + "tags": [ + "PolicyTemplateV1alpha1" + ] + }, + "post": { + "description": "Create PolicyTemplate", + "operationId": "createPolicyTemplate", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplate" + } + } + }, + "description": "Fresh policytemplate" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplate" + } + } + }, + "description": "Response policytemplates created just now" + } + }, + "tags": [ + "PolicyTemplateV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/policytemplates/{name}": { + "delete": { + "description": "Delete PolicyTemplate", + "operationId": "deletePolicyTemplate", + "parameters": [ + { + "description": "Name of policytemplate", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response policytemplate deleted just now" + } + }, + "tags": [ + "PolicyTemplateV1alpha1" + ] + }, + "get": { + "description": "Get PolicyTemplate", + "operationId": "getPolicyTemplate", + "parameters": [ + { + "description": "Name of policytemplate", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplate" + } + } + }, + "description": "Response single policytemplate" + } + }, + "tags": [ + "PolicyTemplateV1alpha1" + ] + }, + "patch": { + "description": "Patch PolicyTemplate", + "operationId": "patchPolicyTemplate", + "parameters": [ + { + "description": "Name of policytemplate", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/JsonPatch" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplate" + } + } + }, + "description": "Response policytemplate patched just now" + } + }, + "tags": [ + "PolicyTemplateV1alpha1" + ] + }, + "put": { + "description": "Update PolicyTemplate", + "operationId": "updatePolicyTemplate", + "parameters": [ + { + "description": "Name of policytemplate", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplate" + } + } + }, + "description": "Updated policytemplate" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyTemplate" + } + } + }, + "description": "Response policytemplates updated just now" + } + }, + "tags": [ + "PolicyTemplateV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/thumbnails": { + "get": { + "description": "List Thumbnail", + "operationId": "listThumbnail", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ThumbnailList" + } + } + }, + "description": "Response thumbnails" + } + }, + "tags": [ + "ThumbnailV1alpha1" + ] + }, + "post": { + "description": "Create Thumbnail", + "operationId": "createThumbnail", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Thumbnail" + } + } + }, + "description": "Fresh thumbnail" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Thumbnail" + } + } + }, + "description": "Response thumbnails created just now" + } + }, + "tags": [ + "ThumbnailV1alpha1" + ] + } + }, + "/apis/storage.halo.run/v1alpha1/thumbnails/{name}": { + "delete": { + "description": "Delete Thumbnail", + "operationId": "deleteThumbnail", + "parameters": [ + { + "description": "Name of thumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response thumbnail deleted just now" + } + }, + "tags": [ + "ThumbnailV1alpha1" + ] + }, + "get": { + "description": "Get Thumbnail", + "operationId": "getThumbnail", + "parameters": [ + { + "description": "Name of thumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Thumbnail" + } + } + }, + "description": "Response single thumbnail" + } + }, + "tags": [ + "ThumbnailV1alpha1" + ] + }, + "patch": { + "description": "Patch Thumbnail", + "operationId": "patchThumbnail", + "parameters": [ + { + "description": "Name of thumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/JsonPatch" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Thumbnail" + } + } + }, + "description": "Response thumbnail patched just now" + } + }, + "tags": [ + "ThumbnailV1alpha1" + ] + }, + "put": { + "description": "Update Thumbnail", + "operationId": "updateThumbnail", + "parameters": [ + { + "description": "Name of thumbnail", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Thumbnail" + } + } + }, + "description": "Updated thumbnail" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Thumbnail" + } + } + }, + "description": "Response thumbnails updated just now" + } + }, + "tags": [ + "ThumbnailV1alpha1" + ] + } + }, + "/apis/theme.halo.run/v1alpha1/themes": { + "get": { + "description": "List Theme", + "operationId": "listTheme", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ThemeList" + } + } + }, + "description": "Response themes" + } + }, + "tags": [ + "ThemeV1alpha1" + ] + }, + "post": { + "description": "Create Theme", + "operationId": "createTheme", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "description": "Fresh theme" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "description": "Response themes created just now" + } + }, + "tags": [ + "ThemeV1alpha1" + ] + } + }, + "/apis/theme.halo.run/v1alpha1/themes/{name}": { + "delete": { + "description": "Delete Theme", + "operationId": "deleteTheme", + "parameters": [ + { + "description": "Name of theme", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response theme deleted just now" + } + }, + "tags": [ + "ThemeV1alpha1" + ] + }, + "get": { + "description": "Get Theme", + "operationId": "getTheme", + "parameters": [ + { + "description": "Name of theme", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "description": "Response single theme" + } + }, + "tags": [ + "ThemeV1alpha1" + ] + }, + "patch": { + "description": "Patch Theme", + "operationId": "patchTheme", + "parameters": [ + { + "description": "Name of theme", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/JsonPatch" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "description": "Response theme patched just now" + } + }, + "tags": [ + "ThemeV1alpha1" + ] + }, + "put": { + "description": "Update Theme", + "operationId": "updateTheme", + "parameters": [ + { + "description": "Name of theme", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "description": "Updated theme" + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "description": "Response themes updated just now" + } + }, + "tags": [ + "ThemeV1alpha1" + ] + } + } + }, + "components": { + "schemas": { + "AddOperation": { + "required": [ + "op", + "path", + "value" + ], + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add" + ] + }, + "path": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", + "type": "string", + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" + }, + "value": { + "description": "Value can be any JSON value" + } + } + }, + "AnnotationSetting": { + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/AnnotationSettingSpec" + } + } + }, + "AnnotationSettingList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/AnnotationSetting" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "AnnotationSettingSpec": { + "required": [ + "formSchema", + "targetRef" + ], + "type": "object", + "properties": { + "formSchema": { + "minLength": 1, + "type": "array", + "items": { + "minLength": 1, + "type": "object" + } + }, + "targetRef": { + "$ref": "#/components/schemas/GroupKind" + } + } + }, + "Attachment": { + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/AttachmentSpec" + }, + "status": { + "$ref": "#/components/schemas/AttachmentStatus" + } + } + }, + "AttachmentList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/Attachment" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "AttachmentSpec": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of attachment" + }, + "groupName": { + "type": "string", + "description": "Group name" + }, + "mediaType": { + "type": "string", + "description": "Media type of attachment" + }, + "ownerName": { + "type": "string", + "description": "Name of User who uploads the attachment" + }, + "policyName": { + "type": "string", + "description": "Policy name" + }, + "size": { + "minimum": 0, + "type": "integer", + "description": "Size of attachment. Unit is Byte", + "format": "int64" + }, + "tags": { + "uniqueItems": true, + "type": "array", + "description": "Tags of attachment", + "items": { + "type": "string", + "description": "Tag name" + } + } + } + }, + "AttachmentStatus": { + "type": "object", + "properties": { + "permalink": { + "type": "string", + "description": "Permalink of attachment.\nIf it is in local storage, the public URL will be set.\nIf it is in s3 storage, the Object URL will be set.\n" + }, + "thumbnails": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } }, - "AnnotationSettingList": { + "AuthProvider": { + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/AuthProviderSpec" + } + } + }, + "AuthProviderList": { "required": [ "first", "hasNext", @@ -8393,7 +10057,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/AnnotationSetting" + "$ref": "#/components/schemas/AuthProvider" } }, "last": { @@ -8422,27 +10086,209 @@ } } }, - "AnnotationSettingSpec": { + "AuthProviderSpec": { "required": [ - "formSchema", - "targetRef" + "authType", + "authenticationUrl", + "displayName" ], "type": "object", "properties": { - "formSchema": { + "authType": { + "type": "string", + "enum": [ + "FORM", + "OAUTH2" + ] + }, + "authenticationUrl": { + "type": "string", + "description": "Authentication url of the auth provider" + }, + "bindingUrl": { + "type": "string" + }, + "configMapRef": { + "$ref": "#/components/schemas/ConfigMapRef" + }, + "description": { + "type": "string" + }, + "displayName": { + "type": "string", + "description": "Display name of the auth provider" + }, + "helpPage": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "method": { + "type": "string" + }, + "rememberMeSupport": { + "type": "boolean" + }, + "settingRef": { + "$ref": "#/components/schemas/SettingRef" + }, + "unbindUrl": { + "type": "string" + }, + "website": { + "type": "string" + } + } + }, + "Author": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { "minLength": 1, + "type": "string" + }, + "website": { + "type": "string" + } + } + }, + "Backup": { + "required": [ + "apiVersion", + "kind", + "metadata" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/BackupSpec" + }, + "status": { + "$ref": "#/components/schemas/BackupStatus" + } + } + }, + "BackupList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { "type": "array", + "description": "A chunk of items.", "items": { - "minLength": 1, - "type": "object" + "$ref": "#/components/schemas/Backup" } }, - "targetRef": { - "$ref": "#/components/schemas/GroupKind" + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" } } }, - "Attachment": { + "BackupSpec": { + "type": "object", + "properties": { + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "format": { + "type": "string", + "description": "Backup file format. Currently, only zip format is supported." + } + } + }, + "BackupStatus": { + "type": "object", + "properties": { + "completionTimestamp": { + "type": "string", + "format": "date-time" + }, + "failureMessage": { + "type": "string" + }, + "failureReason": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "phase": { + "type": "string", + "enum": [ + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ] + }, + "size": { + "type": "integer", + "format": "int64" + }, + "startTimestamp": { + "type": "string", + "format": "date-time" + } + } + }, + "Category": { "required": [ "apiVersion", "kind", @@ -8461,14 +10307,14 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/AttachmentSpec" + "$ref": "#/components/schemas/CategorySpec" }, "status": { - "$ref": "#/components/schemas/AttachmentStatus" + "$ref": "#/components/schemas/CategoryStatus" } } }, - "AttachmentList": { + "CategoryList": { "required": [ "first", "hasNext", @@ -8498,7 +10344,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Attachment" + "$ref": "#/components/schemas/Category" } }, "last": { @@ -8527,62 +10373,72 @@ } } }, - "AttachmentSpec": { + "CategorySpec": { + "required": [ + "displayName", + "priority", + "slug" + ], "type": "object", "properties": { - "displayName": { - "type": "string", - "description": "Display name of attachment" + "children": { + "type": "array", + "items": { + "type": "string" + } }, - "groupName": { - "type": "string", - "description": "Group name" + "cover": { + "type": "string" }, - "mediaType": { - "type": "string", - "description": "Media type of attachment" + "description": { + "type": "string" }, - "ownerName": { - "type": "string", - "description": "Name of User who uploads the attachment" + "displayName": { + "minLength": 1, + "type": "string" }, - "policyName": { - "type": "string", - "description": "Policy name" + "hideFromList": { + "type": "boolean" }, - "size": { - "minimum": 0, + "postTemplate": { + "maxLength": 255, + "type": "string" + }, + "preventParentPostCascadeQuery": { + "type": "boolean" + }, + "priority": { "type": "integer", - "description": "Size of attachment. Unit is Byte", - "format": "int64" + "format": "int32", + "default": 0 }, - "tags": { - "uniqueItems": true, - "type": "array", - "description": "Tags of attachment", - "items": { - "type": "string", - "description": "Tag name" - } + "slug": { + "minLength": 1, + "type": "string" + }, + "template": { + "maxLength": 255, + "type": "string" } } }, - "AttachmentStatus": { + "CategoryStatus": { "type": "object", "properties": { "permalink": { - "type": "string", - "description": "Permalink of attachment.\nIf it is in local storage, the public URL will be set.\nIf it is in s3 storage, the Object URL will be set.\n" + "type": "string" }, - "thumbnails": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "postCount": { + "type": "integer", + "format": "int32" + }, + "visiblePostCount": { + "type": "integer", + "format": "int32" } } }, - "AuthProvider": { + "Comment": { "required": [ "apiVersion", "kind", @@ -8601,11 +10457,14 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/AuthProviderSpec" + "$ref": "#/components/schemas/CommentSpec" + }, + "status": { + "$ref": "#/components/schemas/CommentStatus" } } }, - "AuthProviderList": { + "CommentList": { "required": [ "first", "hasNext", @@ -8635,7 +10494,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/AuthProvider" + "$ref": "#/components/schemas/Comment" } }, "last": { @@ -8664,77 +10523,166 @@ } } }, - "AuthProviderSpec": { + "CommentOwner": { "required": [ - "authType", - "authenticationUrl", - "displayName" + "kind", + "name" ], "type": "object", "properties": { - "authType": { - "type": "string", - "enum": [ - "FORM", - "OAUTH2" - ] - }, - "authenticationUrl": { - "type": "string", - "description": "Authentication url of the auth provider" + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "bindingUrl": { + "displayName": { "type": "string" }, - "configMapRef": { - "$ref": "#/components/schemas/ConfigMapRef" + "kind": { + "minLength": 1, + "type": "string" }, - "description": { + "name": { + "maxLength": 64, "type": "string" + } + } + }, + "CommentSpec": { + "required": [ + "allowNotification", + "approved", + "content", + "hidden", + "owner", + "priority", + "raw", + "subjectRef", + "top" + ], + "type": "object", + "properties": { + "allowNotification": { + "type": "boolean", + "default": true }, - "displayName": { + "approved": { + "type": "boolean", + "default": false + }, + "approvedTime": { "type": "string", - "description": "Display name of the auth provider" + "format": "date-time" }, - "helpPage": { + "content": { + "minLength": 1, "type": "string" }, - "logo": { - "type": "string" + "creationTime": { + "type": "string", + "format": "date-time" }, - "method": { + "hidden": { + "type": "boolean", + "default": false + }, + "ipAddress": { "type": "string" }, - "rememberMeSupport": { - "type": "boolean" + "lastReadTime": { + "type": "string", + "format": "date-time" }, - "settingRef": { - "$ref": "#/components/schemas/SettingRef" + "owner": { + "$ref": "#/components/schemas/CommentOwner" }, - "unbindUrl": { + "priority": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "raw": { + "minLength": 1, "type": "string" }, - "website": { + "subjectRef": { + "$ref": "#/components/schemas/Ref" + }, + "top": { + "type": "boolean", + "default": false + }, + "userAgent": { "type": "string" } } }, - "Author": { + "CommentStatus": { + "type": "object", + "properties": { + "hasNewReply": { + "type": "boolean" + }, + "lastReplyTime": { + "type": "string", + "format": "date-time" + }, + "observedVersion": { + "type": "integer", + "format": "int64" + }, + "replyCount": { + "type": "integer", + "format": "int32" + }, + "unreadReplyCount": { + "type": "integer", + "format": "int32" + }, + "visibleReplyCount": { + "type": "integer", + "format": "int32" + } + } + }, + "Condition": { "required": [ - "name" + "lastTransitionTime", + "status", + "type" ], "type": "object", "properties": { - "name": { - "minLength": 1, + "lastTransitionTime": { + "type": "string", + "format": "date-time" + }, + "message": { + "maxLength": 32768, "type": "string" }, - "website": { + "reason": { + "maxLength": 1024, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "TRUE", + "FALSE", + "UNKNOWN" + ] + }, + "type": { + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } } }, - "Backup": { + "ConfigMap": { "required": [ "apiVersion", "kind", @@ -8745,21 +10693,21 @@ "apiVersion": { "type": "string" }, + "data": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" - }, - "spec": { - "$ref": "#/components/schemas/BackupSpec" - }, - "status": { - "$ref": "#/components/schemas/BackupStatus" } } }, - "BackupList": { + "ConfigMapList": { "required": [ "first", "hasNext", @@ -8789,7 +10737,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Backup" + "$ref": "#/components/schemas/ConfigMap" } }, "last": { @@ -8818,81 +10766,86 @@ } } }, - "BackupSpec": { + "ConfigMapRef": { + "required": [ + "name" + ], "type": "object", "properties": { - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "format": { - "type": "string", - "description": "Backup file format. Currently, only zip format is supported." + "name": { + "minLength": 1, + "type": "string" } } }, - "BackupStatus": { + "CopyOperation": { + "required": [ + "op", + "from", + "path" + ], "type": "object", "properties": { - "completionTimestamp": { + "from": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", "type": "string", - "format": "date-time" - }, - "failureMessage": { - "type": "string" - }, - "failureReason": { - "type": "string" - }, - "filename": { - "type": "string" + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" }, - "phase": { + "op": { "type": "string", "enum": [ - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED" + "copy" ] }, - "size": { - "type": "integer", - "format": "int64" - }, - "startTimestamp": { + "path": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", "type": "string", - "format": "date-time" + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" } } }, - "Category": { + "Counter": { "required": [ "apiVersion", "kind", - "metadata", - "spec" + "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, + "approvedComment": { + "type": "integer", + "format": "int32" + }, + "downvote": { + "type": "integer", + "format": "int32" + }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, - "spec": { - "$ref": "#/components/schemas/CategorySpec" + "totalComment": { + "type": "integer", + "format": "int32" }, - "status": { - "$ref": "#/components/schemas/CategoryStatus" + "upvote": { + "type": "integer", + "format": "int32" + }, + "visit": { + "type": "integer", + "format": "int32" } } }, - "CategoryList": { + "CounterList": { "required": [ "first", "hasNext", @@ -8922,7 +10875,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Counter" } }, "last": { @@ -8951,77 +10904,36 @@ } } }, - "CategorySpec": { - "required": [ - "displayName", - "priority", - "slug" - ], + "CustomTemplates": { "type": "object", "properties": { - "children": { + "category": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/TemplateDescriptor" } }, - "cover": { - "type": "string" - }, - "description": { - "type": "string" - }, - "displayName": { - "minLength": 1, - "type": "string" - }, - "hideFromList": { - "type": "boolean" - }, - "postTemplate": { - "maxLength": 255, - "type": "string" - }, - "preventParentPostCascadeQuery": { - "type": "boolean" - }, - "priority": { - "type": "integer", - "format": "int32", - "default": 0 - }, - "slug": { - "minLength": 1, - "type": "string" - }, - "template": { - "maxLength": 255, - "type": "string" - } - } - }, - "CategoryStatus": { - "type": "object", - "properties": { - "permalink": { - "type": "string" - }, - "postCount": { - "type": "integer", - "format": "int32" + "page": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TemplateDescriptor" + } }, - "visiblePostCount": { - "type": "integer", - "format": "int32" + "post": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TemplateDescriptor" + } } } }, - "Comment": { + "Device": { "required": [ "apiVersion", "kind", "metadata", - "spec" + "spec", + "status" ], "type": "object", "properties": { @@ -9035,14 +10947,14 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/CommentSpec" + "$ref": "#/components/schemas/DeviceSpec" }, "status": { - "$ref": "#/components/schemas/CommentStatus" + "$ref": "#/components/schemas/DeviceStatus" } } }, - "CommentList": { + "DeviceList": { "required": [ "first", "hasNext", @@ -9072,7 +10984,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Comment" + "$ref": "#/components/schemas/Device" } }, "last": { @@ -9101,191 +11013,175 @@ } } }, - "CommentOwner": { + "DeviceSpec": { "required": [ - "kind", - "name" + "ipAddress", + "principalName", + "sessionId" ], "type": "object", "properties": { - "annotations": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "displayName": { - "type": "string" - }, - "kind": { - "minLength": 1, - "type": "string" - }, - "name": { - "maxLength": 64, + "ipAddress": { + "maxLength": 129, "type": "string" - } - } - }, - "CommentSpec": { - "required": [ - "allowNotification", - "approved", - "content", - "hidden", - "owner", - "priority", - "raw", - "subjectRef", - "top" - ], - "type": "object", - "properties": { - "allowNotification": { - "type": "boolean", - "default": true - }, - "approved": { - "type": "boolean", - "default": false }, - "approvedTime": { + "lastAccessedTime": { "type": "string", "format": "date-time" }, - "content": { - "minLength": 1, - "type": "string" - }, - "creationTime": { + "lastAuthenticatedTime": { "type": "string", "format": "date-time" }, - "hidden": { - "type": "boolean", - "default": false - }, - "ipAddress": { + "principalName": { + "minLength": 1, "type": "string" }, - "lastReadTime": { - "type": "string", - "format": "date-time" - }, - "owner": { - "$ref": "#/components/schemas/CommentOwner" - }, - "priority": { - "type": "integer", - "format": "int32", - "default": 0 + "rememberMeSeriesId": { + "type": "string" }, - "raw": { + "sessionId": { "minLength": 1, "type": "string" }, - "subjectRef": { - "$ref": "#/components/schemas/Ref" - }, - "top": { + "userAgent": { + "maxLength": 500, + "type": "string" + } + } + }, + "DeviceStatus": { + "type": "object", + "properties": { + "browser": { + "type": "string" + }, + "os": { + "type": "string" + } + } + }, + "Excerpt": { + "required": [ + "autoGenerate" + ], + "type": "object", + "properties": { + "autoGenerate": { "type": "boolean", - "default": false + "default": true }, - "userAgent": { + "raw": { "type": "string" } } }, - "CommentStatus": { + "ExtensionDefinition": { + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ], "type": "object", "properties": { - "hasNewReply": { - "type": "boolean" - }, - "lastReplyTime": { - "type": "string", - "format": "date-time" - }, - "observedVersion": { - "type": "integer", - "format": "int64" + "apiVersion": { + "type": "string" }, - "replyCount": { - "type": "integer", - "format": "int32" + "kind": { + "type": "string" }, - "unreadReplyCount": { - "type": "integer", - "format": "int32" + "metadata": { + "$ref": "#/components/schemas/Metadata" }, - "visibleReplyCount": { - "type": "integer", - "format": "int32" + "spec": { + "$ref": "#/components/schemas/ExtensionSpec" } } }, - "Condition": { + "ExtensionDefinitionList": { "required": [ - "lastTransitionTime", - "status", - "type" + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" ], "type": "object", "properties": { - "lastTransitionTime": { - "type": "string", - "format": "date-time" + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." }, - "message": { - "maxLength": 32768, - "type": "string" + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." }, - "reason": { - "maxLength": 1024, - "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", - "type": "string" + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." }, - "status": { - "type": "string", - "enum": [ - "TRUE", - "FALSE", - "UNKNOWN" - ] + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/ExtensionDefinition" + } }, - "type": { - "maxLength": 316, - "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", - "type": "string" + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" } } }, - "ConfigMap": { + "ExtensionPointDefinition": { "required": [ "apiVersion", "kind", - "metadata" + "metadata", + "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, - "data": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/ExtensionPointSpec" } } }, - "ConfigMapList": { + "ExtensionPointDefinitionList": { "required": [ "first", "hasNext", @@ -9315,7 +11211,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/ConfigMap" + "$ref": "#/components/schemas/ExtensionPointDefinition" } }, "last": { @@ -9344,86 +11240,109 @@ } } }, - "ConfigMapRef": { + "ExtensionPointSpec": { "required": [ - "name" + "className", + "displayName", + "type" ], "type": "object", "properties": { - "name": { - "minLength": 1, + "className": { + "type": "string" + }, + "description": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "icon": { "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "SINGLETON", + "MULTI_INSTANCE" + ] } } }, - "CopyOperation": { + "ExtensionSpec": { "required": [ - "op", - "from", - "path" + "className", + "displayName", + "extensionPointName" ], "type": "object", "properties": { - "from": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" + "className": { + "type": "string" }, - "op": { - "type": "string", - "enum": [ - "copy" - ] + "description": { + "type": "string" }, - "path": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" + "displayName": { + "type": "string" + }, + "extensionPointName": { + "type": "string" + }, + "icon": { + "type": "string" } } }, - "Counter": { + "FileReverseProxyProvider": { + "type": "object", + "properties": { + "directory": { + "type": "string" + }, + "filename": { + "type": "string" + } + } + }, + "Group": { "required": [ "apiVersion", "kind", - "metadata" + "metadata", + "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, - "approvedComment": { - "type": "integer", - "format": "int32" - }, - "downvote": { - "type": "integer", - "format": "int32" - }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, - "totalComment": { - "type": "integer", - "format": "int32" + "spec": { + "$ref": "#/components/schemas/GroupSpec" }, - "upvote": { - "type": "integer", - "format": "int32" + "status": { + "$ref": "#/components/schemas/GroupStatus" + } + } + }, + "GroupKind": { + "type": "object", + "properties": { + "group": { + "type": "string" }, - "visit": { - "type": "integer", - "format": "int32" + "kind": { + "type": "string" } } }, - "CounterList": { + "GroupList": { "required": [ "first", "hasNext", @@ -9453,7 +11372,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Counter" + "$ref": "#/components/schemas/Group" } }, "last": { @@ -9482,36 +11401,122 @@ } } }, - "CustomTemplates": { + "GroupSpec": { + "required": [ + "displayName" + ], "type": "object", "properties": { - "category": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TemplateDescriptor" - } + "displayName": { + "type": "string", + "description": "Display name of group" + } + } + }, + "GroupStatus": { + "type": "object", + "properties": { + "totalAttachments": { + "minimum": 0, + "type": "integer", + "description": "Total of attachments under the current group", + "format": "int64" }, - "page": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TemplateDescriptor" - } + "updateTimestamp": { + "type": "string", + "description": "Update timestamp of the group", + "format": "date-time" + } + } + }, + "InterestReason": { + "required": [ + "reasonType", + "subject" + ], + "type": "object", + "properties": { + "expression": { + "type": "string", + "description": "The expression to be interested in" }, - "post": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TemplateDescriptor" + "reasonType": { + "type": "string", + "description": "The name of the reason definition to be interested in" + }, + "subject": { + "$ref": "#/components/schemas/InterestReasonSubject" + } + }, + "description": "The reason to be interested in" + }, + "InterestReasonSubject": { + "required": [ + "apiVersion", + "kind" + ], + "type": "object", + "properties": { + "apiVersion": { + "minLength": 1, + "type": "string" + }, + "kind": { + "minLength": 1, + "type": "string" + }, + "name": { + "type": "string", + "description": "if name is not specified, it presents all subjects of the specified reason type and custom resources" + } + }, + "description": "The subject name of reason type to be interested in" + }, + "JsonPatch": { + "minItems": 1, + "uniqueItems": true, + "type": "array", + "description": "JSON schema for JSONPatch operations", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AddOperation" + }, + { + "$ref": "#/components/schemas/ReplaceOperation" + }, + { + "$ref": "#/components/schemas/TestOperation" + }, + { + "$ref": "#/components/schemas/RemoveOperation" + }, + { + "$ref": "#/components/schemas/MoveOperation" + }, + { + "$ref": "#/components/schemas/CopyOperation" } + ] + } + }, + "License": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "url": { + "type": "string" } } }, - "Device": { + "LocalThumbnail": { "required": [ "apiVersion", "kind", "metadata", - "spec", - "status" + "spec" ], "type": "object", "properties": { @@ -9525,14 +11530,14 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/DeviceSpec" + "$ref": "#/components/schemas/LocalThumbnailSpec" }, "status": { - "$ref": "#/components/schemas/DeviceStatus" + "$ref": "#/components/schemas/LocalThumbnailStatus" } } }, - "DeviceList": { + "LocalThumbnailList": { "required": [ "first", "hasNext", @@ -9562,7 +11567,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/LocalThumbnail" } }, "last": { @@ -9591,70 +11596,88 @@ } } }, - "DeviceSpec": { + "LocalThumbnailSpec": { "required": [ - "ipAddress", - "principalName", - "sessionId" + "filePath", + "imageSignature", + "imageUri", + "size", + "thumbSignature", + "thumbnailUri" ], "type": "object", "properties": { - "ipAddress": { - "maxLength": 129, + "filePath": { "type": "string" }, - "lastAccessedTime": { - "type": "string", - "format": "date-time" - }, - "lastAuthenticatedTime": { - "type": "string", - "format": "date-time" - }, - "principalName": { + "imageSignature": { "minLength": 1, "type": "string" }, - "rememberMeSeriesId": { + "imageUri": { + "minLength": 1, "type": "string" }, - "sessionId": { + "size": { + "type": "string", + "enum": [ + "S", + "M", + "L", + "XL" + ] + }, + "thumbSignature": { "minLength": 1, "type": "string" }, - "userAgent": { - "maxLength": 500, + "thumbnailUri": { + "minLength": 1, "type": "string" } } }, - "DeviceStatus": { + "LocalThumbnailStatus": { "type": "object", "properties": { - "browser": { - "type": "string" - }, - "os": { - "type": "string" + "phase": { + "type": "string", + "enum": [ + "PENDING", + "SUCCEEDED", + "FAILED" + ] } } }, - "Excerpt": { + "LoginHistory": { "required": [ - "autoGenerate" + "loginAt", + "sourceIp", + "successful", + "userAgent" ], "type": "object", "properties": { - "autoGenerate": { - "type": "boolean", - "default": true + "loginAt": { + "type": "string", + "format": "date-time" }, - "raw": { + "reason": { + "type": "string" + }, + "sourceIp": { + "type": "string" + }, + "successful": { + "type": "boolean" + }, + "userAgent": { "type": "string" } } }, - "ExtensionDefinition": { + "Menu": { "required": [ "apiVersion", "kind", @@ -9667,76 +11690,17 @@ "type": "string" }, "kind": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/Metadata" - }, - "spec": { - "$ref": "#/components/schemas/ExtensionSpec" - } - } - }, - "ExtensionDefinitionList": { - "required": [ - "first", - "hasNext", - "hasPrevious", - "items", - "last", - "page", - "size", - "total", - "totalPages" - ], - "type": "object", - "properties": { - "first": { - "type": "boolean", - "description": "Indicates whether current page is the first page." - }, - "hasNext": { - "type": "boolean", - "description": "Indicates whether current page has previous page." - }, - "hasPrevious": { - "type": "boolean", - "description": "Indicates whether current page has previous page." - }, - "items": { - "type": "array", - "description": "A chunk of items.", - "items": { - "$ref": "#/components/schemas/ExtensionDefinition" - } - }, - "last": { - "type": "boolean", - "description": "Indicates whether current page is the last page." - }, - "page": { - "type": "integer", - "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", - "format": "int32" - }, - "size": { - "type": "integer", - "description": "Size of each page. If not set or equal to 0, it means no pagination.", - "format": "int32" + "type": "string" }, - "total": { - "type": "integer", - "description": "Total elements.", - "format": "int64" + "metadata": { + "$ref": "#/components/schemas/Metadata" }, - "totalPages": { - "type": "integer", - "description": "Indicates total pages.", - "format": "int64" + "spec": { + "$ref": "#/components/schemas/MenuSpec" } } }, - "ExtensionPointDefinition": { + "MenuItem": { "required": [ "apiVersion", "kind", @@ -9755,11 +11719,14 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/ExtensionPointSpec" + "$ref": "#/components/schemas/MenuItemSpec" + }, + "status": { + "$ref": "#/components/schemas/MenuItemStatus" } } }, - "ExtensionPointDefinitionList": { + "MenuItemList": { "required": [ "first", "hasNext", @@ -9789,7 +11756,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/ExtensionPointDefinition" + "$ref": "#/components/schemas/MenuItem" } }, "last": { @@ -9818,109 +11785,62 @@ } } }, - "ExtensionPointSpec": { - "required": [ - "className", - "displayName", - "type" - ], + "MenuItemSpec": { "type": "object", "properties": { - "className": { - "type": "string" - }, - "description": { - "type": "string" + "children": { + "uniqueItems": true, + "type": "array", + "description": "Children of this menu item", + "items": { + "type": "string", + "description": "The name of menu item child" + } }, "displayName": { - "type": "string" + "type": "string", + "description": "The display name of menu item." }, - "icon": { - "type": "string" + "href": { + "type": "string", + "description": "The href of this menu item." }, - "type": { + "priority": { + "type": "integer", + "description": "The priority is for ordering.", + "format": "int32" + }, + "target": { "type": "string", + "description": "The \u003ca\u003e target attribute of this menu item.", "enum": [ - "SINGLETON", - "MULTI_INSTANCE" + "_blank", + "_self", + "_parent", + "_top" ] - } - } - }, - "ExtensionSpec": { - "required": [ - "className", - "displayName", - "extensionPointName" - ], - "type": "object", - "properties": { - "className": { - "type": "string" - }, - "description": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "extensionPointName": { - "type": "string" - }, - "icon": { - "type": "string" - } - } - }, - "FileReverseProxyProvider": { - "type": "object", - "properties": { - "directory": { - "type": "string" - }, - "filename": { - "type": "string" - } - } - }, - "Group": { - "required": [ - "apiVersion", - "kind", - "metadata", - "spec" - ], - "type": "object", - "properties": { - "apiVersion": { - "type": "string" - }, - "kind": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/Metadata" - }, - "spec": { - "$ref": "#/components/schemas/GroupSpec" }, - "status": { - "$ref": "#/components/schemas/GroupStatus" + "targetRef": { + "$ref": "#/components/schemas/Ref" } - } + }, + "description": "The spec of menu item." }, - "GroupKind": { + "MenuItemStatus": { "type": "object", "properties": { - "group": { - "type": "string" + "displayName": { + "type": "string", + "description": "Calculated Display name of menu item." }, - "kind": { - "type": "string" + "href": { + "type": "string", + "description": "Calculated href of manu item." } - } + }, + "description": "The status of menu item." }, - "GroupList": { + "MenuList": { "required": [ "first", "hasNext", @@ -9950,7 +11870,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/Menu" } }, "last": { @@ -9979,7 +11899,7 @@ } } }, - "GroupSpec": { + "MenuSpec": { "required": [ "displayName" ], @@ -9987,71 +11907,105 @@ "properties": { "displayName": { "type": "string", - "description": "Display name of group" + "description": "The display name of the menu." + }, + "menuItems": { + "uniqueItems": true, + "type": "array", + "description": "Names of menu children below this menu.", + "items": { + "type": "string", + "description": "Names of menu children below this menu." + } } - } + }, + "description": "The spec of menu." }, - "GroupStatus": { + "Metadata": { + "required": [ + "name" + ], "type": "object", "properties": { - "totalAttachments": { - "minimum": 0, - "type": "integer", - "description": "Total of attachments under the current group", - "format": "int64" + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "updateTimestamp": { + "creationTimestamp": { "type": "string", - "description": "Update timestamp of the group", - "format": "date-time" - } - } - }, - "JsonPatch": { - "minItems": 1, - "uniqueItems": true, - "type": "array", - "description": "JSON schema for JSONPatch operations", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AddOperation" - }, - { - "$ref": "#/components/schemas/ReplaceOperation" - }, - { - "$ref": "#/components/schemas/TestOperation" - }, - { - "$ref": "#/components/schemas/RemoveOperation" - }, - { - "$ref": "#/components/schemas/MoveOperation" - }, - { - "$ref": "#/components/schemas/CopyOperation" + "format": "date-time", + "nullable": true + }, + "deletionTimestamp": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "finalizers": { + "uniqueItems": true, + "type": "array", + "nullable": true, + "items": { + "type": "string", + "nullable": true } - ] + }, + "generateName": { + "type": "string", + "description": "The name field will be generated automatically according to the given generateName field" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "type": "string", + "description": "Metadata name" + }, + "version": { + "type": "integer", + "format": "int64", + "nullable": true + } } }, - "License": { + "MoveOperation": { + "required": [ + "op", + "from", + "path" + ], "type": "object", "properties": { - "name": { - "type": "string" + "from": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", + "type": "string", + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" }, - "url": { - "type": "string" + "op": { + "type": "string", + "enum": [ + "move" + ] + }, + "path": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", + "type": "string", + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" } } }, - "LocalThumbnail": { + "Notification": { "required": [ "apiVersion", "kind", - "metadata", - "spec" + "metadata" ], "type": "object", "properties": { @@ -10065,14 +12019,11 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/LocalThumbnailSpec" - }, - "status": { - "$ref": "#/components/schemas/LocalThumbnailStatus" + "$ref": "#/components/schemas/NotificationSpec" } } }, - "LocalThumbnailList": { + "NotificationList": { "required": [ "first", "hasNext", @@ -10102,7 +12053,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/LocalThumbnail" + "$ref": "#/components/schemas/Notification" } }, "last": { @@ -10131,116 +12082,50 @@ } } }, - "LocalThumbnailSpec": { + "NotificationSpec": { "required": [ - "filePath", - "imageSignature", - "imageUri", - "size", - "thumbSignature", - "thumbnailUri" + "htmlContent", + "rawContent", + "reason", + "recipient", + "title" ], "type": "object", "properties": { - "filePath": { - "type": "string" - }, - "imageSignature": { - "minLength": 1, - "type": "string" - }, - "imageUri": { - "minLength": 1, + "htmlContent": { "type": "string" }, - "size": { + "lastReadAt": { "type": "string", - "enum": [ - "S", - "M", - "L", - "XL" - ] + "format": "date-time" }, - "thumbSignature": { - "minLength": 1, + "rawContent": { "type": "string" }, - "thumbnailUri": { + "reason": { "minLength": 1, - "type": "string" - } - } - }, - "LocalThumbnailStatus": { - "type": "object", - "properties": { - "phase": { - "type": "string", - "enum": [ - "PENDING", - "SUCCEEDED", - "FAILED" - ] - } - } - }, - "LoginHistory": { - "required": [ - "loginAt", - "sourceIp", - "successful", - "userAgent" - ], - "type": "object", - "properties": { - "loginAt": { "type": "string", - "format": "date-time" + "description": "The name of reason" }, - "reason": { - "type": "string" + "recipient": { + "minLength": 1, + "type": "string", + "description": "The name of user" }, - "sourceIp": { + "title": { + "minLength": 1, "type": "string" }, - "successful": { + "unread": { "type": "boolean" - }, - "userAgent": { - "type": "string" - } - } - }, - "Menu": { - "required": [ - "apiVersion", - "kind", - "metadata", - "spec" - ], - "type": "object", - "properties": { - "apiVersion": { - "type": "string" - }, - "kind": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/Metadata" - }, - "spec": { - "$ref": "#/components/schemas/MenuSpec" } } }, - "MenuItem": { + "NotificationTemplate": { "required": [ "apiVersion", "kind", - "metadata", - "spec" + "metadata" ], "type": "object", "properties": { @@ -10254,14 +12139,11 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/MenuItemSpec" - }, - "status": { - "$ref": "#/components/schemas/MenuItemStatus" + "$ref": "#/components/schemas/NotificationTemplateSpec" } } }, - "MenuItemList": { + "NotificationTemplateList": { "required": [ "first", "hasNext", @@ -10291,7 +12173,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/MenuItem" + "$ref": "#/components/schemas/NotificationTemplate" } }, "last": { @@ -10320,62 +12202,40 @@ } } }, - "MenuItemSpec": { + "NotificationTemplateSpec": { "type": "object", "properties": { - "children": { - "uniqueItems": true, - "type": "array", - "description": "Children of this menu item", - "items": { - "type": "string", - "description": "The name of menu item child" - } - }, - "displayName": { - "type": "string", - "description": "The display name of menu item." - }, - "href": { - "type": "string", - "description": "The href of this menu item." - }, - "priority": { - "type": "integer", - "description": "The priority is for ordering.", - "format": "int32" - }, - "target": { - "type": "string", - "description": "The \u003ca\u003e target attribute of this menu item.", - "enum": [ - "_blank", - "_self", - "_parent", - "_top" - ] + "reasonSelector": { + "$ref": "#/components/schemas/ReasonSelector" }, - "targetRef": { - "$ref": "#/components/schemas/Ref" + "template": { + "$ref": "#/components/schemas/TemplateContent" } - }, - "description": "The spec of menu item." + } }, - "MenuItemStatus": { + "NotifierDescriptor": { + "required": [ + "apiVersion", + "kind", + "metadata" + ], "type": "object", "properties": { - "displayName": { - "type": "string", - "description": "Calculated Display name of menu item." + "apiVersion": { + "type": "string" }, - "href": { - "type": "string", - "description": "Calculated href of manu item." + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/NotifierDescriptorSpec" } - }, - "description": "The status of menu item." + } }, - "MenuList": { + "NotifierDescriptorList": { "required": [ "first", "hasNext", @@ -10405,7 +12265,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Menu" + "$ref": "#/components/schemas/NotifierDescriptor" } }, "last": { @@ -10434,105 +12294,44 @@ } } }, - "MenuSpec": { - "required": [ - "displayName" - ], - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the menu." - }, - "menuItems": { - "uniqueItems": true, - "type": "array", - "description": "Names of menu children below this menu.", - "items": { - "type": "string", - "description": "Names of menu children below this menu." - } - } - }, - "description": "The spec of menu." - }, - "Metadata": { + "NotifierDescriptorSpec": { "required": [ - "name" + "displayName", + "notifierExtName" ], "type": "object", "properties": { - "annotations": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "creationTimestamp": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "finalizers": { - "uniqueItems": true, - "type": "array", - "nullable": true, - "items": { - "type": "string", - "nullable": true - } + "description": { + "type": "string" }, - "generateName": { - "type": "string", - "description": "The name field will be generated automatically according to the given generateName field" + "displayName": { + "minLength": 1, + "type": "string" }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "notifierExtName": { + "minLength": 1, + "type": "string" }, - "name": { - "type": "string", - "description": "Metadata name" + "receiverSettingRef": { + "$ref": "#/components/schemas/NotifierSettingRef" }, - "version": { - "type": "integer", - "format": "int64", - "nullable": true + "senderSettingRef": { + "$ref": "#/components/schemas/NotifierSettingRef" } } }, - "MoveOperation": { + "NotifierSettingRef": { "required": [ - "op", - "from", - "path" + "group", + "name" ], "type": "object", "properties": { - "from": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" - }, - "op": { - "type": "string", - "enum": [ - "move" - ] + "group": { + "type": "string" }, - "path": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" + "name": { + "type": "string" } } }, @@ -10883,12 +12682,245 @@ "UNKNOWN" ] }, - "stylesheet": { + "stylesheet": { + "type": "string" + } + } + }, + "Policy": { + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/PolicySpec" + } + } + }, + "PolicyList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/Policy" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "PolicyRule": { + "type": "object", + "properties": { + "apiGroups": { + "type": "array", + "items": { + "type": "string" + } + }, + "nonResourceURLs": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourceNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "resources": { + "type": "array", + "items": { + "type": "string" + } + }, + "verbs": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PolicySpec": { + "required": [ + "displayName", + "templateName" + ], + "type": "object", + "properties": { + "configMapName": { + "type": "string", + "description": "Reference name of ConfigMap extension" + }, + "displayName": { + "type": "string", + "description": "Display name of policy" + }, + "templateName": { + "type": "string", + "description": "Reference name of PolicyTemplate" + } + } + }, + "PolicyTemplate": { + "required": [ + "apiVersion", + "kind", + "metadata" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/PolicyTemplateSpec" + } + } + }, + "PolicyTemplateList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/PolicyTemplate" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "PolicyTemplateSpec": { + "required": [ + "settingName" + ], + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "settingName": { "type": "string" } } }, - "Policy": { + "Post": { "required": [ "apiVersion", "kind", @@ -10907,11 +12939,14 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/PolicySpec" + "$ref": "#/components/schemas/PostSpec" + }, + "status": { + "$ref": "#/components/schemas/PostStatus" } } }, - "PolicyList": { + "PostList": { "required": [ "first", "hasNext", @@ -10941,7 +12976,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/Post" } }, "last": { @@ -10970,63 +13005,156 @@ } } }, - "PolicyRule": { + "PostSpec": { + "required": [ + "allowComment", + "deleted", + "excerpt", + "pinned", + "priority", + "publish", + "slug", + "title", + "visible" + ], "type": "object", "properties": { - "apiGroups": { + "allowComment": { + "type": "boolean", + "default": true + }, + "baseSnapshot": { + "type": "string" + }, + "categories": { "type": "array", "items": { "type": "string" } }, - "nonResourceURLs": { + "cover": { + "type": "string" + }, + "deleted": { + "type": "boolean", + "default": false + }, + "excerpt": { + "$ref": "#/components/schemas/Excerpt" + }, + "headSnapshot": { + "type": "string" + }, + "htmlMetas": { "type": "array", "items": { - "type": "string" + "type": "object", + "additionalProperties": { + "type": "string" + } } }, - "resourceNames": { + "owner": { + "type": "string" + }, + "pinned": { + "type": "boolean", + "default": false + }, + "priority": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "publish": { + "type": "boolean", + "default": false + }, + "publishTime": { + "type": "string", + "format": "date-time" + }, + "releaseSnapshot": { + "type": "string" + }, + "slug": { + "minLength": 1, + "type": "string" + }, + "tags": { "type": "array", "items": { "type": "string" } }, - "resources": { + "template": { + "type": "string" + }, + "title": { + "minLength": 1, + "type": "string" + }, + "visible": { + "type": "string", + "default": "PUBLIC", + "enum": [ + "PUBLIC", + "INTERNAL", + "PRIVATE" + ] + } + } + }, + "PostStatus": { + "type": "object", + "properties": { + "commentsCount": { + "type": "integer", + "format": "int32" + }, + "conditions": { "type": "array", + "properties": { + "empty": { + "type": "boolean" + } + }, "items": { - "type": "string" + "$ref": "#/components/schemas/Condition" } }, - "verbs": { + "contributors": { "type": "array", "items": { "type": "string" } - } - } - }, - "PolicySpec": { - "required": [ - "displayName", - "templateName" - ], - "type": "object", - "properties": { - "configMapName": { - "type": "string", - "description": "Reference name of ConfigMap extension" }, - "displayName": { - "type": "string", - "description": "Display name of policy" + "excerpt": { + "type": "string" }, - "templateName": { + "hideFromList": { + "type": "boolean" + }, + "inProgress": { + "type": "boolean" + }, + "lastModifyTime": { "type": "string", - "description": "Reference name of PolicyTemplate" + "format": "date-time" + }, + "observedVersion": { + "type": "integer", + "format": "int64" + }, + "permalink": { + "type": "string" + }, + "phase": { + "type": "string" } } }, - "PolicyTemplate": { + "Reason": { "required": [ "apiVersion", "kind", @@ -11044,11 +13172,20 @@ "$ref": "#/components/schemas/Metadata" }, "spec": { - "$ref": "#/components/schemas/PolicyTemplateSpec" + "$ref": "#/components/schemas/ReasonSpec" } } }, - "PolicyTemplateList": { + "ReasonAttributes": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + } + }, + "description": "Attributes used to transfer data" + }, + "ReasonList": { "required": [ "first", "hasNext", @@ -11078,7 +13215,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/PolicyTemplate" + "$ref": "#/components/schemas/Reason" } }, "last": { @@ -11107,26 +13244,76 @@ } } }, - "PolicyTemplateSpec": { + "ReasonProperty": { "required": [ - "settingName" + "name", + "type" ], "type": "object", "properties": { - "displayName": { + "description": { "type": "string" }, - "settingName": { + "name": { + "minLength": 1, + "type": "string" + }, + "optional": { + "type": "boolean", + "default": false + }, + "type": { + "minLength": 1, "type": "string" } } }, - "Post": { + "ReasonSelector": { + "required": [ + "language", + "reasonType" + ], + "type": "object", + "properties": { + "language": { + "minLength": 1, + "type": "string", + "default": "default" + }, + "reasonType": { + "minLength": 1, + "type": "string" + } + } + }, + "ReasonSpec": { + "required": [ + "author", + "reasonType", + "subject" + ], + "type": "object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/ReasonAttributes" + }, + "author": { + "type": "string" + }, + "reasonType": { + "type": "string" + }, + "subject": { + "$ref": "#/components/schemas/ReasonSubject" + } + } + }, + "ReasonSubject": { "required": [ "apiVersion", "kind", - "metadata", - "spec" + "name", + "title" ], "type": "object", "properties": { @@ -11136,18 +13323,40 @@ "kind": { "type": "string" }, - "metadata": { - "$ref": "#/components/schemas/Metadata" + "name": { + "type": "string" }, - "spec": { - "$ref": "#/components/schemas/PostSpec" + "title": { + "type": "string" }, - "status": { - "$ref": "#/components/schemas/PostStatus" + "url": { + "type": "string" + } + } + }, + "ReasonType": { + "required": [ + "apiVersion", + "kind", + "metadata" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/ReasonTypeSpec" } } }, - "PostList": { + "ReasonTypeList": { "required": [ "first", "hasNext", @@ -11177,7 +13386,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/Post" + "$ref": "#/components/schemas/ReasonType" } }, "last": { @@ -11206,152 +13415,26 @@ } } }, - "PostSpec": { + "ReasonTypeSpec": { "required": [ - "allowComment", - "deleted", - "excerpt", - "pinned", - "priority", - "publish", - "slug", - "title", - "visible" + "description", + "displayName" ], "type": "object", "properties": { - "allowComment": { - "type": "boolean", - "default": true - }, - "baseSnapshot": { - "type": "string" - }, - "categories": { - "type": "array", - "items": { - "type": "string" - } - }, - "cover": { - "type": "string" - }, - "deleted": { - "type": "boolean", - "default": false - }, - "excerpt": { - "$ref": "#/components/schemas/Excerpt" - }, - "headSnapshot": { - "type": "string" - }, - "htmlMetas": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "owner": { - "type": "string" - }, - "pinned": { - "type": "boolean", - "default": false - }, - "priority": { - "type": "integer", - "format": "int32", - "default": 0 - }, - "publish": { - "type": "boolean", - "default": false - }, - "publishTime": { - "type": "string", - "format": "date-time" - }, - "releaseSnapshot": { - "type": "string" - }, - "slug": { + "description": { "minLength": 1, "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "template": { - "type": "string" - }, - "title": { + "displayName": { "minLength": 1, "type": "string" }, - "visible": { - "type": "string", - "default": "PUBLIC", - "enum": [ - "PUBLIC", - "INTERNAL", - "PRIVATE" - ] - } - } - }, - "PostStatus": { - "type": "object", - "properties": { - "commentsCount": { - "type": "integer", - "format": "int32" - }, - "conditions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Condition" - } - }, - "contributors": { + "properties": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ReasonProperty" } - }, - "excerpt": { - "type": "string" - }, - "hideFromList": { - "type": "boolean" - }, - "inProgress": { - "type": "boolean" - }, - "lastModifyTime": { - "type": "string", - "format": "date-time" - }, - "observedVersion": { - "type": "integer", - "format": "int64" - }, - "permalink": { - "type": "string" - }, - "phase": { - "type": "string" } } }, @@ -12677,6 +14760,124 @@ } } }, + "Subscription": { + "required": [ + "apiVersion", + "kind", + "metadata" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/SubscriptionSpec" + } + } + }, + "SubscriptionList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/Subscription" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "SubscriptionSpec": { + "required": [ + "reason", + "subscriber", + "unsubscribeToken" + ], + "type": "object", + "properties": { + "disabled": { + "type": "boolean", + "description": "Perhaps users need to unsubscribe and interact without receiving notifications again" + }, + "reason": { + "$ref": "#/components/schemas/InterestReason" + }, + "subscriber": { + "$ref": "#/components/schemas/SubscriptionSubscriber" + }, + "unsubscribeToken": { + "type": "string", + "description": "The token to unsubscribe" + } + } + }, + "SubscriptionSubscriber": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "minLength": 1, + "type": "string" + } + }, + "description": "The subscriber to be notified" + }, "Tag": { "required": [ "apiVersion", @@ -12806,6 +15007,24 @@ } } }, + "TemplateContent": { + "required": [ + "title" + ], + "type": "object", + "properties": { + "htmlBody": { + "type": "string" + }, + "rawBody": { + "type": "string" + }, + "title": { + "minLength": 1, + "type": "string" + } + } + }, "TemplateDescriptor": { "required": [ "file", diff --git a/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json index 2572b1c21b..672c4c35ce 100644 --- a/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json +++ b/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json @@ -17,10 +17,10 @@ } ], "paths": { - "/apis/api.halo.run/v1alpha1/comments": { + "/apis/api.content.halo.run/v1alpha1/categories": { "get": { - "description": "List comments.", - "operationId": "ListComments", + "description": "Lists categories.", + "operationId": "queryCategories", "parameters": [ { "description": "Page number. Default is 0.", @@ -41,9 +41,9 @@ } }, { - "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "description": "Label selector. e.g.: hidden!\u003dtrue", "in": "query", - "name": "sort", + "name": "labelSelector", "schema": { "type": "array", "items": { @@ -52,55 +52,25 @@ } }, { - "description": "The comment subject group.", - "in": "query", - "name": "group", - "schema": { - "type": "string" - } - }, - { - "description": "The comment subject version.", - "in": "query", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The comment subject kind.", - "in": "query", - "name": "kind", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The comment subject name.", - "in": "query", - "name": "name", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to include replies. Default is false.", + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", "in": "query", - "name": "withReplies", + "name": "fieldSelector", "schema": { - "type": "boolean" + "type": "array", + "items": { + "type": "string" + } } }, { - "description": "Reply size of the comment, default is 10, only works when withReplies is true.", + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in": "query", - "name": "replySize", + "name": "sort", "schema": { - "type": "integer", - "format": "int32" + "type": "array", + "items": { + "type": "string" + } } } ], @@ -109,36 +79,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/CommentWithReplyVoList" - } - } - }, - "description": "default response" - } - }, - "tags": [ - "CommentV1alpha1Public" - ] - }, - "post": { - "description": "Create a comment.", - "operationId": "CreateComment", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommentRequest" - } - } - }, - "required": true - }, - "responses": { - "default": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/Comment" + "$ref": "#/components/schemas/CategoryVoList" } } }, @@ -146,16 +87,17 @@ } }, "tags": [ - "CommentV1alpha1Public" + "CategoryV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/comments/{name}": { + "/apis/api.content.halo.run/v1alpha1/categories/{name}": { "get": { - "description": "Get a comment.", - "operationId": "GetComment", + "description": "Gets category by name.", + "operationId": "queryCategoryByName", "parameters": [ { + "description": "Category name", "in": "path", "name": "name", "required": true, @@ -169,7 +111,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/CommentVoList" + "$ref": "#/components/schemas/CategoryVo" } } }, @@ -177,16 +119,17 @@ } }, "tags": [ - "CommentV1alpha1Public" + "CategoryV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/comments/{name}/reply": { + "/apis/api.content.halo.run/v1alpha1/categories/{name}/posts": { "get": { - "description": "List comment replies.", - "operationId": "ListCommentReplies", + "description": "Lists posts by category name.", + "operationId": "queryPostsByCategoryName", "parameters": [ { + "description": "Category name", "in": "path", "name": "name", "required": true, @@ -211,84 +154,47 @@ "type": "integer", "format": "int32" } - } - ], - "responses": { - "default": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/ReplyVoList" - } - } - }, - "description": "default response" - } - }, - "tags": [ - "CommentV1alpha1Public" - ] - }, - "post": { - "description": "Create a reply.", - "operationId": "CreateReply", - "parameters": [ + }, { - "in": "path", - "name": "name", - "required": true, + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReplyRequest" + "type": "array", + "items": { + "type": "string" } } }, - "required": true - }, - "responses": { - "default": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/Reply" - } - } - }, - "description": "default response" - } - }, - "tags": [ - "CommentV1alpha1Public" - ] - } - }, - "/apis/api.halo.run/v1alpha1/indices/-/search": { - "post": { - "description": "Search indices.", - "operationId": "IndicesSearch", - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SearchOption" + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" } } }, - "description": "Please note that the \"filterPublished\", \"filterExposed\" and \"filterRecycled\" fields are ignored in this endpoint." - }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], "responses": { "default": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchResult" + "$ref": "#/components/schemas/ListedPostVoList" } } }, @@ -296,48 +202,64 @@ } }, "tags": [ - "IndexV1alpha1Public" + "CategoryV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/indices/post": { + "/apis/api.content.halo.run/v1alpha1/posts": { "get": { - "deprecated": true, - "description": "Search posts with fuzzy query. This method is deprecated, please use POST /indices/-/search instead.", - "operationId": "SearchPost", + "description": "Lists posts.", + "operationId": "queryPosts", "parameters": [ { - "description": "Keyword to search", + "description": "Page number. Default is 0.", "in": "query", - "name": "keyword", - "required": true, + "name": "page", "schema": { - "type": "string" + "type": "integer", + "format": "int32" } }, { - "description": "Limit of search results", + "description": "Size number. Default is 0.", "in": "query", - "name": "limit", + "name": "size", "schema": { "type": "integer", "format": "int32" } }, { - "description": "Highlight pre tag", + "description": "Label selector. e.g.: hidden!\u003dtrue", "in": "query", - "name": "highlightPreTag", + "name": "labelSelector", "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + } } }, { - "description": "Highlight post tag", + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", "in": "query", - "name": "highlightPostTag", + "name": "fieldSelector", "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } } } ], @@ -346,7 +268,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SearchResult" + "$ref": "#/components/schemas/ListedPostVoList" } } }, @@ -354,20 +276,31 @@ } }, "tags": [ - "IndexV1alpha1Public" + "PostV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/menus/-": { + "/apis/api.content.halo.run/v1alpha1/posts/{name}": { "get": { - "description": "Gets primary menu.", - "operationId": "queryPrimaryMenu", + "description": "Gets a post by name.", + "operationId": "queryPostByName", + "parameters": [ + { + "description": "Post name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "default": { "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/MenuVo" + "$ref": "#/components/schemas/PostVo" } } }, @@ -375,17 +308,17 @@ } }, "tags": [ - "MenuV1alpha1Public" + "PostV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/menus/{name}": { + "/apis/api.content.halo.run/v1alpha1/posts/{name}/navigation": { "get": { - "description": "Gets menu by name.", - "operationId": "queryMenuByName", + "description": "Gets a post navigation by name.", + "operationId": "queryPostNavigationByName", "parameters": [ { - "description": "Menu name", + "description": "Post name", "in": "path", "name": "name", "required": true, @@ -399,7 +332,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/MenuVo" + "$ref": "#/components/schemas/NavigationPostVo" } } }, @@ -407,20 +340,73 @@ } }, "tags": [ - "MenuV1alpha1Public" + "PostV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/stats/-": { + "/apis/api.content.halo.run/v1alpha1/singlepages": { "get": { - "description": "Gets site stats", - "operationId": "queryStats", - "responses": { - "default": { - "content": { - "*/*": { + "description": "Lists single pages", + "operationId": "querySinglePages", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { "schema": { - "$ref": "#/components/schemas/SiteStatsVo" + "$ref": "#/components/schemas/ListedSinglePageVoList" } } }, @@ -428,344 +414,1631 @@ } }, "tags": [ - "SystemV1alpha1Public" + "SinglePageV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/trackers/counter": { - "post": { - "description": "Count an extension resource visits.", - "operationId": "count", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CounterRequest" - } + "/apis/api.content.halo.run/v1alpha1/singlepages/{name}": { + "get": { + "description": "Gets single page by name", + "operationId": "querySinglePageByName", + "parameters": [ + { + "description": "SinglePage name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { "default": { - "content": {}, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SinglePageVo" + } + } + }, "description": "default response" } }, "tags": [ - "MetricsV1alpha1Public" + "SinglePageV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/trackers/downvote": { - "post": { - "description": "Downvote an extension resource.", - "operationId": "downvote", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VoteRequest" + "/apis/api.content.halo.run/v1alpha1/tags": { + "get": { + "description": "Lists tags", + "operationId": "queryTags", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" } } }, - "required": true + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TagVoList" + } + } + }, + "description": "default response" + } }, + "tags": [ + "TagV1alpha1Public" + ] + } + }, + "/apis/api.content.halo.run/v1alpha1/tags/{name}": { + "get": { + "description": "Gets tag by name", + "operationId": "queryTagByName", + "parameters": [ + { + "description": "Tag name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "default": { - "content": {}, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TagVo" + } + } + }, "description": "default response" } }, "tags": [ - "MetricsV1alpha1Public" + "TagV1alpha1Public" ] } }, - "/apis/api.halo.run/v1alpha1/trackers/upvote": { - "post": { - "description": "Upvote an extension resource.", - "operationId": "upvote", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VoteRequest" + "/apis/api.content.halo.run/v1alpha1/tags/{name}/posts": { + "get": { + "description": "Lists posts by tag name", + "operationId": "queryPostsByTagName", + "parameters": [ + { + "description": "Tag name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" } } }, - "required": true - }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], "responses": { "default": { - "content": {}, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ListedPostVo" + } + } + }, "description": "default response" } }, "tags": [ - "MetricsV1alpha1Public" + "TagV1alpha1Public" ] } - } - }, - "components": { - "schemas": { - "AddOperation": { - "required": [ + }, + "/apis/api.halo.run/v1alpha1/comments": { + "get": { + "description": "List comments.", + "operationId": "ListComments", + "parameters": [ + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "The comment subject group.", + "in": "query", + "name": "group", + "schema": { + "type": "string" + } + }, + { + "description": "The comment subject version.", + "in": "query", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The comment subject kind.", + "in": "query", + "name": "kind", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The comment subject name.", + "in": "query", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Whether to include replies. Default is false.", + "in": "query", + "name": "withReplies", + "schema": { + "type": "boolean" + } + }, + { + "description": "Reply size of the comment, default is 10, only works when withReplies is true.", + "in": "query", + "name": "replySize", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CommentWithReplyVoList" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "CommentV1alpha1Public" + ] + }, + "post": { + "description": "Create a comment.", + "operationId": "CreateComment", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommentRequest" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Comment" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "CommentV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/comments/{name}": { + "get": { + "description": "Get a comment.", + "operationId": "GetComment", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CommentVoList" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "CommentV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/comments/{name}/reply": { + "get": { + "description": "List comment replies.", + "operationId": "ListCommentReplies", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ReplyVoList" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "CommentV1alpha1Public" + ] + }, + "post": { + "description": "Create a reply.", + "operationId": "CreateReply", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReplyRequest" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Reply" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "CommentV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/indices/-/search": { + "post": { + "description": "Search indices.", + "operationId": "IndicesSearch", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SearchOption" + } + } + }, + "description": "Please note that the \"filterPublished\", \"filterExposed\" and \"filterRecycled\" fields are ignored in this endpoint." + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SearchResult" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "IndexV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/indices/post": { + "get": { + "deprecated": true, + "description": "Search posts with fuzzy query. This method is deprecated, please use POST /indices/-/search instead.", + "operationId": "SearchPost", + "parameters": [ + { + "description": "Keyword to search", + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Limit of search results", + "in": "query", + "name": "limit", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Highlight pre tag", + "in": "query", + "name": "highlightPreTag", + "schema": { + "type": "string" + } + }, + { + "description": "Highlight post tag", + "in": "query", + "name": "highlightPostTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SearchResult" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "IndexV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/menus/-": { + "get": { + "description": "Gets primary menu.", + "operationId": "queryPrimaryMenu", + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MenuVo" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "MenuV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/menus/{name}": { + "get": { + "description": "Gets menu by name.", + "operationId": "queryMenuByName", + "parameters": [ + { + "description": "Menu name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MenuVo" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "MenuV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/stats/-": { + "get": { + "description": "Gets site stats", + "operationId": "queryStats", + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SiteStatsVo" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "SystemV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/trackers/counter": { + "post": { + "description": "Count an extension resource visits.", + "operationId": "count", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CounterRequest" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": {}, + "description": "default response" + } + }, + "tags": [ + "MetricsV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/trackers/downvote": { + "post": { + "description": "Downvote an extension resource.", + "operationId": "downvote", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VoteRequest" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": {}, + "description": "default response" + } + }, + "tags": [ + "MetricsV1alpha1Public" + ] + } + }, + "/apis/api.halo.run/v1alpha1/trackers/upvote": { + "post": { + "description": "Upvote an extension resource.", + "operationId": "upvote", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VoteRequest" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": {}, + "description": "default response" + } + }, + "tags": [ + "MetricsV1alpha1Public" + ] + } + }, + "/apis/api.notification.halo.run/v1alpha1/subscriptions/{name}/unsubscribe": { + "get": { + "description": "Unsubscribe a subscription", + "operationId": "Unsubscribe", + "parameters": [ + { + "description": "Subscription name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unsubscribe token", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Public" + ] + } + }, + "/apis/api.plugin.halo.run/v1alpha1/plugins/{name}/available": { + "get": { + "description": "Gets plugin available by name.", + "operationId": "queryPluginAvailableByName", + "parameters": [ + { + "description": "Plugin name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "type": "boolean" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "PluginV1alpha1Public" + ] + } + }, + "/apis/api.storage.halo.run/v1alpha1/thumbnails/-/via-uri": { + "get": { + "description": "Get thumbnail by URI", + "operationId": "GetThumbnailByUri", + "parameters": [ + { + "description": "The URI of the image", + "in": "query", + "name": "uri", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The size of the thumbnail,available values are s,m,l,xl", + "in": "query", + "name": "size", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "ThumbnailV1alpha1Public" + ] + } + } + }, + "components": { + "schemas": { + "AddOperation": { + "required": [ "op", "path", "value" ], "type": "object", "properties": { - "op": { - "type": "string", - "enum": [ - "add" - ] + "op": { + "type": "string", + "enum": [ + "add" + ] + }, + "path": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", + "type": "string", + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" + }, + "value": { + "description": "Value can be any JSON value" + } + } + }, + "CategorySpec": { + "required": [ + "displayName", + "priority", + "slug" + ], + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "type": "string" + } + }, + "cover": { + "type": "string" + }, + "description": { + "type": "string" + }, + "displayName": { + "minLength": 1, + "type": "string" + }, + "hideFromList": { + "type": "boolean" + }, + "postTemplate": { + "maxLength": 255, + "type": "string" + }, + "preventParentPostCascadeQuery": { + "type": "boolean" + }, + "priority": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "slug": { + "minLength": 1, + "type": "string" + }, + "template": { + "maxLength": 255, + "type": "string" + } + } + }, + "CategoryStatus": { + "type": "object", + "properties": { + "permalink": { + "type": "string" + }, + "postCount": { + "type": "integer", + "format": "int32" + }, + "visiblePostCount": { + "type": "integer", + "format": "int32" + } + } + }, + "CategoryVo": { + "required": [ + "metadata" + ], + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "postCount": { + "type": "integer", + "format": "int32" + }, + "spec": { + "$ref": "#/components/schemas/CategorySpec" + }, + "status": { + "$ref": "#/components/schemas/CategoryStatus" + } + } + }, + "CategoryVoList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/CategoryVo" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "Comment": { + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/CommentSpec" + }, + "status": { + "$ref": "#/components/schemas/CommentStatus" + } + } + }, + "CommentEmailOwner": { + "type": "object", + "properties": { + "avatar": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "email": { + "type": "string" + }, + "website": { + "type": "string" + } + } + }, + "CommentOwner": { + "required": [ + "kind", + "name" + ], + "type": "object", + "properties": { + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "displayName": { + "type": "string" + }, + "kind": { + "minLength": 1, + "type": "string" + }, + "name": { + "maxLength": 64, + "type": "string" + } + } + }, + "CommentRequest": { + "required": [ + "content", + "raw", + "subjectRef" + ], + "type": "object", + "properties": { + "allowNotification": { + "type": "boolean", + "default": false + }, + "content": { + "minLength": 1, + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/CommentEmailOwner" + }, + "raw": { + "minLength": 1, + "type": "string" + }, + "subjectRef": { + "$ref": "#/components/schemas/Ref" + } + } + }, + "CommentSpec": { + "required": [ + "allowNotification", + "approved", + "content", + "hidden", + "owner", + "priority", + "raw", + "subjectRef", + "top" + ], + "type": "object", + "properties": { + "allowNotification": { + "type": "boolean", + "default": true + }, + "approved": { + "type": "boolean", + "default": false + }, + "approvedTime": { + "type": "string", + "format": "date-time" + }, + "content": { + "minLength": 1, + "type": "string" + }, + "creationTime": { + "type": "string", + "format": "date-time" + }, + "hidden": { + "type": "boolean", + "default": false + }, + "ipAddress": { + "type": "string" + }, + "lastReadTime": { + "type": "string", + "format": "date-time" + }, + "owner": { + "$ref": "#/components/schemas/CommentOwner" + }, + "priority": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "raw": { + "minLength": 1, + "type": "string" + }, + "subjectRef": { + "$ref": "#/components/schemas/Ref" + }, + "top": { + "type": "boolean", + "default": false + }, + "userAgent": { + "type": "string" + } + } + }, + "CommentStatsVo": { + "type": "object", + "properties": { + "upvote": { + "type": "integer", + "format": "int32" + } + } + }, + "CommentStatus": { + "type": "object", + "properties": { + "hasNewReply": { + "type": "boolean" + }, + "lastReplyTime": { + "type": "string", + "format": "date-time" + }, + "observedVersion": { + "type": "integer", + "format": "int64" + }, + "replyCount": { + "type": "integer", + "format": "int32" + }, + "unreadReplyCount": { + "type": "integer", + "format": "int32" + }, + "visibleReplyCount": { + "type": "integer", + "format": "int32" + } + } + }, + "CommentVo": { + "required": [ + "metadata", + "owner", + "spec", + "stats" + ], + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "owner": { + "$ref": "#/components/schemas/OwnerInfo" + }, + "spec": { + "$ref": "#/components/schemas/CommentSpec" + }, + "stats": { + "$ref": "#/components/schemas/CommentStatsVo" + }, + "status": { + "$ref": "#/components/schemas/CommentStatus" + } + }, + "description": "A chunk of items." + }, + "CommentVoList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." }, - "path": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." }, - "value": { - "description": "Value can be any JSON value" + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/CommentVo" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" } } }, - "Comment": { + "CommentWithReplyVo": { "required": [ - "apiVersion", - "kind", "metadata", - "spec" + "owner", + "spec", + "stats" ], "type": "object", "properties": { - "apiVersion": { - "type": "string" - }, - "kind": { - "type": "string" - }, "metadata": { "$ref": "#/components/schemas/Metadata" }, + "owner": { + "$ref": "#/components/schemas/OwnerInfo" + }, + "replies": { + "$ref": "#/components/schemas/ListResultReplyVo" + }, "spec": { "$ref": "#/components/schemas/CommentSpec" }, + "stats": { + "$ref": "#/components/schemas/CommentStatsVo" + }, "status": { "$ref": "#/components/schemas/CommentStatus" } - } + }, + "description": "A chunk of items." }, - "CommentEmailOwner": { + "CommentWithReplyVoList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], "type": "object", "properties": { - "avatar": { - "type": "string" + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." }, - "displayName": { - "type": "string" + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." }, - "email": { - "type": "string" + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." }, - "website": { - "type": "string" + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/CommentWithReplyVo" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" } } }, - "CommentOwner": { + "Condition": { "required": [ - "kind", - "name" + "lastTransitionTime", + "status", + "type" ], "type": "object", "properties": { - "annotations": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "lastTransitionTime": { + "type": "string", + "format": "date-time" }, - "displayName": { + "message": { + "maxLength": 32768, "type": "string" }, - "kind": { - "minLength": 1, + "reason": { + "maxLength": 1024, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, - "name": { - "maxLength": 64, + "status": { + "type": "string", + "enum": [ + "TRUE", + "FALSE", + "UNKNOWN" + ] + }, + "type": { + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } } }, - "CommentRequest": { - "required": [ - "content", - "raw", - "subjectRef" - ], + "ContentVo": { "type": "object", "properties": { - "allowNotification": { - "type": "boolean", - "default": false - }, "content": { - "minLength": 1, "type": "string" }, - "owner": { - "$ref": "#/components/schemas/CommentEmailOwner" - }, "raw": { - "minLength": 1, "type": "string" - }, - "subjectRef": { - "$ref": "#/components/schemas/Ref" } } }, - "CommentSpec": { + "ContributorVo": { "required": [ - "allowNotification", - "approved", - "content", - "hidden", - "owner", - "priority", - "raw", - "subjectRef", - "top" + "metadata" ], "type": "object", "properties": { - "allowNotification": { - "type": "boolean", - "default": true - }, - "approved": { - "type": "boolean", - "default": false + "avatar": { + "type": "string" }, - "approvedTime": { - "type": "string", - "format": "date-time" + "bio": { + "type": "string" }, - "content": { - "minLength": 1, + "displayName": { "type": "string" }, - "creationTime": { - "type": "string", - "format": "date-time" + "metadata": { + "$ref": "#/components/schemas/Metadata" }, - "hidden": { - "type": "boolean", - "default": false + "name": { + "type": "string" }, - "ipAddress": { + "permalink": { "type": "string" + } + } + }, + "CopyOperation": { + "required": [ + "op", + "from", + "path" + ], + "type": "object", + "properties": { + "from": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", + "type": "string", + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" }, - "lastReadTime": { + "op": { "type": "string", - "format": "date-time" + "enum": [ + "copy" + ] }, - "owner": { - "$ref": "#/components/schemas/CommentOwner" + "path": { + "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", + "type": "string", + "description": "A JSON Pointer path pointing to the location to move/copy from.", + "example": "/a/b/c" + } + } + }, + "CounterRequest": { + "type": "object", + "properties": { + "group": { + "type": "string" + }, + "hostname": { + "type": "string" }, - "priority": { - "type": "integer", - "format": "int32", - "default": 0 + "language": { + "type": "string" }, - "raw": { - "minLength": 1, + "name": { "type": "string" }, - "subjectRef": { - "$ref": "#/components/schemas/Ref" + "plural": { + "type": "string" }, - "top": { - "type": "boolean", - "default": false + "referrer": { + "type": "string" }, - "userAgent": { + "screen": { "type": "string" } } }, - "CommentStatsVo": { + "Excerpt": { + "required": [ + "autoGenerate" + ], "type": "object", "properties": { - "upvote": { - "type": "integer", - "format": "int32" + "autoGenerate": { + "type": "boolean", + "default": true + }, + "raw": { + "type": "string" } } }, - "CommentStatus": { + "HaloDocument": { + "required": [ + "content", + "id", + "metadataName", + "ownerName", + "permalink", + "title", + "type" + ], "type": "object", "properties": { - "hasNewReply": { - "type": "boolean" + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "lastReplyTime": { + "categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "content": { + "type": "string" + }, + "creationTimestamp": { "type": "string", "format": "date-time" }, - "observedVersion": { - "type": "integer", - "format": "int64" + "description": { + "type": "string" }, - "replyCount": { - "type": "integer", - "format": "int32" + "exposed": { + "type": "boolean" }, - "unreadReplyCount": { - "type": "integer", - "format": "int32" + "id": { + "type": "string" }, - "visibleReplyCount": { - "type": "integer", - "format": "int32" - } - } - }, - "CommentVo": { - "required": [ - "metadata", - "owner", - "spec", - "stats" - ], - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/Metadata" + "metadataName": { + "type": "string" }, - "owner": { - "$ref": "#/components/schemas/OwnerInfo" + "ownerName": { + "type": "string" }, - "spec": { - "$ref": "#/components/schemas/CommentSpec" + "permalink": { + "type": "string" }, - "stats": { - "$ref": "#/components/schemas/CommentStatsVo" + "published": { + "type": "boolean" }, - "status": { - "$ref": "#/components/schemas/CommentStatus" + "recycled": { + "type": "boolean" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": "string" + }, + "type": { + "type": "string" + }, + "updateTimestamp": { + "type": "string", + "format": "date-time" } - }, - "description": "A chunk of items." + } }, - "CommentVoList": { + "JsonPatch": { + "minItems": 1, + "uniqueItems": true, + "type": "array", + "description": "JSON schema for JSONPatch operations", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AddOperation" + }, + { + "$ref": "#/components/schemas/ReplaceOperation" + }, + { + "$ref": "#/components/schemas/TestOperation" + }, + { + "$ref": "#/components/schemas/RemoveOperation" + }, + { + "$ref": "#/components/schemas/MoveOperation" + }, + { + "$ref": "#/components/schemas/CopyOperation" + } + ] + } + }, + "ListResultReplyVo": { "required": [ "first", "hasNext", @@ -795,7 +2068,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/CommentVo" + "$ref": "#/components/schemas/ReplyVo" } }, "last": { @@ -824,37 +2097,48 @@ } } }, - "CommentWithReplyVo": { + "ListedPostVo": { "required": [ - "metadata", - "owner", - "spec", - "stats" + "metadata" ], "type": "object", "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CategoryVo" + } + }, + "contributors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContributorVo" + } + }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "owner": { - "$ref": "#/components/schemas/OwnerInfo" - }, - "replies": { - "$ref": "#/components/schemas/ListResultReplyVo" + "$ref": "#/components/schemas/ContributorVo" }, "spec": { - "$ref": "#/components/schemas/CommentSpec" + "$ref": "#/components/schemas/PostSpec" }, "stats": { - "$ref": "#/components/schemas/CommentStatsVo" + "$ref": "#/components/schemas/StatsVo" }, "status": { - "$ref": "#/components/schemas/CommentStatus" + "$ref": "#/components/schemas/PostStatus" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagVo" + } } - }, - "description": "A chunk of items." + } }, - "CommentWithReplyVoList": { + "ListedPostVoList": { "required": [ "first", "hasNext", @@ -884,7 +2168,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/CommentWithReplyVo" + "$ref": "#/components/schemas/ListedPostVo" } }, "last": { @@ -901,174 +2185,49 @@ "description": "Size of each page. If not set or equal to 0, it means no pagination.", "format": "int32" }, - "total": { - "type": "integer", - "description": "Total elements.", - "format": "int64" - }, - "totalPages": { - "type": "integer", - "description": "Indicates total pages.", - "format": "int64" - } - } - }, - "CopyOperation": { - "required": [ - "op", - "from", - "path" - ], - "type": "object", - "properties": { - "from": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" - }, - "op": { - "type": "string", - "enum": [ - "copy" - ] - }, - "path": { - "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$", - "type": "string", - "description": "A JSON Pointer path pointing to the location to move/copy from.", - "example": "/a/b/c" - } - } - }, - "CounterRequest": { - "type": "object", - "properties": { - "group": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "language": { - "type": "string" - }, - "name": { - "type": "string" - }, - "plural": { - "type": "string" - }, - "referrer": { - "type": "string" - }, - "screen": { - "type": "string" + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" } } }, - "HaloDocument": { + "ListedSinglePageVo": { "required": [ - "content", - "id", - "metadataName", - "ownerName", - "permalink", - "title", - "type" + "metadata" ], "type": "object", "properties": { - "annotations": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "categories": { + "contributors": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ContributorVo" } }, - "content": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "exposed": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "metadataName": { - "type": "string" - }, - "ownerName": { - "type": "string" - }, - "permalink": { - "type": "string" - }, - "published": { - "type": "boolean" - }, - "recycled": { - "type": "boolean" + "metadata": { + "$ref": "#/components/schemas/Metadata" }, - "tags": { - "type": "array", - "items": { - "type": "string" - } + "owner": { + "$ref": "#/components/schemas/ContributorVo" }, - "title": { - "type": "string" + "spec": { + "$ref": "#/components/schemas/SinglePageSpec" }, - "type": { - "type": "string" + "stats": { + "$ref": "#/components/schemas/StatsVo" }, - "updateTimestamp": { - "type": "string", - "format": "date-time" + "status": { + "$ref": "#/components/schemas/SinglePageStatus" } - } - }, - "JsonPatch": { - "minItems": 1, - "uniqueItems": true, - "type": "array", - "description": "JSON schema for JSONPatch operations", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AddOperation" - }, - { - "$ref": "#/components/schemas/ReplaceOperation" - }, - { - "$ref": "#/components/schemas/TestOperation" - }, - { - "$ref": "#/components/schemas/RemoveOperation" - }, - { - "$ref": "#/components/schemas/MoveOperation" - }, - { - "$ref": "#/components/schemas/CopyOperation" - } - ] - } + }, + "description": "A chunk of items." }, - "ListResultReplyVo": { + "ListedSinglePageVoList": { "required": [ "first", "hasNext", @@ -1098,7 +2257,7 @@ "type": "array", "description": "A chunk of items.", "items": { - "$ref": "#/components/schemas/ReplyVo" + "$ref": "#/components/schemas/ListedSinglePageVo" } }, "last": { @@ -1324,6 +2483,20 @@ } } }, + "NavigationPostVo": { + "type": "object", + "properties": { + "current": { + "$ref": "#/components/schemas/PostVo" + }, + "next": { + "$ref": "#/components/schemas/PostVo" + }, + "previous": { + "$ref": "#/components/schemas/PostVo" + } + } + }, "OwnerInfo": { "type": "object", "properties": { @@ -1333,14 +2506,207 @@ "displayName": { "type": "string" }, - "email": { - "type": "string" + "email": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "PostSpec": { + "required": [ + "allowComment", + "deleted", + "excerpt", + "pinned", + "priority", + "publish", + "slug", + "title", + "visible" + ], + "type": "object", + "properties": { + "allowComment": { + "type": "boolean", + "default": true + }, + "baseSnapshot": { + "type": "string" + }, + "categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "cover": { + "type": "string" + }, + "deleted": { + "type": "boolean", + "default": false + }, + "excerpt": { + "$ref": "#/components/schemas/Excerpt" + }, + "headSnapshot": { + "type": "string" + }, + "htmlMetas": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "owner": { + "type": "string" + }, + "pinned": { + "type": "boolean", + "default": false + }, + "priority": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "publish": { + "type": "boolean", + "default": false + }, + "publishTime": { + "type": "string", + "format": "date-time" + }, + "releaseSnapshot": { + "type": "string" + }, + "slug": { + "minLength": 1, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "template": { + "type": "string" + }, + "title": { + "minLength": 1, + "type": "string" + }, + "visible": { + "type": "string", + "default": "PUBLIC", + "enum": [ + "PUBLIC", + "INTERNAL", + "PRIVATE" + ] + } + } + }, + "PostStatus": { + "type": "object", + "properties": { + "commentsCount": { + "type": "integer", + "format": "int32" + }, + "conditions": { + "type": "array", + "properties": { + "empty": { + "type": "boolean" + } + }, + "items": { + "$ref": "#/components/schemas/Condition" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "excerpt": { + "type": "string" + }, + "hideFromList": { + "type": "boolean" + }, + "inProgress": { + "type": "boolean" + }, + "lastModifyTime": { + "type": "string", + "format": "date-time" + }, + "observedVersion": { + "type": "integer", + "format": "int64" + }, + "permalink": { + "type": "string" + }, + "phase": { + "type": "string" + } + } + }, + "PostVo": { + "required": [ + "metadata" + ], + "type": "object", + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CategoryVo" + } + }, + "content": { + "$ref": "#/components/schemas/ContentVo" + }, + "contributors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContributorVo" + } + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "owner": { + "$ref": "#/components/schemas/ContributorVo" + }, + "spec": { + "$ref": "#/components/schemas/PostSpec" + }, + "stats": { + "$ref": "#/components/schemas/StatsVo" }, - "kind": { - "type": "string" + "status": { + "$ref": "#/components/schemas/PostStatus" }, - "name": { - "type": "string" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagVo" + } } } }, @@ -1718,6 +3084,175 @@ } } }, + "SinglePageSpec": { + "required": [ + "allowComment", + "deleted", + "excerpt", + "pinned", + "priority", + "publish", + "slug", + "title", + "visible" + ], + "type": "object", + "properties": { + "allowComment": { + "type": "boolean", + "default": true + }, + "baseSnapshot": { + "type": "string" + }, + "cover": { + "type": "string" + }, + "deleted": { + "type": "boolean", + "default": false + }, + "excerpt": { + "$ref": "#/components/schemas/Excerpt" + }, + "headSnapshot": { + "type": "string" + }, + "htmlMetas": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "owner": { + "type": "string" + }, + "pinned": { + "type": "boolean", + "default": false + }, + "priority": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "publish": { + "type": "boolean", + "default": false + }, + "publishTime": { + "type": "string", + "format": "date-time" + }, + "releaseSnapshot": { + "type": "string" + }, + "slug": { + "minLength": 1, + "type": "string" + }, + "template": { + "type": "string" + }, + "title": { + "minLength": 1, + "type": "string" + }, + "visible": { + "type": "string", + "default": "PUBLIC", + "enum": [ + "PUBLIC", + "INTERNAL", + "PRIVATE" + ] + } + } + }, + "SinglePageStatus": { + "type": "object", + "properties": { + "commentsCount": { + "type": "integer", + "format": "int32" + }, + "conditions": { + "type": "array", + "properties": { + "empty": { + "type": "boolean" + } + }, + "items": { + "$ref": "#/components/schemas/Condition" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "excerpt": { + "type": "string" + }, + "hideFromList": { + "type": "boolean" + }, + "inProgress": { + "type": "boolean" + }, + "lastModifyTime": { + "type": "string", + "format": "date-time" + }, + "observedVersion": { + "type": "integer", + "format": "int64" + }, + "permalink": { + "type": "string" + }, + "phase": { + "type": "string" + } + } + }, + "SinglePageVo": { + "required": [ + "metadata" + ], + "type": "object", + "properties": { + "content": { + "$ref": "#/components/schemas/ContentVo" + }, + "contributors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContributorVo" + } + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "owner": { + "$ref": "#/components/schemas/ContributorVo" + }, + "spec": { + "$ref": "#/components/schemas/SinglePageSpec" + }, + "stats": { + "$ref": "#/components/schemas/StatsVo" + }, + "status": { + "$ref": "#/components/schemas/SinglePageStatus" + } + } + }, "SiteStatsVo": { "type": "object", "properties": { @@ -1743,6 +3278,147 @@ } } }, + "StatsVo": { + "type": "object", + "properties": { + "comment": { + "type": "integer", + "format": "int32" + }, + "upvote": { + "type": "integer", + "format": "int32" + }, + "visit": { + "type": "integer", + "format": "int32" + } + } + }, + "TagSpec": { + "required": [ + "displayName", + "slug" + ], + "type": "object", + "properties": { + "color": { + "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$", + "type": "string" + }, + "cover": { + "type": "string" + }, + "displayName": { + "minLength": 1, + "type": "string" + }, + "slug": { + "minLength": 1, + "type": "string" + } + } + }, + "TagStatus": { + "type": "object", + "properties": { + "observedVersion": { + "type": "integer", + "format": "int64" + }, + "permalink": { + "type": "string" + }, + "postCount": { + "type": "integer", + "format": "int32" + }, + "visiblePostCount": { + "type": "integer", + "format": "int32" + } + } + }, + "TagVo": { + "required": [ + "metadata" + ], + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "postCount": { + "type": "integer", + "format": "int32" + }, + "spec": { + "$ref": "#/components/schemas/TagSpec" + }, + "status": { + "$ref": "#/components/schemas/TagStatus" + } + } + }, + "TagVoList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/TagVo" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, "TestOperation": { "required": [ "op", diff --git a/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json index b804cb96a8..a65865fb95 100644 --- a/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json +++ b/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json @@ -17,6 +17,353 @@ } ], "paths": { + "/apis/api.notification.halo.run/v1alpha1/notifiers/{name}/receiver-config": { + "get": { + "description": "Fetch receiver config of notifier", + "operationId": "FetchReceiverConfig", + "parameters": [ + { + "description": "Notifier name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "type": "object" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotifierV1alpha1Uc" + ] + }, + "post": { + "description": "Save receiver config of notifier", + "operationId": "SaveReceiverConfig", + "parameters": [ + { + "description": "Notifier name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": {}, + "description": "default response" + } + }, + "tags": [ + "NotifierV1alpha1Uc" + ] + } + }, + "/apis/api.notification.halo.run/v1alpha1/userspaces/{username}/notification-preferences": { + "get": { + "description": "List notification preferences for the authenticated user.", + "operationId": "ListUserNotificationPreferences", + "parameters": [ + { + "description": "Username", + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ReasonTypeNotifierMatrix" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Uc" + ] + }, + "post": { + "description": "Save notification preferences for the authenticated user.", + "operationId": "SaveUserNotificationPreferences", + "parameters": [ + { + "description": "Username", + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ReasonTypeNotifierCollectionRequest" + } + } + } + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ReasonTypeNotifierMatrix" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Uc" + ] + } + }, + "/apis/api.notification.halo.run/v1alpha1/userspaces/{username}/notifications": { + "get": { + "description": "List notifications for the authenticated user.", + "operationId": "ListUserNotifications", + "parameters": [ + { + "description": "Username", + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Page number. Default is 0.", + "in": "query", + "name": "page", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Size number. Default is 0.", + "in": "query", + "name": "size", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Label selector. e.g.: hidden!\u003dtrue", + "in": "query", + "name": "labelSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Field selector. e.g.: metadata.name\u003d\u003dhalo", + "in": "query", + "name": "fieldSelector", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in": "query", + "name": "sort", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NotificationList" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Uc" + ] + } + }, + "/apis/api.notification.halo.run/v1alpha1/userspaces/{username}/notifications/-/mark-specified-as-read": { + "put": { + "description": "Mark the specified notifications as read.", + "operationId": "MarkNotificationsAsRead", + "parameters": [ + { + "description": "Username", + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkSpecifiedRequest" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Uc" + ] + } + }, + "/apis/api.notification.halo.run/v1alpha1/userspaces/{username}/notifications/{name}": { + "delete": { + "description": "Delete the specified notification.", + "operationId": "DeleteSpecifiedNotification", + "parameters": [ + { + "description": "Username", + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Notification name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Uc" + ] + } + }, + "/apis/api.notification.halo.run/v1alpha1/userspaces/{username}/notifications/{name}/mark-as-read": { + "put": { + "description": "Mark the specified notification as read.", + "operationId": "MarkNotificationAsRead", + "parameters": [ + { + "description": "Username", + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Notification name", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + }, + "description": "default response" + } + }, + "tags": [ + "NotificationV1alpha1Uc" + ] + } + }, "/apis/uc.api.auth.halo.run/v1alpha1/user-connections/{registerId}/disconnect": { "put": { "description": "Disconnect my connection from a third-party platform.", @@ -1586,6 +1933,17 @@ } } }, + "MarkSpecifiedRequest": { + "type": "object", + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "Metadata": { "required": [ "name" @@ -1666,6 +2024,140 @@ } } }, + "Notification": { + "required": [ + "apiVersion", + "kind", + "metadata" + ], + "type": "object", + "properties": { + "apiVersion": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/Metadata" + }, + "spec": { + "$ref": "#/components/schemas/NotificationSpec" + } + } + }, + "NotificationList": { + "required": [ + "first", + "hasNext", + "hasPrevious", + "items", + "last", + "page", + "size", + "total", + "totalPages" + ], + "type": "object", + "properties": { + "first": { + "type": "boolean", + "description": "Indicates whether current page is the first page." + }, + "hasNext": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "hasPrevious": { + "type": "boolean", + "description": "Indicates whether current page has previous page." + }, + "items": { + "type": "array", + "description": "A chunk of items.", + "items": { + "$ref": "#/components/schemas/Notification" + } + }, + "last": { + "type": "boolean", + "description": "Indicates whether current page is the last page." + }, + "page": { + "type": "integer", + "description": "Page number, starts from 1. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "size": { + "type": "integer", + "description": "Size of each page. If not set or equal to 0, it means no pagination.", + "format": "int32" + }, + "total": { + "type": "integer", + "description": "Total elements.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Indicates total pages.", + "format": "int64" + } + } + }, + "NotificationSpec": { + "required": [ + "htmlContent", + "rawContent", + "reason", + "recipient", + "title" + ], + "type": "object", + "properties": { + "htmlContent": { + "type": "string" + }, + "lastReadAt": { + "type": "string", + "format": "date-time" + }, + "rawContent": { + "type": "string" + }, + "reason": { + "minLength": 1, + "type": "string", + "description": "The name of reason" + }, + "recipient": { + "minLength": 1, + "type": "string", + "description": "The name of user" + }, + "title": { + "minLength": 1, + "type": "string" + }, + "unread": { + "type": "boolean" + } + } + }, + "NotifierInfo": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, "Part": { "type": "object" }, @@ -1946,6 +2438,81 @@ } } }, + "ReasonTypeInfo": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "uiPermissions": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReasonTypeNotifierCollectionRequest": { + "required": [ + "reasonTypeNotifiers" + ], + "type": "object", + "properties": { + "reasonTypeNotifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReasonTypeNotifierRequest" + } + } + } + }, + "ReasonTypeNotifierMatrix": { + "type": "object", + "properties": { + "notifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotifierInfo" + } + }, + "reasonTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReasonTypeInfo" + } + }, + "stateMatrix": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "boolean" + } + } + } + } + }, + "ReasonTypeNotifierRequest": { + "type": "object", + "properties": { + "notifiers": { + "type": "array", + "items": { + "type": "string" + } + }, + "reasonType": { + "type": "string" + } + } + }, "Ref": { "required": [ "name" diff --git a/application/src/main/java/run/halo/app/infra/config/SwaggerConfig.java b/application/src/main/java/run/halo/app/infra/config/SwaggerConfig.java index 00337a47c6..e930901fa8 100644 --- a/application/src/main/java/run/halo/app/infra/config/SwaggerConfig.java +++ b/application/src/main/java/run/halo/app/infra/config/SwaggerConfig.java @@ -72,19 +72,25 @@ GroupedOpenApi aggregatedV1alpha1Api() { .pathsToMatch( "/apis/*/v1alpha1/**", "/api/v1alpha1/**", - "/login/**" + "/login/**", + "/system/setup" ) .build(); } - @Bean GroupedOpenApi publicV1alpha1Api() { return GroupedOpenApi.builder() .group("apis_public.api_v1alpha1") .displayName("Public API V1alpha1") .pathsToMatch( - "/apis/api.halo.run/**" + "/apis/api.*/**" + ) + .pathsToExclude( + "/apis/api.console.*/v1alpha1/**", + // compatible with legacy issues + "/apis/api.notification.halo.run/v1alpha1/userspaces/**", + "/apis/api.notification.halo.run/v1alpha1/notifiers/**" ) .build(); } @@ -108,7 +114,10 @@ GroupedOpenApi ucV1alpha1Api() { .group("apis_uc.api_v1alpha1") .displayName("User-center API V1alpha1") .pathsToMatch( - "/apis/uc.api.*/v1alpha1/**" + "/apis/uc.api.*/v1alpha1/**", + // compatible with legacy issues + "/apis/api.notification.halo.run/v1alpha1/userspaces/**", + "/apis/api.notification.halo.run/v1alpha1/notifiers/**" ) .build(); } @@ -128,7 +137,9 @@ GroupedOpenApi extensionV1alpha1Api() { "/apis/auth.halo.run/v1alpha1/**", "/apis/metrics.halo.run/v1alpha1/**", "/apis/storage.halo.run/v1alpha1/**", - "/apis/plugin.halo.run/v1alpha1/**" + "/apis/plugin.halo.run/v1alpha1/**", + "/apis/notification.halo.run/**", + "/apis/migration.halo.run/**" ) .build(); } diff --git a/application/src/main/java/run/halo/app/notification/endpoint/SubscriptionRouter.java b/application/src/main/java/run/halo/app/notification/endpoint/SubscriptionRouter.java index 7344613ab0..e577cfac66 100644 --- a/application/src/main/java/run/halo/app/notification/endpoint/SubscriptionRouter.java +++ b/application/src/main/java/run/halo/app/notification/endpoint/SubscriptionRouter.java @@ -39,10 +39,11 @@ public class SubscriptionRouter { @Bean RouterFunction notificationSubscriptionRouter() { + final var tag = "NotificationV1alpha1Public"; return SpringdocRouteBuilder.route() .GET(UNSUBSCRIBE_PATTERN, this::unsubscribe, builder -> { builder.operationId("Unsubscribe") - .tag("api.notification.halo.run/v1alpha1/Subscription") + .tag(tag) .description("Unsubscribe a subscription") .parameter(parameterBuilder() .in(ParameterIn.PATH) diff --git a/application/src/main/java/run/halo/app/security/preauth/SystemSetupEndpoint.java b/application/src/main/java/run/halo/app/security/preauth/SystemSetupEndpoint.java index d622b4479f..cbf2d8f365 100644 --- a/application/src/main/java/run/halo/app/security/preauth/SystemSetupEndpoint.java +++ b/application/src/main/java/run/halo/app/security/preauth/SystemSetupEndpoint.java @@ -3,7 +3,9 @@ import static io.r2dbc.spi.ConnectionFactoryOptions.DRIVER; import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED; import static org.springdoc.core.fn.builders.apiresponse.Builder.responseBuilder; +import static org.springdoc.core.fn.builders.content.Builder.contentBuilder; import static org.springdoc.core.fn.builders.requestbody.Builder.requestBodyBuilder; +import static org.springdoc.core.fn.builders.schema.Builder.schemaBuilder; import static org.springframework.web.reactive.function.server.RequestPredicates.accept; import static org.springframework.web.reactive.function.server.RequestPredicates.contentType; import static org.springframework.web.reactive.function.server.RequestPredicates.path; @@ -85,7 +87,7 @@ public class SystemSetupEndpoint { @Bean RouterFunction setupPageRouter() { - final var tag = "System"; + final var tag = "SystemV1alpha1Public"; return SpringdocRouteBuilder.route() .GET(path("/system/setup").and(accept(MediaType.TEXT_HTML)), this::setupPage, builder -> builder.operationId("JumpToSetupPage") @@ -103,9 +105,11 @@ RouterFunction setupPageRouter() { .description("Setup system") .tag(tag) .requestBody(requestBodyBuilder() - .implementation(SetupRequest.class) - .content(Builder.contentBuilder() - .mediaType(MediaType.APPLICATION_FORM_URLENCODED_VALUE) + .required(true) + .content(contentBuilder() + .mediaType(MediaType.APPLICATION_JSON_VALUE) + .schema(schemaBuilder() + .implementation(SetupRequest.class)) ) ) .response(responseBuilder() diff --git a/ui/packages/api-client/entry/api-client.ts b/ui/packages/api-client/entry/api-client.ts index 4cae6d0436..abfb44573d 100644 --- a/ui/packages/api-client/entry/api-client.ts +++ b/ui/packages/api-client/entry/api-client.ts @@ -26,6 +26,7 @@ import { MigrationV1alpha1ConsoleApi, NotificationTemplateV1alpha1Api, NotificationV1alpha1Api, + NotificationV1alpha1PublicApi, NotificationV1alpha1UcApi, NotifierDescriptorV1alpha1Api, NotifierV1alpha1ConsoleApi, @@ -435,6 +436,11 @@ function createPublicApiClient(axiosInstance: AxiosInstance) { metrics: { metrics: new MetricsV1alpha1PublicApi(undefined, baseURL, axiosInstance), }, + notification: new NotificationV1alpha1PublicApi( + undefined, + baseURL, + axiosInstance + ), }; } diff --git a/ui/packages/api-client/src/.openapi-generator/FILES b/ui/packages/api-client/src/.openapi-generator/FILES index 90d1b4d591..cc42c1c805 100644 --- a/ui/packages/api-client/src/.openapi-generator/FILES +++ b/ui/packages/api-client/src/.openapi-generator/FILES @@ -3,7 +3,6 @@ .openapi-generator-ignore api.ts api/annotation-setting-v1alpha1-api.ts -api/api-notification-halo-run-v1alpha1-subscription-api.ts api/attachment-v1alpha1-api.ts api/attachment-v1alpha1-console-api.ts api/attachment-v1alpha1-uc-api.ts @@ -17,6 +16,7 @@ api/comment-v1alpha1-console-api.ts api/comment-v1alpha1-public-api.ts api/config-map-v1alpha1-api.ts api/counter-v1alpha1-api.ts +api/default-api.ts api/device-v1alpha1-api.ts api/device-v1alpha1-uc-api.ts api/extension-definition-v1alpha1-api.ts @@ -32,6 +32,7 @@ api/metrics-v1alpha1-public-api.ts api/migration-v1alpha1-console-api.ts api/notification-template-v1alpha1-api.ts api/notification-v1alpha1-api.ts +api/notification-v1alpha1-public-api.ts api/notification-v1alpha1-uc-api.ts api/notifier-descriptor-v1alpha1-api.ts api/notifier-v1alpha1-console-api.ts diff --git a/ui/packages/api-client/src/api.ts b/ui/packages/api-client/src/api.ts index 3a4af9afb5..a2b1159d2a 100644 --- a/ui/packages/api-client/src/api.ts +++ b/ui/packages/api-client/src/api.ts @@ -15,7 +15,6 @@ export * from './api/annotation-setting-v1alpha1-api'; -export * from './api/api-notification-halo-run-v1alpha1-subscription-api'; export * from './api/attachment-v1alpha1-api'; export * from './api/attachment-v1alpha1-console-api'; export * from './api/attachment-v1alpha1-uc-api'; @@ -29,6 +28,7 @@ export * from './api/comment-v1alpha1-console-api'; export * from './api/comment-v1alpha1-public-api'; export * from './api/config-map-v1alpha1-api'; export * from './api/counter-v1alpha1-api'; +export * from './api/default-api'; export * from './api/device-v1alpha1-api'; export * from './api/device-v1alpha1-uc-api'; export * from './api/extension-definition-v1alpha1-api'; @@ -44,6 +44,7 @@ export * from './api/metrics-v1alpha1-public-api'; export * from './api/migration-v1alpha1-console-api'; export * from './api/notification-template-v1alpha1-api'; export * from './api/notification-v1alpha1-api'; +export * from './api/notification-v1alpha1-public-api'; export * from './api/notification-v1alpha1-uc-api'; export * from './api/notifier-descriptor-v1alpha1-api'; export * from './api/notifier-v1alpha1-console-api'; diff --git a/ui/packages/api-client/src/api/default-api.ts b/ui/packages/api-client/src/api/default-api.ts new file mode 100644 index 0000000000..0c7914d1d3 --- /dev/null +++ b/ui/packages/api-client/src/api/default-api.ts @@ -0,0 +1,126 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Halo + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 2.20.0-SNAPSHOT + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; +/** + * DefaultApi - axios parameter creator + * @export + */ +export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setNoCacheForSetUpPage: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/system/setup`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication basicAuth required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + // authentication bearerAuth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * DefaultApi - functional programming interface + * @export + */ +export const DefaultApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) + return { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async setNoCacheForSetUpPage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setNoCacheForSetUpPage(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.setNoCacheForSetUpPage']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DefaultApi - factory interface + * @export + */ +export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DefaultApiFp(configuration) + return { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setNoCacheForSetUpPage(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setNoCacheForSetUpPage(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DefaultApi - object-oriented interface + * @export + * @class DefaultApi + * @extends {BaseAPI} + */ +export class DefaultApi extends BaseAPI { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public setNoCacheForSetUpPage(options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).setNoCacheForSetUpPage(options).then((request) => request(this.axios, this.basePath)); + } +} + diff --git a/ui/packages/api-client/src/api/api-notification-halo-run-v1alpha1-subscription-api.ts b/ui/packages/api-client/src/api/notification-v1alpha1-public-api.ts similarity index 67% rename from ui/packages/api-client/src/api/api-notification-halo-run-v1alpha1-subscription-api.ts rename to ui/packages/api-client/src/api/notification-v1alpha1-public-api.ts index 5b1612ed7c..18830ddfac 100644 --- a/ui/packages/api-client/src/api/api-notification-halo-run-v1alpha1-subscription-api.ts +++ b/ui/packages/api-client/src/api/notification-v1alpha1-public-api.ts @@ -22,10 +22,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; /** - * ApiNotificationHaloRunV1alpha1SubscriptionApi - axios parameter creator + * NotificationV1alpha1PublicApi - axios parameter creator * @export */ -export const ApiNotificationHaloRunV1alpha1SubscriptionApiAxiosParamCreator = function (configuration?: Configuration) { +export const NotificationV1alpha1PublicApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Unsubscribe a subscription @@ -79,11 +79,11 @@ export const ApiNotificationHaloRunV1alpha1SubscriptionApiAxiosParamCreator = fu }; /** - * ApiNotificationHaloRunV1alpha1SubscriptionApi - functional programming interface + * NotificationV1alpha1PublicApi - functional programming interface * @export */ -export const ApiNotificationHaloRunV1alpha1SubscriptionApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApiNotificationHaloRunV1alpha1SubscriptionApiAxiosParamCreator(configuration) +export const NotificationV1alpha1PublicApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = NotificationV1alpha1PublicApiAxiosParamCreator(configuration) return { /** * Unsubscribe a subscription @@ -95,68 +95,68 @@ export const ApiNotificationHaloRunV1alpha1SubscriptionApiFp = function(configur async unsubscribe(name: string, token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.unsubscribe(name, token, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApiNotificationHaloRunV1alpha1SubscriptionApi.unsubscribe']?.[localVarOperationServerIndex]?.url; + const localVarOperationServerBasePath = operationServerMap['NotificationV1alpha1PublicApi.unsubscribe']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** - * ApiNotificationHaloRunV1alpha1SubscriptionApi - factory interface + * NotificationV1alpha1PublicApi - factory interface * @export */ -export const ApiNotificationHaloRunV1alpha1SubscriptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApiNotificationHaloRunV1alpha1SubscriptionApiFp(configuration) +export const NotificationV1alpha1PublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = NotificationV1alpha1PublicApiFp(configuration) return { /** * Unsubscribe a subscription - * @param {ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest} requestParameters Request parameters. + * @param {NotificationV1alpha1PublicApiUnsubscribeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unsubscribe(requestParameters: ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest, options?: RawAxiosRequestConfig): AxiosPromise { + unsubscribe(requestParameters: NotificationV1alpha1PublicApiUnsubscribeRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.unsubscribe(requestParameters.name, requestParameters.token, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for unsubscribe operation in ApiNotificationHaloRunV1alpha1SubscriptionApi. + * Request parameters for unsubscribe operation in NotificationV1alpha1PublicApi. * @export - * @interface ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest + * @interface NotificationV1alpha1PublicApiUnsubscribeRequest */ -export interface ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest { +export interface NotificationV1alpha1PublicApiUnsubscribeRequest { /** * Subscription name * @type {string} - * @memberof ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribe + * @memberof NotificationV1alpha1PublicApiUnsubscribe */ readonly name: string /** * Unsubscribe token * @type {string} - * @memberof ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribe + * @memberof NotificationV1alpha1PublicApiUnsubscribe */ readonly token: string } /** - * ApiNotificationHaloRunV1alpha1SubscriptionApi - object-oriented interface + * NotificationV1alpha1PublicApi - object-oriented interface * @export - * @class ApiNotificationHaloRunV1alpha1SubscriptionApi + * @class NotificationV1alpha1PublicApi * @extends {BaseAPI} */ -export class ApiNotificationHaloRunV1alpha1SubscriptionApi extends BaseAPI { +export class NotificationV1alpha1PublicApi extends BaseAPI { /** * Unsubscribe a subscription - * @param {ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest} requestParameters Request parameters. + * @param {NotificationV1alpha1PublicApiUnsubscribeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ApiNotificationHaloRunV1alpha1SubscriptionApi + * @memberof NotificationV1alpha1PublicApi */ - public unsubscribe(requestParameters: ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest, options?: RawAxiosRequestConfig) { - return ApiNotificationHaloRunV1alpha1SubscriptionApiFp(this.configuration).unsubscribe(requestParameters.name, requestParameters.token, options).then((request) => request(this.axios, this.basePath)); + public unsubscribe(requestParameters: NotificationV1alpha1PublicApiUnsubscribeRequest, options?: RawAxiosRequestConfig) { + return NotificationV1alpha1PublicApiFp(this.configuration).unsubscribe(requestParameters.name, requestParameters.token, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/ui/packages/api-client/src/api/system-v1alpha1-public-api.ts b/ui/packages/api-client/src/api/system-v1alpha1-public-api.ts index f6367f2c5a..88b47ab9ca 100644 --- a/ui/packages/api-client/src/api/system-v1alpha1-public-api.ts +++ b/ui/packages/api-client/src/api/system-v1alpha1-public-api.ts @@ -29,6 +29,43 @@ import { SiteStatsVo } from '../models'; */ export const SystemV1alpha1PublicApiAxiosParamCreator = function (configuration?: Configuration) { return { + /** + * Jump to setup page + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + jumpToSetupPage: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/system/setup`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication basicAuth required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + // authentication bearerAuth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * Gets site stats * @param {*} [options] Override http request option. @@ -76,6 +113,17 @@ export const SystemV1alpha1PublicApiAxiosParamCreator = function (configuration? export const SystemV1alpha1PublicApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = SystemV1alpha1PublicApiAxiosParamCreator(configuration) return { + /** + * Jump to setup page + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async jumpToSetupPage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.jumpToSetupPage(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SystemV1alpha1PublicApi.jumpToSetupPage']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Gets site stats * @param {*} [options] Override http request option. @@ -97,6 +145,14 @@ export const SystemV1alpha1PublicApiFp = function(configuration?: Configuration) export const SystemV1alpha1PublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = SystemV1alpha1PublicApiFp(configuration) return { + /** + * Jump to setup page + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + jumpToSetupPage(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.jumpToSetupPage(options).then((request) => request(axios, basePath)); + }, /** * Gets site stats * @param {*} [options] Override http request option. @@ -115,6 +171,16 @@ export const SystemV1alpha1PublicApiFactory = function (configuration?: Configur * @extends {BaseAPI} */ export class SystemV1alpha1PublicApi extends BaseAPI { + /** + * Jump to setup page + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SystemV1alpha1PublicApi + */ + public jumpToSetupPage(options?: RawAxiosRequestConfig) { + return SystemV1alpha1PublicApiFp(this.configuration).jumpToSetupPage(options).then((request) => request(this.axios, this.basePath)); + } + /** * Gets site stats * @param {*} [options] Override http request option.