{ "openapi": "3.0.1", "info": { "title": "Halo Next API", "version": "2.0.0" }, "servers": [ { "url": "http://localhost:8091", "description": "Generated server url" } ], "security": [ { "BasicAuth": [], "BearerAuth": [] } ], "paths": { "/api/v1alpha1/annotationsettings": { "get": { "description": "List v1alpha1/AnnotationSetting", "operationId": "List/v1alpha1/AnnotationSetting", "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/AnnotationSettingList" } } }, "description": "Response annotationsettings" } }, "tags": [ "v1alpha1/AnnotationSetting" ] }, "post": { "description": "Create v1alpha1/AnnotationSetting", "operationId": "Create/v1alpha1/AnnotationSetting", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AnnotationSetting" } } }, "description": "Fresh annotationsetting" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AnnotationSetting" } } }, "description": "Response annotationsettings created just now" } }, "tags": [ "v1alpha1/AnnotationSetting" ] } }, "/api/v1alpha1/annotationsettings/{name}": { "delete": { "description": "Delete v1alpha1/AnnotationSetting", "operationId": "Delete/v1alpha1/AnnotationSetting", "parameters": [ { "description": "Name of annotationsetting", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response annotationsetting deleted just now" } }, "tags": [ "v1alpha1/AnnotationSetting" ] }, "get": { "description": "Get v1alpha1/AnnotationSetting", "operationId": "Get/v1alpha1/AnnotationSetting", "parameters": [ { "description": "Name of annotationsetting", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AnnotationSetting" } } }, "description": "Response single annotationsetting" } }, "tags": [ "v1alpha1/AnnotationSetting" ] }, "put": { "description": "Update v1alpha1/AnnotationSetting", "operationId": "Update/v1alpha1/AnnotationSetting", "parameters": [ { "description": "Name of annotationsetting", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AnnotationSetting" } } }, "description": "Updated annotationsetting" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AnnotationSetting" } } }, "description": "Response annotationsettings updated just now" } }, "tags": [ "v1alpha1/AnnotationSetting" ] } }, "/api/v1alpha1/configmaps": { "get": { "description": "List v1alpha1/ConfigMap", "operationId": "List/v1alpha1/ConfigMap", "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/ConfigMapList" } } }, "description": "Response configmaps" } }, "tags": [ "v1alpha1/ConfigMap" ] }, "post": { "description": "Create v1alpha1/ConfigMap", "operationId": "Create/v1alpha1/ConfigMap", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "Fresh configmap" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "Response configmaps created just now" } }, "tags": [ "v1alpha1/ConfigMap" ] } }, "/api/v1alpha1/configmaps/{name}": { "delete": { "description": "Delete v1alpha1/ConfigMap", "operationId": "Delete/v1alpha1/ConfigMap", "parameters": [ { "description": "Name of configmap", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response configmap deleted just now" } }, "tags": [ "v1alpha1/ConfigMap" ] }, "get": { "description": "Get v1alpha1/ConfigMap", "operationId": "Get/v1alpha1/ConfigMap", "parameters": [ { "description": "Name of configmap", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "Response single configmap" } }, "tags": [ "v1alpha1/ConfigMap" ] }, "put": { "description": "Update v1alpha1/ConfigMap", "operationId": "Update/v1alpha1/ConfigMap", "parameters": [ { "description": "Name of configmap", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "Updated configmap" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "Response configmaps updated just now" } }, "tags": [ "v1alpha1/ConfigMap" ] } }, "/api/v1alpha1/menuitems": { "get": { "description": "List v1alpha1/MenuItem", "operationId": "List/v1alpha1/MenuItem", "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/MenuItemList" } } }, "description": "Response menuitems" } }, "tags": [ "v1alpha1/MenuItem" ] }, "post": { "description": "Create v1alpha1/MenuItem", "operationId": "Create/v1alpha1/MenuItem", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MenuItem" } } }, "description": "Fresh menuitem" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MenuItem" } } }, "description": "Response menuitems created just now" } }, "tags": [ "v1alpha1/MenuItem" ] } }, "/api/v1alpha1/menuitems/{name}": { "delete": { "description": "Delete v1alpha1/MenuItem", "operationId": "Delete/v1alpha1/MenuItem", "parameters": [ { "description": "Name of menuitem", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response menuitem deleted just now" } }, "tags": [ "v1alpha1/MenuItem" ] }, "get": { "description": "Get v1alpha1/MenuItem", "operationId": "Get/v1alpha1/MenuItem", "parameters": [ { "description": "Name of menuitem", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MenuItem" } } }, "description": "Response single menuitem" } }, "tags": [ "v1alpha1/MenuItem" ] }, "put": { "description": "Update v1alpha1/MenuItem", "operationId": "Update/v1alpha1/MenuItem", "parameters": [ { "description": "Name of menuitem", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MenuItem" } } }, "description": "Updated menuitem" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MenuItem" } } }, "description": "Response menuitems updated just now" } }, "tags": [ "v1alpha1/MenuItem" ] } }, "/api/v1alpha1/menus": { "get": { "description": "List v1alpha1/Menu", "operationId": "List/v1alpha1/Menu", "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/MenuList" } } }, "description": "Response menus" } }, "tags": [ "v1alpha1/Menu" ] }, "post": { "description": "Create v1alpha1/Menu", "operationId": "Create/v1alpha1/Menu", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Menu" } } }, "description": "Fresh menu" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Menu" } } }, "description": "Response menus created just now" } }, "tags": [ "v1alpha1/Menu" ] } }, "/api/v1alpha1/menus/{name}": { "delete": { "description": "Delete v1alpha1/Menu", "operationId": "Delete/v1alpha1/Menu", "parameters": [ { "description": "Name of menu", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response menu deleted just now" } }, "tags": [ "v1alpha1/Menu" ] }, "get": { "description": "Get v1alpha1/Menu", "operationId": "Get/v1alpha1/Menu", "parameters": [ { "description": "Name of menu", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Menu" } } }, "description": "Response single menu" } }, "tags": [ "v1alpha1/Menu" ] }, "put": { "description": "Update v1alpha1/Menu", "operationId": "Update/v1alpha1/Menu", "parameters": [ { "description": "Name of menu", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Menu" } } }, "description": "Updated menu" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Menu" } } }, "description": "Response menus updated just now" } }, "tags": [ "v1alpha1/Menu" ] } }, "/api/v1alpha1/rolebindings": { "get": { "description": "List v1alpha1/RoleBinding", "operationId": "List/v1alpha1/RoleBinding", "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/RoleBindingList" } } }, "description": "Response rolebindings" } }, "tags": [ "v1alpha1/RoleBinding" ] }, "post": { "description": "Create v1alpha1/RoleBinding", "operationId": "Create/v1alpha1/RoleBinding", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RoleBinding" } } }, "description": "Fresh rolebinding" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RoleBinding" } } }, "description": "Response rolebindings created just now" } }, "tags": [ "v1alpha1/RoleBinding" ] } }, "/api/v1alpha1/rolebindings/{name}": { "delete": { "description": "Delete v1alpha1/RoleBinding", "operationId": "Delete/v1alpha1/RoleBinding", "parameters": [ { "description": "Name of rolebinding", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response rolebinding deleted just now" } }, "tags": [ "v1alpha1/RoleBinding" ] }, "get": { "description": "Get v1alpha1/RoleBinding", "operationId": "Get/v1alpha1/RoleBinding", "parameters": [ { "description": "Name of rolebinding", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RoleBinding" } } }, "description": "Response single rolebinding" } }, "tags": [ "v1alpha1/RoleBinding" ] }, "put": { "description": "Update v1alpha1/RoleBinding", "operationId": "Update/v1alpha1/RoleBinding", "parameters": [ { "description": "Name of rolebinding", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RoleBinding" } } }, "description": "Updated rolebinding" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RoleBinding" } } }, "description": "Response rolebindings updated just now" } }, "tags": [ "v1alpha1/RoleBinding" ] } }, "/api/v1alpha1/roles": { "get": { "description": "List v1alpha1/Role", "operationId": "List/v1alpha1/Role", "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/RoleList" } } }, "description": "Response roles" } }, "tags": [ "v1alpha1/Role" ] }, "post": { "description": "Create v1alpha1/Role", "operationId": "Create/v1alpha1/Role", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } }, "description": "Fresh role" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } }, "description": "Response roles created just now" } }, "tags": [ "v1alpha1/Role" ] } }, "/api/v1alpha1/roles/{name}": { "delete": { "description": "Delete v1alpha1/Role", "operationId": "Delete/v1alpha1/Role", "parameters": [ { "description": "Name of role", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response role deleted just now" } }, "tags": [ "v1alpha1/Role" ] }, "get": { "description": "Get v1alpha1/Role", "operationId": "Get/v1alpha1/Role", "parameters": [ { "description": "Name of role", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } }, "description": "Response single role" } }, "tags": [ "v1alpha1/Role" ] }, "put": { "description": "Update v1alpha1/Role", "operationId": "Update/v1alpha1/Role", "parameters": [ { "description": "Name of role", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } }, "description": "Updated role" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } }, "description": "Response roles updated just now" } }, "tags": [ "v1alpha1/Role" ] } }, "/api/v1alpha1/secrets": { "get": { "description": "List v1alpha1/Secret", "operationId": "List/v1alpha1/Secret", "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/SecretList" } } }, "description": "Response secrets" } }, "tags": [ "v1alpha1/Secret" ] }, "post": { "description": "Create v1alpha1/Secret", "operationId": "Create/v1alpha1/Secret", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "Fresh secret" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "Response secrets created just now" } }, "tags": [ "v1alpha1/Secret" ] } }, "/api/v1alpha1/secrets/{name}": { "delete": { "description": "Delete v1alpha1/Secret", "operationId": "Delete/v1alpha1/Secret", "parameters": [ { "description": "Name of secret", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response secret deleted just now" } }, "tags": [ "v1alpha1/Secret" ] }, "get": { "description": "Get v1alpha1/Secret", "operationId": "Get/v1alpha1/Secret", "parameters": [ { "description": "Name of secret", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "Response single secret" } }, "tags": [ "v1alpha1/Secret" ] }, "put": { "description": "Update v1alpha1/Secret", "operationId": "Update/v1alpha1/Secret", "parameters": [ { "description": "Name of secret", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "Updated secret" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "Response secrets updated just now" } }, "tags": [ "v1alpha1/Secret" ] } }, "/api/v1alpha1/settings": { "get": { "description": "List v1alpha1/Setting", "operationId": "List/v1alpha1/Setting", "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/SettingList" } } }, "description": "Response settings" } }, "tags": [ "v1alpha1/Setting" ] }, "post": { "description": "Create v1alpha1/Setting", "operationId": "Create/v1alpha1/Setting", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "Fresh setting" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "Response settings created just now" } }, "tags": [ "v1alpha1/Setting" ] } }, "/api/v1alpha1/settings/{name}": { "delete": { "description": "Delete v1alpha1/Setting", "operationId": "Delete/v1alpha1/Setting", "parameters": [ { "description": "Name of setting", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response setting deleted just now" } }, "tags": [ "v1alpha1/Setting" ] }, "get": { "description": "Get v1alpha1/Setting", "operationId": "Get/v1alpha1/Setting", "parameters": [ { "description": "Name of setting", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "Response single setting" } }, "tags": [ "v1alpha1/Setting" ] }, "put": { "description": "Update v1alpha1/Setting", "operationId": "Update/v1alpha1/Setting", "parameters": [ { "description": "Name of setting", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "Updated setting" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "Response settings updated just now" } }, "tags": [ "v1alpha1/Setting" ] } }, "/api/v1alpha1/users": { "get": { "description": "List v1alpha1/User", "operationId": "List/v1alpha1/User", "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/UserList" } } }, "description": "Response users" } }, "tags": [ "v1alpha1/User" ] }, "post": { "description": "Create v1alpha1/User", "operationId": "Create/v1alpha1/User", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Fresh user" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Response users created just now" } }, "tags": [ "v1alpha1/User" ] } }, "/api/v1alpha1/users/{name}": { "delete": { "description": "Delete v1alpha1/User", "operationId": "Delete/v1alpha1/User", "parameters": [ { "description": "Name of user", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response user deleted just now" } }, "tags": [ "v1alpha1/User" ] }, "get": { "description": "Get v1alpha1/User", "operationId": "Get/v1alpha1/User", "parameters": [ { "description": "Name of user", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Response single user" } }, "tags": [ "v1alpha1/User" ] }, "put": { "description": "Update v1alpha1/User", "operationId": "Update/v1alpha1/User", "parameters": [ { "description": "Name of user", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Updated user" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Response users updated just now" } }, "tags": [ "v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/attachments": { "get": { "operationId": "SearchAttachments", "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" } } }, { "description": "Filter attachments without group. This parameter will ignore group parameter.", "in": "query", "name": "ungrouped", "schema": { "type": "boolean" } }, { "description": "Keyword for searching.", "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "description": "Acceptable media types.", "in": "query", "name": "accepts", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AttachmentList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Attachment" ] } }, "/apis/api.console.halo.run/v1alpha1/attachments/upload": { "post": { "operationId": "UploadAttachment", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IUploadRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Attachment" ] } }, "/apis/api.console.halo.run/v1alpha1/auth-providers": { "get": { "description": "Lists all auth providers", "operationId": "listAuthProviders", "responses": { "default": { "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListedAuthProvider" } } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/AuthProvider" ] } }, "/apis/api.console.halo.run/v1alpha1/auth-providers/{name}/disable": { "put": { "description": "Disables an auth provider", "operationId": "disableAuthProvider", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/AuthProvider" ] } }, "/apis/api.console.halo.run/v1alpha1/auth-providers/{name}/enable": { "put": { "description": "Enables an auth provider", "operationId": "enableAuthProvider", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/AuthProvider" ] } }, "/apis/api.console.halo.run/v1alpha1/caches/{name}": { "delete": { "description": "Evict a cache.", "operationId": "EvictCache", "parameters": [ { "description": "Cache name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "v1alpha1/Cache" ] } }, "/apis/api.console.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": "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" } } }, { "description": "Comments filtered by keyword.", "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "description": "Commenter kind.", "in": "query", "name": "ownerKind", "schema": { "type": "string" } }, { "description": "Commenter name.", "in": "query", "name": "ownerName", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListedCommentList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Comment" ] }, "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": [ "api.console.halo.run/v1alpha1/Comment" ] } }, "/apis/api.console.halo.run/v1alpha1/comments/{name}/reply": { "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": [ "api.console.halo.run/v1alpha1/Comment" ] } }, "/apis/api.console.halo.run/v1alpha1/indices/post": { "post": { "description": "Build or rebuild post indices for full text search", "operationId": "BuildPostIndices", "responses": {}, "tags": [ "api.console.halo.run/v1alpha1/Indices" ] } }, "/apis/api.console.halo.run/v1alpha1/notifiers/{name}/sender-config": { "get": { "description": "Fetch sender config of notifier", "operationId": "FetchSenderConfig", "parameters": [ { "description": "Notifier name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "type": "object" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Notifier" ] }, "post": { "description": "Save sender config of notifier", "operationId": "SaveSenderConfig", "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": [ "api.console.halo.run/v1alpha1/Notifier" ] } }, "/apis/api.console.halo.run/v1alpha1/plugin-presets": { "get": { "description": "List all plugin presets in the system.", "operationId": "ListPluginPresets", "responses": { "default": { "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins": { "get": { "description": "List plugins using query criteria and sort params", "operationId": "ListPlugins", "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" } } }, { "description": "Keyword of plugin name or description", "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "description": "Whether the plugin is enabled", "in": "query", "name": "enabled", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PluginList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/-/bundle.css": { "get": { "description": "Merge all CSS bundles of enabled plugins into one.", "operationId": "fetchCssBundle", "responses": { "default": { "content": { "*/*": { "schema": { "type": "string" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/-/bundle.js": { "get": { "description": "Merge all JS bundles of enabled plugins into one.", "operationId": "fetchJsBundle", "responses": { "default": { "content": { "*/*": { "schema": { "type": "string" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/-/install-from-uri": { "post": { "description": "Install a plugin from uri.", "operationId": "InstallPluginFromUri", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallFromUriRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/install": { "post": { "description": "Install a plugin by uploading a Jar file.", "operationId": "InstallPlugin", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PluginInstallRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/config": { "get": { "description": "Fetch configMap of plugin by configured configMapName.", "operationId": "fetchPluginConfig", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] }, "put": { "description": "Update the configMap of plugin setting.", "operationId": "updatePluginConfig", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/plugin-state": { "put": { "description": "Change the running state of a plugin by name.", "operationId": "ChangePluginRunningState", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginRunningStateRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/reload": { "put": { "description": "Reload a plugin by name.", "operationId": "reloadPlugin", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/reset-config": { "put": { "description": "Reset the configMap of plugin setting.", "operationId": "ResetPluginConfig", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/setting": { "get": { "description": "Fetch setting of plugin.", "operationId": "fetchPluginSetting", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/upgrade": { "post": { "description": "Upgrade a plugin by uploading a Jar file", "operationId": "UpgradePlugin", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PluginInstallRequest" } } }, "required": true }, "responses": {}, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/plugins/{name}/upgrade-from-uri": { "post": { "description": "Upgrade a plugin from uri.", "operationId": "UpgradePluginFromUri", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeFromUriRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.console.halo.run/v1alpha1/posts": { "get": { "description": "List posts.", "operationId": "ListPosts", "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" } } }, { "description": "Posts filtered by publish phase.", "in": "query", "name": "publishPhase", "schema": { "type": "string", "enum": [ "DRAFT", "PENDING_APPROVAL", "PUBLISHED", "FAILED" ] } }, { "description": "Posts filtered by keyword.", "in": "query", "name": "keyword", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListedPostList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] }, "post": { "description": "Draft a post.", "operationId": "DraftPost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}": { "put": { "description": "Update a post.", "operationId": "UpdateDraftPost", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/content": { "delete": { "description": "Delete a content for post.", "operationId": "deletePostContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "snapshotName", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] }, "get": { "description": "Fetch content of post.", "operationId": "fetchPostContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "snapshotName", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] }, "put": { "description": "Update a post\u0027s content.", "operationId": "UpdatePostContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Content" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/head-content": { "get": { "description": "Fetch head content of post.", "operationId": "fetchPostHeadContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/publish": { "put": { "description": "Publish a post.", "operationId": "PublishPost", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Head snapshot name of content.", "in": "query", "name": "headSnapshot", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/recycle": { "put": { "description": "Recycle a post.", "operationId": "RecyclePost", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": {}, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/release-content": { "get": { "description": "Fetch release content of post.", "operationId": "fetchPostReleaseContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/revert-content": { "put": { "description": "Revert to specified snapshot for post content.", "operationId": "revertToSpecifiedSnapshotForPost", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevertSnapshotForPostParam" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/snapshot": { "get": { "description": "List all snapshots for post content.", "operationId": "listPostSnapshots", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListedSnapshotDto" } } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/posts/{name}/unpublish": { "put": { "description": "Publish a post.", "operationId": "UnpublishPost", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Post" ] } }, "/apis/api.console.halo.run/v1alpha1/replies": { "get": { "description": "List replies.", "operationId": "ListReplies", "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" } } }, { "description": "Replies filtered by commentName.", "in": "query", "name": "commentName", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListedReplyList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Reply" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages": { "get": { "description": "List single pages.", "operationId": "ListSinglePages", "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" } } }, { "description": "SinglePages filtered by contributor.", "in": "query", "name": "contributor", "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "SinglePages filtered by publish phase.", "in": "query", "name": "publishPhase", "schema": { "type": "string", "enum": [ "DRAFT", "PENDING_APPROVAL", "PUBLISHED", "FAILED" ] } }, { "description": "SinglePages filtered by visibility.", "in": "query", "name": "visible", "schema": { "type": "string", "enum": [ "PUBLIC", "INTERNAL", "PRIVATE" ] } }, { "description": "SinglePages filtered by keyword.", "in": "query", "name": "keyword", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListedSinglePageList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] }, "post": { "description": "Draft a single page.", "operationId": "DraftSinglePage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SinglePageRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}": { "put": { "description": "Update a single page.", "operationId": "UpdateDraftSinglePage", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SinglePageRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}/content": { "delete": { "description": "Delete a content for post.", "operationId": "deleteSinglePageContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "snapshotName", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] }, "get": { "description": "Fetch content of single page.", "operationId": "fetchSinglePageContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "snapshotName", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] }, "put": { "description": "Update a single page\u0027s content.", "operationId": "UpdateSinglePageContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Content" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}/head-content": { "get": { "description": "Fetch head content of single page.", "operationId": "fetchSinglePageHeadContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}/publish": { "put": { "description": "Publish a single page.", "operationId": "PublishSinglePage", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}/release-content": { "get": { "description": "Fetch release content of single page.", "operationId": "fetchSinglePageReleaseContent", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContentWrapper" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}/revert-content": { "put": { "description": "Revert to specified snapshot for single page content.", "operationId": "revertToSpecifiedSnapshotForSinglePage", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevertSnapshotForSingleParam" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/singlepages/{name}/snapshot": { "get": { "description": "List all snapshots for single page content.", "operationId": "listSinglePageSnapshots", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListedSnapshotDto" } } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/SinglePage" ] } }, "/apis/api.console.halo.run/v1alpha1/stats": { "get": { "description": "Get stats.", "operationId": "getStats", "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardStats" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Stats" ] } }, "/apis/api.console.halo.run/v1alpha1/system/initialize": { "post": { "description": "Initialize system", "operationId": "initialize", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SystemInitializationRequest" } } } }, "responses": { "201": { "description": "System initialization successfully.", "headers": { "Location": { "description": "Redirect URL.", "schema": { "type": "string" }, "style": "simple" } } } }, "tags": [ "api.console.halo.run/v1alpha1/System" ] } }, "/apis/api.console.halo.run/v1alpha1/tags": { "get": { "description": "List Post Tags.", "operationId": "ListPostTags", "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" } } }, { "description": "Post tags filtered by keyword.", "in": "query", "name": "keyword", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TagList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Tag" ] } }, "/apis/api.console.halo.run/v1alpha1/themes": { "get": { "description": "List themes.", "operationId": "ListThemes", "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": "Whether to list uninstalled themes.", "in": "query", "name": "uninstalled", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ThemeList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/-/activation": { "get": { "description": "Fetch the activated theme.", "operationId": "fetchActivatedTheme", "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Theme" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/-/install-from-uri": { "post": { "description": "Install a theme from uri.", "operationId": "InstallThemeFromUri", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallFromUriRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Theme" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/install": { "post": { "description": "Install a theme by uploading a zip file.", "operationId": "InstallTheme", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThemeInstallRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Theme" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/activation": { "put": { "description": "Activate a theme by name.", "operationId": "activateTheme", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Theme" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/config": { "get": { "description": "Fetch configMap of theme by configured configMapName.", "operationId": "fetchThemeConfig", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] }, "put": { "description": "Update the configMap of theme setting.", "operationId": "updateThemeConfig", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/invalidate-cache": { "put": { "description": "Invalidate theme template cache.", "operationId": "InvalidateCache", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/reload": { "put": { "description": "Reload theme setting.", "operationId": "Reload", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Theme" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/reset-config": { "put": { "description": "Reset the configMap of theme setting.", "operationId": "ResetThemeConfig", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/setting": { "get": { "description": "Fetch setting of theme.", "operationId": "fetchThemeSetting", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/upgrade": { "post": { "description": "Upgrade theme", "operationId": "UpgradeTheme", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpgradeRequest" } } }, "required": true }, "responses": {}, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/themes/{name}/upgrade-from-uri": { "post": { "description": "Upgrade a theme from uri.", "operationId": "UpgradeThemeFromUri", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeFromUriRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Theme" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/Theme" ] } }, "/apis/api.console.halo.run/v1alpha1/users": { "get": { "description": "List users", "operationId": "ListUsers", "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" } } }, { "description": "Keyword to search", "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "description": "Role name", "in": "query", "name": "role", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserEndpoint.ListedUserList" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] }, "post": { "description": "Creates a new user.", "operationId": "CreateUser", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/-": { "get": { "description": "Get current user detail", "operationId": "GetCurrentUserDetail", "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DetailedUser" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] }, "put": { "description": "Update current user profile, but password.", "operationId": "UpdateCurrentUser", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/-/password": { "put": { "description": "Change own password of user.", "operationId": "ChangeOwnPassword", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChangeOwnPasswordRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/-/send-email-verification-code": { "post": { "description": "Send email verification code for user", "operationId": "SendEmailVerificationCode", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EmailVerifyRequest" } } }, "required": true }, "responses": { "default": { "content": {}, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/-/verify-email": { "post": { "description": "Verify email for user by code.", "operationId": "VerifyEmail", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/VerifyCodeRequest" } } }, "required": true }, "responses": { "default": { "content": {}, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/{name}": { "get": { "description": "Get user detail by name", "operationId": "GetUserDetail", "parameters": [ { "description": "User name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DetailedUser" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/{name}/avatar": { "delete": { "description": "delete user avatar", "operationId": "DeleteUserAvatar", "parameters": [ { "description": "User name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] }, "post": { "description": "upload user avatar", "operationId": "UploadUserAvatar", "parameters": [ { "description": "User name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IAvatarUploadRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/{name}/password": { "put": { "description": "Change anyone password of user for admin.", "operationId": "ChangeAnyonePassword", "parameters": [ { "description": "Name of user. If the name is equal to \u0027-\u0027, it will change the password of current user.", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.halo.run/v1alpha1/users/{name}/permissions": { "get": { "description": "Get permissions of user", "operationId": "GetPermissions", "parameters": [ { "description": "User name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserPermission" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] }, "post": { "description": "Grant permissions to user", "operationId": "GrantPermission", "parameters": [ { "description": "User name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GrantRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.console.halo.run/v1alpha1/User" ] } }, "/apis/api.console.migration.halo.run/v1alpha1/backups/{name}/files/{filename}": { "get": { "operationId": "DownloadBackups", "parameters": [ { "description": "Backup name.", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Backup filename.", "in": "path", "name": "filename", "required": true, "schema": { "type": "string" } } ], "responses": {}, "tags": [ "api.console.migration.halo.run/v1alpha1/Migration" ] } }, "/apis/api.console.migration.halo.run/v1alpha1/restorations": { "post": { "description": "Restore backup by uploading file or providing download link or backup name.", "operationId": "RestoreBackup", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RestoreRequest" } } }, "required": true }, "responses": {}, "tags": [ "api.console.migration.halo.run/v1alpha1/Migration" ] } }, "/apis/api.content.halo.run/v1alpha1/categories": { "get": { "description": "Lists categories.", "operationId": "queryCategories", "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/CategoryVoList" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Category" ] } }, "/apis/api.content.halo.run/v1alpha1/categories/{name}": { "get": { "description": "Gets category by name.", "operationId": "queryCategoryByName", "parameters": [ { "description": "Category name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CategoryVo" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Category" ] } }, "/apis/api.content.halo.run/v1alpha1/categories/{name}/posts": { "get": { "description": "Lists posts by category name.", "operationId": "queryPostsByCategoryName", "parameters": [ { "description": "Category 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" } } }, { "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/ListedPostVoList" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Category" ] } }, "/apis/api.content.halo.run/v1alpha1/posts": { "get": { "description": "Lists posts.", "operationId": "queryPosts", "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/ListedPostVoList" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Post" ] } }, "/apis/api.content.halo.run/v1alpha1/posts/{name}": { "get": { "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/PostVo" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Post" ] } }, "/apis/api.content.halo.run/v1alpha1/posts/{name}/navigation": { "get": { "description": "Gets a post navigation by name.", "operationId": "queryPostNavigationByName", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NavigationPostVo" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Post" ] } }, "/apis/api.content.halo.run/v1alpha1/singlepages": { "get": { "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/ListedSinglePageVoList" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/SinglePage" ] } }, "/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" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePageVo" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/SinglePage" ] } }, "/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" } } }, { "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": [ "api.content.halo.run/v1alpha1/Tag" ] } }, "/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": { "*/*": { "schema": { "$ref": "#/components/schemas/TagVo" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Tag" ] } }, "/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" } } }, { "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/ListedPostVo" } } }, "description": "default response" } }, "tags": [ "api.content.halo.run/v1alpha1/Tag" ] } }, "/apis/api.halo.run/v1alpha1/comments": { "get": { "description": "List comments.", "operationId": "ListComments_1", "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": [ "api.halo.run/v1alpha1/Comment" ] }, "post": { "description": "Create a comment.", "operationId": "CreateComment_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Comment" } } }, "description": "default response" } }, "tags": [ "api.halo.run/v1alpha1/Comment" ] } }, "/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": [ "api.halo.run/v1alpha1/Comment" ] } }, "/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": [ "api.halo.run/v1alpha1/Comment" ] }, "post": { "description": "Create a reply.", "operationId": "CreateReply_1", "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": [ "api.halo.run/v1alpha1/Comment" ] } }, "/apis/api.halo.run/v1alpha1/indices/post": { "get": { "description": "Search posts with fuzzy query", "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/PostHits" } } }, "description": "default response" } }, "tags": [ "api.halo.run/v1alpha1/Post" ] } }, "/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": [ "api.halo.run/v1alpha1/Menu" ] } }, "/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": [ "api.halo.run/v1alpha1/Menu" ] } }, "/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": [ "api.halo.run/v1alpha1/Stats" ] } }, "/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": [ "api.halo.run/v1alpha1/Tracker" ] } }, "/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": [ "api.halo.run/v1alpha1/Tracker" ] } }, "/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": [ "api.halo.run/v1alpha1/Tracker" ] } }, "/apis/api.halo.run/v1alpha1/users/-/send-password-reset-email": { "post": { "description": "Send password reset email when forgot password", "operationId": "SendPasswordResetEmail", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PasswordResetEmailRequest" } } }, "required": true }, "responses": { "204 NO_CONTENT": { "content": {}, "description": "default response" } }, "tags": [ "api.halo.run/v1alpha1/User" ] } }, "/apis/api.halo.run/v1alpha1/users/-/send-register-verify-email": { "post": { "description": "Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true", "operationId": "SendRegisterVerifyEmail", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RegisterVerifyEmailRequest" } } }, "required": true }, "responses": { "204 NO_CONTENT": { "content": {}, "description": "default response" } }, "tags": [ "api.halo.run/v1alpha1/User" ] } }, "/apis/api.halo.run/v1alpha1/users/-/signup": { "post": { "description": "Sign up a new user", "operationId": "SignUp", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SignUpRequest" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "default response" } }, "tags": [ "api.halo.run/v1alpha1/User" ] } }, "/apis/api.halo.run/v1alpha1/users/{name}/reset-password": { "put": { "description": "Reset password by token", "operationId": "ResetPasswordByToken", "parameters": [ { "description": "The name of the user", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "204 NO_CONTENT": { "content": {}, "description": "default response" } }, "tags": [ "api.halo.run/v1alpha1/User" ] } }, "/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": [ "api.notification.halo.run/v1alpha1/Notifier" ] }, "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": [ "api.notification.halo.run/v1alpha1/Notifier" ] } }, "/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": [ "api.notification.halo.run/v1alpha1/Subscription" ] } }, "/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": [ "api.notification.halo.run/v1alpha1/Notification" ] }, "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": [ "api.notification.halo.run/v1alpha1/Notification" ] } }, "/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" } } }, { "description": "Keyword", "in": "query", "name": "keyword", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotificationList" } } }, "description": "default response" } }, "tags": [ "api.notification.halo.run/v1alpha1/Notification" ] } }, "/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": [ "api.notification.halo.run/v1alpha1/Notification" ] } }, "/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": [ "api.notification.halo.run/v1alpha1/Notification" ] } }, "/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": [ "api.notification.halo.run/v1alpha1/Notification" ] } }, "/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": [ "api.plugin.halo.run/v1alpha1/Plugin" ] } }, "/apis/api.security.halo.run/v1alpha1/authentications/two-factor/settings": { "get": { "description": "Get Two-factor authentication settings.", "operationId": "GetTwoFactorAuthenticationSettings", "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TwoFactorAuthSettings" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/Authentication/TwoFactor" ] } }, "/apis/api.security.halo.run/v1alpha1/authentications/two-factor/settings/disabled": { "put": { "description": "Disable Two-factor authentication", "operationId": "DisableTwoFactor", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PasswordRequest" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TwoFactorAuthSettings" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/Authentication/TwoFactor" ] } }, "/apis/api.security.halo.run/v1alpha1/authentications/two-factor/settings/enabled": { "put": { "description": "Enable Two-factor authentication", "operationId": "EnableTwoFactor", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PasswordRequest" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TwoFactorAuthSettings" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/Authentication/TwoFactor" ] } }, "/apis/api.security.halo.run/v1alpha1/authentications/two-factor/totp": { "post": { "description": "Configure a TOTP", "operationId": "ConfigurerTotp", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TotpRequest" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TwoFactorAuthSettings" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/Authentication/TwoFactor" ] } }, "/apis/api.security.halo.run/v1alpha1/authentications/two-factor/totp/-": { "delete": { "operationId": "DeleteTotp", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PasswordRequest" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TwoFactorAuthSettings" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/Authentication/TwoFactor" ] } }, "/apis/api.security.halo.run/v1alpha1/authentications/two-factor/totp/auth-link": { "get": { "description": "Get TOTP auth link, including secret", "operationId": "GetTotpAuthLink", "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TotpAuthLinkResponse" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/Authentication/TwoFactor" ] } }, "/apis/api.security.halo.run/v1alpha1/personalaccesstokens": { "get": { "description": "Obtain PAT list.", "operationId": "ObtainPats", "responses": { "default": { "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalAccessToken" } } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/PersonalAccessToken" ] }, "post": { "description": "Generate a PAT.", "operationId": "GeneratePat", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "required": true }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "description": "default response" } }, "tags": [ "api.security.halo.run/v1alpha1/PersonalAccessToken" ] } }, "/apis/api.security.halo.run/v1alpha1/personalaccesstokens/{name}": { "delete": { "description": "Delete a PAT", "operationId": "DeletePat", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": {}, "tags": [ "api.security.halo.run/v1alpha1/PersonalAccessToken" ] }, "get": { "description": "Obtain a PAT.", "operationId": "ObtainPat", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": {}, "tags": [ "api.security.halo.run/v1alpha1/PersonalAccessToken" ] } }, "/apis/api.security.halo.run/v1alpha1/personalaccesstokens/{name}/actions/restoration": { "put": { "description": "Restore a PAT.", "operationId": "RestorePat", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": {}, "tags": [ "api.security.halo.run/v1alpha1/PersonalAccessToken" ] } }, "/apis/api.security.halo.run/v1alpha1/personalaccesstokens/{name}/actions/revocation": { "put": { "description": "Revoke a PAT", "operationId": "RevokePat", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": {}, "tags": [ "api.security.halo.run/v1alpha1/PersonalAccessToken" ] } }, "/apis/auth.halo.run/v1alpha1/authproviders": { "get": { "description": "List auth.halo.run/v1alpha1/AuthProvider", "operationId": "List/auth.halo.run/v1alpha1/AuthProvider", "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/AuthProviderList" } } }, "description": "Response authproviders" } }, "tags": [ "auth.halo.run/v1alpha1/AuthProvider" ] }, "post": { "description": "Create auth.halo.run/v1alpha1/AuthProvider", "operationId": "Create/auth.halo.run/v1alpha1/AuthProvider", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "Fresh authprovider" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "Response authproviders created just now" } }, "tags": [ "auth.halo.run/v1alpha1/AuthProvider" ] } }, "/apis/auth.halo.run/v1alpha1/authproviders/{name}": { "delete": { "description": "Delete auth.halo.run/v1alpha1/AuthProvider", "operationId": "Delete/auth.halo.run/v1alpha1/AuthProvider", "parameters": [ { "description": "Name of authprovider", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response authprovider deleted just now" } }, "tags": [ "auth.halo.run/v1alpha1/AuthProvider" ] }, "get": { "description": "Get auth.halo.run/v1alpha1/AuthProvider", "operationId": "Get/auth.halo.run/v1alpha1/AuthProvider", "parameters": [ { "description": "Name of authprovider", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "Response single authprovider" } }, "tags": [ "auth.halo.run/v1alpha1/AuthProvider" ] }, "put": { "description": "Update auth.halo.run/v1alpha1/AuthProvider", "operationId": "Update/auth.halo.run/v1alpha1/AuthProvider", "parameters": [ { "description": "Name of authprovider", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "Updated authprovider" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthProvider" } } }, "description": "Response authproviders updated just now" } }, "tags": [ "auth.halo.run/v1alpha1/AuthProvider" ] } }, "/apis/auth.halo.run/v1alpha1/userconnections": { "get": { "description": "List auth.halo.run/v1alpha1/UserConnection", "operationId": "List/auth.halo.run/v1alpha1/UserConnection", "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/UserConnectionList" } } }, "description": "Response userconnections" } }, "tags": [ "auth.halo.run/v1alpha1/UserConnection" ] }, "post": { "description": "Create auth.halo.run/v1alpha1/UserConnection", "operationId": "Create/auth.halo.run/v1alpha1/UserConnection", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserConnection" } } }, "description": "Fresh userconnection" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserConnection" } } }, "description": "Response userconnections created just now" } }, "tags": [ "auth.halo.run/v1alpha1/UserConnection" ] } }, "/apis/auth.halo.run/v1alpha1/userconnections/{name}": { "delete": { "description": "Delete auth.halo.run/v1alpha1/UserConnection", "operationId": "Delete/auth.halo.run/v1alpha1/UserConnection", "parameters": [ { "description": "Name of userconnection", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response userconnection deleted just now" } }, "tags": [ "auth.halo.run/v1alpha1/UserConnection" ] }, "get": { "description": "Get auth.halo.run/v1alpha1/UserConnection", "operationId": "Get/auth.halo.run/v1alpha1/UserConnection", "parameters": [ { "description": "Name of userconnection", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserConnection" } } }, "description": "Response single userconnection" } }, "tags": [ "auth.halo.run/v1alpha1/UserConnection" ] }, "put": { "description": "Update auth.halo.run/v1alpha1/UserConnection", "operationId": "Update/auth.halo.run/v1alpha1/UserConnection", "parameters": [ { "description": "Name of userconnection", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserConnection" } } }, "description": "Updated userconnection" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserConnection" } } }, "description": "Response userconnections updated just now" } }, "tags": [ "auth.halo.run/v1alpha1/UserConnection" ] } }, "/apis/console.api.notification.halo.run/v1alpha1/notifiers/default-email-notifier/verify-connection": { "post": { "description": "Verify email sender config.", "operationId": "VerifyEmailSenderConfig", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EmailConfigValidationRequest" } } }, "required": true }, "responses": { "default": { "content": {}, "description": "default response" } }, "tags": [ "console.api.notification.halo.run/v1alpha1/Notifier" ] } }, "/apis/content.halo.run/v1alpha1/categories": { "get": { "description": "List content.halo.run/v1alpha1/Category", "operationId": "List/content.halo.run/v1alpha1/Category", "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/CategoryList" } } }, "description": "Response categories" } }, "tags": [ "content.halo.run/v1alpha1/Category" ] }, "post": { "description": "Create content.halo.run/v1alpha1/Category", "operationId": "Create/content.halo.run/v1alpha1/Category", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Category" } } }, "description": "Fresh category" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Category" } } }, "description": "Response categories created just now" } }, "tags": [ "content.halo.run/v1alpha1/Category" ] } }, "/apis/content.halo.run/v1alpha1/categories/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/Category", "operationId": "Delete/content.halo.run/v1alpha1/Category", "parameters": [ { "description": "Name of category", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response category deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/Category" ] }, "get": { "description": "Get content.halo.run/v1alpha1/Category", "operationId": "Get/content.halo.run/v1alpha1/Category", "parameters": [ { "description": "Name of category", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Category" } } }, "description": "Response single category" } }, "tags": [ "content.halo.run/v1alpha1/Category" ] }, "put": { "description": "Update content.halo.run/v1alpha1/Category", "operationId": "Update/content.halo.run/v1alpha1/Category", "parameters": [ { "description": "Name of category", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Category" } } }, "description": "Updated category" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Category" } } }, "description": "Response categories updated just now" } }, "tags": [ "content.halo.run/v1alpha1/Category" ] } }, "/apis/content.halo.run/v1alpha1/comments": { "get": { "description": "List content.halo.run/v1alpha1/Comment", "operationId": "List/content.halo.run/v1alpha1/Comment", "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/CommentList" } } }, "description": "Response comments" } }, "tags": [ "content.halo.run/v1alpha1/Comment" ] }, "post": { "description": "Create content.halo.run/v1alpha1/Comment", "operationId": "Create/content.halo.run/v1alpha1/Comment", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Comment" } } }, "description": "Fresh comment" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Comment" } } }, "description": "Response comments created just now" } }, "tags": [ "content.halo.run/v1alpha1/Comment" ] } }, "/apis/content.halo.run/v1alpha1/comments/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/Comment", "operationId": "Delete/content.halo.run/v1alpha1/Comment", "parameters": [ { "description": "Name of comment", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response comment deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/Comment" ] }, "get": { "description": "Get content.halo.run/v1alpha1/Comment", "operationId": "Get/content.halo.run/v1alpha1/Comment", "parameters": [ { "description": "Name of comment", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Comment" } } }, "description": "Response single comment" } }, "tags": [ "content.halo.run/v1alpha1/Comment" ] }, "put": { "description": "Update content.halo.run/v1alpha1/Comment", "operationId": "Update/content.halo.run/v1alpha1/Comment", "parameters": [ { "description": "Name of comment", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Comment" } } }, "description": "Updated comment" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Comment" } } }, "description": "Response comments updated just now" } }, "tags": [ "content.halo.run/v1alpha1/Comment" ] } }, "/apis/content.halo.run/v1alpha1/posts": { "get": { "description": "List content.halo.run/v1alpha1/Post", "operationId": "List/content.halo.run/v1alpha1/Post", "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/PostList" } } }, "description": "Response posts" } }, "tags": [ "content.halo.run/v1alpha1/Post" ] }, "post": { "description": "Create content.halo.run/v1alpha1/Post", "operationId": "Create/content.halo.run/v1alpha1/Post", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "Fresh post" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "Response posts created just now" } }, "tags": [ "content.halo.run/v1alpha1/Post" ] } }, "/apis/content.halo.run/v1alpha1/posts/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/Post", "operationId": "Delete/content.halo.run/v1alpha1/Post", "parameters": [ { "description": "Name of post", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response post deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/Post" ] }, "get": { "description": "Get content.halo.run/v1alpha1/Post", "operationId": "Get/content.halo.run/v1alpha1/Post", "parameters": [ { "description": "Name of post", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "Response single post" } }, "tags": [ "content.halo.run/v1alpha1/Post" ] }, "put": { "description": "Update content.halo.run/v1alpha1/Post", "operationId": "Update/content.halo.run/v1alpha1/Post", "parameters": [ { "description": "Name of post", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "Updated post" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "Response posts updated just now" } }, "tags": [ "content.halo.run/v1alpha1/Post" ] } }, "/apis/content.halo.run/v1alpha1/replies": { "get": { "description": "List content.halo.run/v1alpha1/Reply", "operationId": "List/content.halo.run/v1alpha1/Reply", "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/ReplyList" } } }, "description": "Response replies" } }, "tags": [ "content.halo.run/v1alpha1/Reply" ] }, "post": { "description": "Create content.halo.run/v1alpha1/Reply", "operationId": "Create/content.halo.run/v1alpha1/Reply", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reply" } } }, "description": "Fresh reply" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reply" } } }, "description": "Response replies created just now" } }, "tags": [ "content.halo.run/v1alpha1/Reply" ] } }, "/apis/content.halo.run/v1alpha1/replies/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/Reply", "operationId": "Delete/content.halo.run/v1alpha1/Reply", "parameters": [ { "description": "Name of reply", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response reply deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/Reply" ] }, "get": { "description": "Get content.halo.run/v1alpha1/Reply", "operationId": "Get/content.halo.run/v1alpha1/Reply", "parameters": [ { "description": "Name of reply", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reply" } } }, "description": "Response single reply" } }, "tags": [ "content.halo.run/v1alpha1/Reply" ] }, "put": { "description": "Update content.halo.run/v1alpha1/Reply", "operationId": "Update/content.halo.run/v1alpha1/Reply", "parameters": [ { "description": "Name of reply", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reply" } } }, "description": "Updated reply" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reply" } } }, "description": "Response replies updated just now" } }, "tags": [ "content.halo.run/v1alpha1/Reply" ] } }, "/apis/content.halo.run/v1alpha1/singlepages": { "get": { "description": "List content.halo.run/v1alpha1/SinglePage", "operationId": "List/content.halo.run/v1alpha1/SinglePage", "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/SinglePageList" } } }, "description": "Response singlepages" } }, "tags": [ "content.halo.run/v1alpha1/SinglePage" ] }, "post": { "description": "Create content.halo.run/v1alpha1/SinglePage", "operationId": "Create/content.halo.run/v1alpha1/SinglePage", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "Fresh singlepage" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "Response singlepages created just now" } }, "tags": [ "content.halo.run/v1alpha1/SinglePage" ] } }, "/apis/content.halo.run/v1alpha1/singlepages/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/SinglePage", "operationId": "Delete/content.halo.run/v1alpha1/SinglePage", "parameters": [ { "description": "Name of singlepage", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response singlepage deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/SinglePage" ] }, "get": { "description": "Get content.halo.run/v1alpha1/SinglePage", "operationId": "Get/content.halo.run/v1alpha1/SinglePage", "parameters": [ { "description": "Name of singlepage", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "Response single singlepage" } }, "tags": [ "content.halo.run/v1alpha1/SinglePage" ] }, "put": { "description": "Update content.halo.run/v1alpha1/SinglePage", "operationId": "Update/content.halo.run/v1alpha1/SinglePage", "parameters": [ { "description": "Name of singlepage", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "Updated singlepage" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SinglePage" } } }, "description": "Response singlepages updated just now" } }, "tags": [ "content.halo.run/v1alpha1/SinglePage" ] } }, "/apis/content.halo.run/v1alpha1/snapshots": { "get": { "description": "List content.halo.run/v1alpha1/Snapshot", "operationId": "List/content.halo.run/v1alpha1/Snapshot", "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/SnapshotList" } } }, "description": "Response snapshots" } }, "tags": [ "content.halo.run/v1alpha1/Snapshot" ] }, "post": { "description": "Create content.halo.run/v1alpha1/Snapshot", "operationId": "Create/content.halo.run/v1alpha1/Snapshot", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "Fresh snapshot" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "Response snapshots created just now" } }, "tags": [ "content.halo.run/v1alpha1/Snapshot" ] } }, "/apis/content.halo.run/v1alpha1/snapshots/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/Snapshot", "operationId": "Delete/content.halo.run/v1alpha1/Snapshot", "parameters": [ { "description": "Name of snapshot", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response snapshot deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/Snapshot" ] }, "get": { "description": "Get content.halo.run/v1alpha1/Snapshot", "operationId": "Get/content.halo.run/v1alpha1/Snapshot", "parameters": [ { "description": "Name of snapshot", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "Response single snapshot" } }, "tags": [ "content.halo.run/v1alpha1/Snapshot" ] }, "put": { "description": "Update content.halo.run/v1alpha1/Snapshot", "operationId": "Update/content.halo.run/v1alpha1/Snapshot", "parameters": [ { "description": "Name of snapshot", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "Updated snapshot" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "Response snapshots updated just now" } }, "tags": [ "content.halo.run/v1alpha1/Snapshot" ] } }, "/apis/content.halo.run/v1alpha1/tags": { "get": { "description": "List content.halo.run/v1alpha1/Tag", "operationId": "List/content.halo.run/v1alpha1/Tag", "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/TagList" } } }, "description": "Response tags" } }, "tags": [ "content.halo.run/v1alpha1/Tag" ] }, "post": { "description": "Create content.halo.run/v1alpha1/Tag", "operationId": "Create/content.halo.run/v1alpha1/Tag", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "Fresh tag" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "Response tags created just now" } }, "tags": [ "content.halo.run/v1alpha1/Tag" ] } }, "/apis/content.halo.run/v1alpha1/tags/{name}": { "delete": { "description": "Delete content.halo.run/v1alpha1/Tag", "operationId": "Delete/content.halo.run/v1alpha1/Tag", "parameters": [ { "description": "Name of tag", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response tag deleted just now" } }, "tags": [ "content.halo.run/v1alpha1/Tag" ] }, "get": { "description": "Get content.halo.run/v1alpha1/Tag", "operationId": "Get/content.halo.run/v1alpha1/Tag", "parameters": [ { "description": "Name of tag", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "Response single tag" } }, "tags": [ "content.halo.run/v1alpha1/Tag" ] }, "put": { "description": "Update content.halo.run/v1alpha1/Tag", "operationId": "Update/content.halo.run/v1alpha1/Tag", "parameters": [ { "description": "Name of tag", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "Updated tag" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "Response tags updated just now" } }, "tags": [ "content.halo.run/v1alpha1/Tag" ] } }, "/apis/metrics.halo.run/v1alpha1/counters": { "get": { "description": "List metrics.halo.run/v1alpha1/Counter", "operationId": "List/metrics.halo.run/v1alpha1/Counter", "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/CounterList" } } }, "description": "Response counters" } }, "tags": [ "metrics.halo.run/v1alpha1/Counter" ] }, "post": { "description": "Create metrics.halo.run/v1alpha1/Counter", "operationId": "Create/metrics.halo.run/v1alpha1/Counter", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Counter" } } }, "description": "Fresh counter" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Counter" } } }, "description": "Response counters created just now" } }, "tags": [ "metrics.halo.run/v1alpha1/Counter" ] } }, "/apis/metrics.halo.run/v1alpha1/counters/{name}": { "delete": { "description": "Delete metrics.halo.run/v1alpha1/Counter", "operationId": "Delete/metrics.halo.run/v1alpha1/Counter", "parameters": [ { "description": "Name of counter", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response counter deleted just now" } }, "tags": [ "metrics.halo.run/v1alpha1/Counter" ] }, "get": { "description": "Get metrics.halo.run/v1alpha1/Counter", "operationId": "Get/metrics.halo.run/v1alpha1/Counter", "parameters": [ { "description": "Name of counter", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Counter" } } }, "description": "Response single counter" } }, "tags": [ "metrics.halo.run/v1alpha1/Counter" ] }, "put": { "description": "Update metrics.halo.run/v1alpha1/Counter", "operationId": "Update/metrics.halo.run/v1alpha1/Counter", "parameters": [ { "description": "Name of counter", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Counter" } } }, "description": "Updated counter" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Counter" } } }, "description": "Response counters updated just now" } }, "tags": [ "metrics.halo.run/v1alpha1/Counter" ] } }, "/apis/migration.halo.run/v1alpha1/backups": { "get": { "description": "List migration.halo.run/v1alpha1/Backup", "operationId": "List/migration.halo.run/v1alpha1/Backup", "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/BackupList" } } }, "description": "Response backups" } }, "tags": [ "migration.halo.run/v1alpha1/Backup" ] }, "post": { "description": "Create migration.halo.run/v1alpha1/Backup", "operationId": "Create/migration.halo.run/v1alpha1/Backup", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Backup" } } }, "description": "Fresh backup" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Backup" } } }, "description": "Response backups created just now" } }, "tags": [ "migration.halo.run/v1alpha1/Backup" ] } }, "/apis/migration.halo.run/v1alpha1/backups/{name}": { "delete": { "description": "Delete migration.halo.run/v1alpha1/Backup", "operationId": "Delete/migration.halo.run/v1alpha1/Backup", "parameters": [ { "description": "Name of backup", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response backup deleted just now" } }, "tags": [ "migration.halo.run/v1alpha1/Backup" ] }, "get": { "description": "Get migration.halo.run/v1alpha1/Backup", "operationId": "Get/migration.halo.run/v1alpha1/Backup", "parameters": [ { "description": "Name of backup", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Backup" } } }, "description": "Response single backup" } }, "tags": [ "migration.halo.run/v1alpha1/Backup" ] }, "put": { "description": "Update migration.halo.run/v1alpha1/Backup", "operationId": "Update/migration.halo.run/v1alpha1/Backup", "parameters": [ { "description": "Name of backup", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Backup" } } }, "description": "Updated backup" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Backup" } } }, "description": "Response backups updated just now" } }, "tags": [ "migration.halo.run/v1alpha1/Backup" ] } }, "/apis/notification.halo.run/v1alpha1/notifications": { "get": { "description": "List notification.halo.run/v1alpha1/Notification", "operationId": "List/notification.halo.run/v1alpha1/Notification", "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/NotificationList" } } }, "description": "Response notifications" } }, "tags": [ "notification.halo.run/v1alpha1/Notification" ] }, "post": { "description": "Create notification.halo.run/v1alpha1/Notification", "operationId": "Create/notification.halo.run/v1alpha1/Notification", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "Fresh notification" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "Response notifications created just now" } }, "tags": [ "notification.halo.run/v1alpha1/Notification" ] } }, "/apis/notification.halo.run/v1alpha1/notifications/{name}": { "delete": { "description": "Delete notification.halo.run/v1alpha1/Notification", "operationId": "Delete/notification.halo.run/v1alpha1/Notification", "parameters": [ { "description": "Name of notification", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response notification deleted just now" } }, "tags": [ "notification.halo.run/v1alpha1/Notification" ] }, "get": { "description": "Get notification.halo.run/v1alpha1/Notification", "operationId": "Get/notification.halo.run/v1alpha1/Notification", "parameters": [ { "description": "Name of notification", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "Response single notification" } }, "tags": [ "notification.halo.run/v1alpha1/Notification" ] }, "put": { "description": "Update notification.halo.run/v1alpha1/Notification", "operationId": "Update/notification.halo.run/v1alpha1/Notification", "parameters": [ { "description": "Name of notification", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "Updated notification" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "Response notifications updated just now" } }, "tags": [ "notification.halo.run/v1alpha1/Notification" ] } }, "/apis/notification.halo.run/v1alpha1/notificationtemplates": { "get": { "description": "List notification.halo.run/v1alpha1/NotificationTemplate", "operationId": "List/notification.halo.run/v1alpha1/NotificationTemplate", "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/NotificationTemplateList" } } }, "description": "Response notificationtemplates" } }, "tags": [ "notification.halo.run/v1alpha1/NotificationTemplate" ] }, "post": { "description": "Create notification.halo.run/v1alpha1/NotificationTemplate", "operationId": "Create/notification.halo.run/v1alpha1/NotificationTemplate", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "Fresh notificationtemplate" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "Response notificationtemplates created just now" } }, "tags": [ "notification.halo.run/v1alpha1/NotificationTemplate" ] } }, "/apis/notification.halo.run/v1alpha1/notificationtemplates/{name}": { "delete": { "description": "Delete notification.halo.run/v1alpha1/NotificationTemplate", "operationId": "Delete/notification.halo.run/v1alpha1/NotificationTemplate", "parameters": [ { "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response notificationtemplate deleted just now" } }, "tags": [ "notification.halo.run/v1alpha1/NotificationTemplate" ] }, "get": { "description": "Get notification.halo.run/v1alpha1/NotificationTemplate", "operationId": "Get/notification.halo.run/v1alpha1/NotificationTemplate", "parameters": [ { "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "Response single notificationtemplate" } }, "tags": [ "notification.halo.run/v1alpha1/NotificationTemplate" ] }, "put": { "description": "Update notification.halo.run/v1alpha1/NotificationTemplate", "operationId": "Update/notification.halo.run/v1alpha1/NotificationTemplate", "parameters": [ { "description": "Name of notificationtemplate", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "Updated notificationtemplate" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "Response notificationtemplates updated just now" } }, "tags": [ "notification.halo.run/v1alpha1/NotificationTemplate" ] } }, "/apis/notification.halo.run/v1alpha1/notifierDescriptors": { "get": { "description": "List notification.halo.run/v1alpha1/NotifierDescriptor", "operationId": "List/notification.halo.run/v1alpha1/NotifierDescriptor", "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/NotifierDescriptorList" } } }, "description": "Response notifierDescriptors" } }, "tags": [ "notification.halo.run/v1alpha1/NotifierDescriptor" ] }, "post": { "description": "Create notification.halo.run/v1alpha1/NotifierDescriptor", "operationId": "Create/notification.halo.run/v1alpha1/NotifierDescriptor", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotifierDescriptor" } } }, "description": "Fresh notifierDescriptor" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotifierDescriptor" } } }, "description": "Response notifierDescriptors created just now" } }, "tags": [ "notification.halo.run/v1alpha1/NotifierDescriptor" ] } }, "/apis/notification.halo.run/v1alpha1/notifierDescriptors/{name}": { "delete": { "description": "Delete notification.halo.run/v1alpha1/NotifierDescriptor", "operationId": "Delete/notification.halo.run/v1alpha1/NotifierDescriptor", "parameters": [ { "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response notifierDescriptor deleted just now" } }, "tags": [ "notification.halo.run/v1alpha1/NotifierDescriptor" ] }, "get": { "description": "Get notification.halo.run/v1alpha1/NotifierDescriptor", "operationId": "Get/notification.halo.run/v1alpha1/NotifierDescriptor", "parameters": [ { "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotifierDescriptor" } } }, "description": "Response single notifierDescriptor" } }, "tags": [ "notification.halo.run/v1alpha1/NotifierDescriptor" ] }, "put": { "description": "Update notification.halo.run/v1alpha1/NotifierDescriptor", "operationId": "Update/notification.halo.run/v1alpha1/NotifierDescriptor", "parameters": [ { "description": "Name of notifierDescriptor", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotifierDescriptor" } } }, "description": "Updated notifierDescriptor" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotifierDescriptor" } } }, "description": "Response notifierDescriptors updated just now" } }, "tags": [ "notification.halo.run/v1alpha1/NotifierDescriptor" ] } }, "/apis/notification.halo.run/v1alpha1/reasons": { "get": { "description": "List notification.halo.run/v1alpha1/Reason", "operationId": "List/notification.halo.run/v1alpha1/Reason", "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/ReasonList" } } }, "description": "Response reasons" } }, "tags": [ "notification.halo.run/v1alpha1/Reason" ] }, "post": { "description": "Create notification.halo.run/v1alpha1/Reason", "operationId": "Create/notification.halo.run/v1alpha1/Reason", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "Fresh reason" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "Response reasons created just now" } }, "tags": [ "notification.halo.run/v1alpha1/Reason" ] } }, "/apis/notification.halo.run/v1alpha1/reasons/{name}": { "delete": { "description": "Delete notification.halo.run/v1alpha1/Reason", "operationId": "Delete/notification.halo.run/v1alpha1/Reason", "parameters": [ { "description": "Name of reason", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response reason deleted just now" } }, "tags": [ "notification.halo.run/v1alpha1/Reason" ] }, "get": { "description": "Get notification.halo.run/v1alpha1/Reason", "operationId": "Get/notification.halo.run/v1alpha1/Reason", "parameters": [ { "description": "Name of reason", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "Response single reason" } }, "tags": [ "notification.halo.run/v1alpha1/Reason" ] }, "put": { "description": "Update notification.halo.run/v1alpha1/Reason", "operationId": "Update/notification.halo.run/v1alpha1/Reason", "parameters": [ { "description": "Name of reason", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "Updated reason" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "Response reasons updated just now" } }, "tags": [ "notification.halo.run/v1alpha1/Reason" ] } }, "/apis/notification.halo.run/v1alpha1/reasontypes": { "get": { "description": "List notification.halo.run/v1alpha1/ReasonType", "operationId": "List/notification.halo.run/v1alpha1/ReasonType", "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/ReasonTypeList" } } }, "description": "Response reasontypes" } }, "tags": [ "notification.halo.run/v1alpha1/ReasonType" ] }, "post": { "description": "Create notification.halo.run/v1alpha1/ReasonType", "operationId": "Create/notification.halo.run/v1alpha1/ReasonType", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReasonType" } } }, "description": "Fresh reasontype" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReasonType" } } }, "description": "Response reasontypes created just now" } }, "tags": [ "notification.halo.run/v1alpha1/ReasonType" ] } }, "/apis/notification.halo.run/v1alpha1/reasontypes/{name}": { "delete": { "description": "Delete notification.halo.run/v1alpha1/ReasonType", "operationId": "Delete/notification.halo.run/v1alpha1/ReasonType", "parameters": [ { "description": "Name of reasontype", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response reasontype deleted just now" } }, "tags": [ "notification.halo.run/v1alpha1/ReasonType" ] }, "get": { "description": "Get notification.halo.run/v1alpha1/ReasonType", "operationId": "Get/notification.halo.run/v1alpha1/ReasonType", "parameters": [ { "description": "Name of reasontype", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReasonType" } } }, "description": "Response single reasontype" } }, "tags": [ "notification.halo.run/v1alpha1/ReasonType" ] }, "put": { "description": "Update notification.halo.run/v1alpha1/ReasonType", "operationId": "Update/notification.halo.run/v1alpha1/ReasonType", "parameters": [ { "description": "Name of reasontype", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReasonType" } } }, "description": "Updated reasontype" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReasonType" } } }, "description": "Response reasontypes updated just now" } }, "tags": [ "notification.halo.run/v1alpha1/ReasonType" ] } }, "/apis/notification.halo.run/v1alpha1/subscriptions": { "get": { "description": "List notification.halo.run/v1alpha1/Subscription", "operationId": "List/notification.halo.run/v1alpha1/Subscription", "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/SubscriptionList" } } }, "description": "Response subscriptions" } }, "tags": [ "notification.halo.run/v1alpha1/Subscription" ] }, "post": { "description": "Create notification.halo.run/v1alpha1/Subscription", "operationId": "Create/notification.halo.run/v1alpha1/Subscription", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "Fresh subscription" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "Response subscriptions created just now" } }, "tags": [ "notification.halo.run/v1alpha1/Subscription" ] } }, "/apis/notification.halo.run/v1alpha1/subscriptions/{name}": { "delete": { "description": "Delete notification.halo.run/v1alpha1/Subscription", "operationId": "Delete/notification.halo.run/v1alpha1/Subscription", "parameters": [ { "description": "Name of subscription", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response subscription deleted just now" } }, "tags": [ "notification.halo.run/v1alpha1/Subscription" ] }, "get": { "description": "Get notification.halo.run/v1alpha1/Subscription", "operationId": "Get/notification.halo.run/v1alpha1/Subscription", "parameters": [ { "description": "Name of subscription", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "Response single subscription" } }, "tags": [ "notification.halo.run/v1alpha1/Subscription" ] }, "put": { "description": "Update notification.halo.run/v1alpha1/Subscription", "operationId": "Update/notification.halo.run/v1alpha1/Subscription", "parameters": [ { "description": "Name of subscription", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "Updated subscription" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "Response subscriptions updated just now" } }, "tags": [ "notification.halo.run/v1alpha1/Subscription" ] } }, "/apis/plugin.halo.run/v1alpha1/extensiondefinitions": { "get": { "description": "List plugin.halo.run/v1alpha1/ExtensionDefinition", "operationId": "List/plugin.halo.run/v1alpha1/ExtensionDefinition", "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/ExtensionDefinitionList" } } }, "description": "Response extensiondefinitions" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionDefinition" ] }, "post": { "description": "Create plugin.halo.run/v1alpha1/ExtensionDefinition", "operationId": "Create/plugin.halo.run/v1alpha1/ExtensionDefinition", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionDefinition" } } }, "description": "Fresh extensiondefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionDefinition" } } }, "description": "Response extensiondefinitions created just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionDefinition" ] } }, "/apis/plugin.halo.run/v1alpha1/extensiondefinitions/{name}": { "delete": { "description": "Delete plugin.halo.run/v1alpha1/ExtensionDefinition", "operationId": "Delete/plugin.halo.run/v1alpha1/ExtensionDefinition", "parameters": [ { "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response extensiondefinition deleted just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionDefinition" ] }, "get": { "description": "Get plugin.halo.run/v1alpha1/ExtensionDefinition", "operationId": "Get/plugin.halo.run/v1alpha1/ExtensionDefinition", "parameters": [ { "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionDefinition" } } }, "description": "Response single extensiondefinition" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionDefinition" ] }, "put": { "description": "Update plugin.halo.run/v1alpha1/ExtensionDefinition", "operationId": "Update/plugin.halo.run/v1alpha1/ExtensionDefinition", "parameters": [ { "description": "Name of extensiondefinition", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionDefinition" } } }, "description": "Updated extensiondefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionDefinition" } } }, "description": "Response extensiondefinitions updated just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionDefinition" ] } }, "/apis/plugin.halo.run/v1alpha1/extensionpointdefinitions": { "get": { "description": "List plugin.halo.run/v1alpha1/ExtensionPointDefinition", "operationId": "List/plugin.halo.run/v1alpha1/ExtensionPointDefinition", "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/ExtensionPointDefinitionList" } } }, "description": "Response extensionpointdefinitions" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionPointDefinition" ] }, "post": { "description": "Create plugin.halo.run/v1alpha1/ExtensionPointDefinition", "operationId": "Create/plugin.halo.run/v1alpha1/ExtensionPointDefinition", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, "description": "Fresh extensionpointdefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, "description": "Response extensionpointdefinitions created just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionPointDefinition" ] } }, "/apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}": { "delete": { "description": "Delete plugin.halo.run/v1alpha1/ExtensionPointDefinition", "operationId": "Delete/plugin.halo.run/v1alpha1/ExtensionPointDefinition", "parameters": [ { "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response extensionpointdefinition deleted just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionPointDefinition" ] }, "get": { "description": "Get plugin.halo.run/v1alpha1/ExtensionPointDefinition", "operationId": "Get/plugin.halo.run/v1alpha1/ExtensionPointDefinition", "parameters": [ { "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, "description": "Response single extensionpointdefinition" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionPointDefinition" ] }, "put": { "description": "Update plugin.halo.run/v1alpha1/ExtensionPointDefinition", "operationId": "Update/plugin.halo.run/v1alpha1/ExtensionPointDefinition", "parameters": [ { "description": "Name of extensionpointdefinition", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, "description": "Updated extensionpointdefinition" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExtensionPointDefinition" } } }, "description": "Response extensionpointdefinitions updated just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ExtensionPointDefinition" ] } }, "/apis/plugin.halo.run/v1alpha1/plugins": { "get": { "description": "List plugin.halo.run/v1alpha1/Plugin", "operationId": "List/plugin.halo.run/v1alpha1/Plugin", "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/PluginList" } } }, "description": "Response plugins" } }, "tags": [ "plugin.halo.run/v1alpha1/Plugin" ] }, "post": { "description": "Create plugin.halo.run/v1alpha1/Plugin", "operationId": "Create/plugin.halo.run/v1alpha1/Plugin", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "Fresh plugin" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "Response plugins created just now" } }, "tags": [ "plugin.halo.run/v1alpha1/Plugin" ] } }, "/apis/plugin.halo.run/v1alpha1/plugins/{name}": { "delete": { "description": "Delete plugin.halo.run/v1alpha1/Plugin", "operationId": "Delete/plugin.halo.run/v1alpha1/Plugin", "parameters": [ { "description": "Name of plugin", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response plugin deleted just now" } }, "tags": [ "plugin.halo.run/v1alpha1/Plugin" ] }, "get": { "description": "Get plugin.halo.run/v1alpha1/Plugin", "operationId": "Get/plugin.halo.run/v1alpha1/Plugin", "parameters": [ { "description": "Name of plugin", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "Response single plugin" } }, "tags": [ "plugin.halo.run/v1alpha1/Plugin" ] }, "put": { "description": "Update plugin.halo.run/v1alpha1/Plugin", "operationId": "Update/plugin.halo.run/v1alpha1/Plugin", "parameters": [ { "description": "Name of plugin", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "Updated plugin" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Plugin" } } }, "description": "Response plugins updated just now" } }, "tags": [ "plugin.halo.run/v1alpha1/Plugin" ] } }, "/apis/plugin.halo.run/v1alpha1/reverseproxies": { "get": { "description": "List plugin.halo.run/v1alpha1/ReverseProxy", "operationId": "List/plugin.halo.run/v1alpha1/ReverseProxy", "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/ReverseProxyList" } } }, "description": "Response reverseproxies" } }, "tags": [ "plugin.halo.run/v1alpha1/ReverseProxy" ] }, "post": { "description": "Create plugin.halo.run/v1alpha1/ReverseProxy", "operationId": "Create/plugin.halo.run/v1alpha1/ReverseProxy", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReverseProxy" } } }, "description": "Fresh reverseproxy" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReverseProxy" } } }, "description": "Response reverseproxies created just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ReverseProxy" ] } }, "/apis/plugin.halo.run/v1alpha1/reverseproxies/{name}": { "delete": { "description": "Delete plugin.halo.run/v1alpha1/ReverseProxy", "operationId": "Delete/plugin.halo.run/v1alpha1/ReverseProxy", "parameters": [ { "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response reverseproxy deleted just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ReverseProxy" ] }, "get": { "description": "Get plugin.halo.run/v1alpha1/ReverseProxy", "operationId": "Get/plugin.halo.run/v1alpha1/ReverseProxy", "parameters": [ { "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReverseProxy" } } }, "description": "Response single reverseproxy" } }, "tags": [ "plugin.halo.run/v1alpha1/ReverseProxy" ] }, "put": { "description": "Update plugin.halo.run/v1alpha1/ReverseProxy", "operationId": "Update/plugin.halo.run/v1alpha1/ReverseProxy", "parameters": [ { "description": "Name of reverseproxy", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReverseProxy" } } }, "description": "Updated reverseproxy" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReverseProxy" } } }, "description": "Response reverseproxies updated just now" } }, "tags": [ "plugin.halo.run/v1alpha1/ReverseProxy" ] } }, "/apis/plugin.halo.run/v1alpha1/searchengines": { "get": { "description": "List plugin.halo.run/v1alpha1/SearchEngine", "operationId": "List/plugin.halo.run/v1alpha1/SearchEngine", "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/SearchEngineList" } } }, "description": "Response searchengines" } }, "tags": [ "plugin.halo.run/v1alpha1/SearchEngine" ] }, "post": { "description": "Create plugin.halo.run/v1alpha1/SearchEngine", "operationId": "Create/plugin.halo.run/v1alpha1/SearchEngine", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchEngine" } } }, "description": "Fresh searchengine" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchEngine" } } }, "description": "Response searchengines created just now" } }, "tags": [ "plugin.halo.run/v1alpha1/SearchEngine" ] } }, "/apis/plugin.halo.run/v1alpha1/searchengines/{name}": { "delete": { "description": "Delete plugin.halo.run/v1alpha1/SearchEngine", "operationId": "Delete/plugin.halo.run/v1alpha1/SearchEngine", "parameters": [ { "description": "Name of searchengine", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response searchengine deleted just now" } }, "tags": [ "plugin.halo.run/v1alpha1/SearchEngine" ] }, "get": { "description": "Get plugin.halo.run/v1alpha1/SearchEngine", "operationId": "Get/plugin.halo.run/v1alpha1/SearchEngine", "parameters": [ { "description": "Name of searchengine", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchEngine" } } }, "description": "Response single searchengine" } }, "tags": [ "plugin.halo.run/v1alpha1/SearchEngine" ] }, "put": { "description": "Update plugin.halo.run/v1alpha1/SearchEngine", "operationId": "Update/plugin.halo.run/v1alpha1/SearchEngine", "parameters": [ { "description": "Name of searchengine", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchEngine" } } }, "description": "Updated searchengine" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchEngine" } } }, "description": "Response searchengines updated just now" } }, "tags": [ "plugin.halo.run/v1alpha1/SearchEngine" ] } }, "/apis/security.halo.run/v1alpha1/personalaccesstokens": { "get": { "description": "List security.halo.run/v1alpha1/PersonalAccessToken", "operationId": "List/security.halo.run/v1alpha1/PersonalAccessToken", "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/PersonalAccessTokenList" } } }, "description": "Response personalaccesstokens" } }, "tags": [ "security.halo.run/v1alpha1/PersonalAccessToken" ] }, "post": { "description": "Create security.halo.run/v1alpha1/PersonalAccessToken", "operationId": "Create/security.halo.run/v1alpha1/PersonalAccessToken", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "description": "Fresh personalaccesstoken" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "description": "Response personalaccesstokens created just now" } }, "tags": [ "security.halo.run/v1alpha1/PersonalAccessToken" ] } }, "/apis/security.halo.run/v1alpha1/personalaccesstokens/{name}": { "delete": { "description": "Delete security.halo.run/v1alpha1/PersonalAccessToken", "operationId": "Delete/security.halo.run/v1alpha1/PersonalAccessToken", "parameters": [ { "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response personalaccesstoken deleted just now" } }, "tags": [ "security.halo.run/v1alpha1/PersonalAccessToken" ] }, "get": { "description": "Get security.halo.run/v1alpha1/PersonalAccessToken", "operationId": "Get/security.halo.run/v1alpha1/PersonalAccessToken", "parameters": [ { "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "description": "Response single personalaccesstoken" } }, "tags": [ "security.halo.run/v1alpha1/PersonalAccessToken" ] }, "put": { "description": "Update security.halo.run/v1alpha1/PersonalAccessToken", "operationId": "Update/security.halo.run/v1alpha1/PersonalAccessToken", "parameters": [ { "description": "Name of personalaccesstoken", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "description": "Updated personalaccesstoken" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersonalAccessToken" } } }, "description": "Response personalaccesstokens updated just now" } }, "tags": [ "security.halo.run/v1alpha1/PersonalAccessToken" ] } }, "/apis/storage.halo.run/v1alpha1/attachments": { "get": { "description": "List storage.halo.run/v1alpha1/Attachment", "operationId": "List/storage.halo.run/v1alpha1/Attachment", "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/AttachmentList" } } }, "description": "Response attachments" } }, "tags": [ "storage.halo.run/v1alpha1/Attachment" ] }, "post": { "description": "Create storage.halo.run/v1alpha1/Attachment", "operationId": "Create/storage.halo.run/v1alpha1/Attachment", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "Fresh attachment" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "Response attachments created just now" } }, "tags": [ "storage.halo.run/v1alpha1/Attachment" ] } }, "/apis/storage.halo.run/v1alpha1/attachments/{name}": { "delete": { "description": "Delete storage.halo.run/v1alpha1/Attachment", "operationId": "Delete/storage.halo.run/v1alpha1/Attachment", "parameters": [ { "description": "Name of attachment", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response attachment deleted just now" } }, "tags": [ "storage.halo.run/v1alpha1/Attachment" ] }, "get": { "description": "Get storage.halo.run/v1alpha1/Attachment", "operationId": "Get/storage.halo.run/v1alpha1/Attachment", "parameters": [ { "description": "Name of attachment", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "Response single attachment" } }, "tags": [ "storage.halo.run/v1alpha1/Attachment" ] }, "put": { "description": "Update storage.halo.run/v1alpha1/Attachment", "operationId": "Update/storage.halo.run/v1alpha1/Attachment", "parameters": [ { "description": "Name of attachment", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "Updated attachment" }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "Response attachments updated just now" } }, "tags": [ "storage.halo.run/v1alpha1/Attachment" ] } }, "/apis/storage.halo.run/v1alpha1/groups": { "get": { "description": "List storage.halo.run/v1alpha1/Group", "operationId": "List/storage.halo.run/v1alpha1/Group", "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/GroupList" } } }, "description": "Response groups" } }, "tags": [ "storage.halo.run/v1alpha1/Group" ] }, "post": { "description": "Create storage.halo.run/v1alpha1/Group", "operationId": "Create/storage.halo.run/v1alpha1/Group", "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": [ "storage.halo.run/v1alpha1/Group" ] } }, "/apis/storage.halo.run/v1alpha1/groups/{name}": { "delete": { "description": "Delete storage.halo.run/v1alpha1/Group", "operationId": "Delete/storage.halo.run/v1alpha1/Group", "parameters": [ { "description": "Name of group", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response group deleted just now" } }, "tags": [ "storage.halo.run/v1alpha1/Group" ] }, "get": { "description": "Get storage.halo.run/v1alpha1/Group", "operationId": "Get/storage.halo.run/v1alpha1/Group", "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": [ "storage.halo.run/v1alpha1/Group" ] }, "put": { "description": "Update storage.halo.run/v1alpha1/Group", "operationId": "Update/storage.halo.run/v1alpha1/Group", "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": [ "storage.halo.run/v1alpha1/Group" ] } }, "/apis/storage.halo.run/v1alpha1/policies": { "get": { "description": "List storage.halo.run/v1alpha1/Policy", "operationId": "List/storage.halo.run/v1alpha1/Policy", "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": [ "storage.halo.run/v1alpha1/Policy" ] }, "post": { "description": "Create storage.halo.run/v1alpha1/Policy", "operationId": "Create/storage.halo.run/v1alpha1/Policy", "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": [ "storage.halo.run/v1alpha1/Policy" ] } }, "/apis/storage.halo.run/v1alpha1/policies/{name}": { "delete": { "description": "Delete storage.halo.run/v1alpha1/Policy", "operationId": "Delete/storage.halo.run/v1alpha1/Policy", "parameters": [ { "description": "Name of policy", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response policy deleted just now" } }, "tags": [ "storage.halo.run/v1alpha1/Policy" ] }, "get": { "description": "Get storage.halo.run/v1alpha1/Policy", "operationId": "Get/storage.halo.run/v1alpha1/Policy", "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": [ "storage.halo.run/v1alpha1/Policy" ] }, "put": { "description": "Update storage.halo.run/v1alpha1/Policy", "operationId": "Update/storage.halo.run/v1alpha1/Policy", "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": [ "storage.halo.run/v1alpha1/Policy" ] } }, "/apis/storage.halo.run/v1alpha1/policytemplates": { "get": { "description": "List storage.halo.run/v1alpha1/PolicyTemplate", "operationId": "List/storage.halo.run/v1alpha1/PolicyTemplate", "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": [ "storage.halo.run/v1alpha1/PolicyTemplate" ] }, "post": { "description": "Create storage.halo.run/v1alpha1/PolicyTemplate", "operationId": "Create/storage.halo.run/v1alpha1/PolicyTemplate", "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": [ "storage.halo.run/v1alpha1/PolicyTemplate" ] } }, "/apis/storage.halo.run/v1alpha1/policytemplates/{name}": { "delete": { "description": "Delete storage.halo.run/v1alpha1/PolicyTemplate", "operationId": "Delete/storage.halo.run/v1alpha1/PolicyTemplate", "parameters": [ { "description": "Name of policytemplate", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response policytemplate deleted just now" } }, "tags": [ "storage.halo.run/v1alpha1/PolicyTemplate" ] }, "get": { "description": "Get storage.halo.run/v1alpha1/PolicyTemplate", "operationId": "Get/storage.halo.run/v1alpha1/PolicyTemplate", "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": [ "storage.halo.run/v1alpha1/PolicyTemplate" ] }, "put": { "description": "Update storage.halo.run/v1alpha1/PolicyTemplate", "operationId": "Update/storage.halo.run/v1alpha1/PolicyTemplate", "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": [ "storage.halo.run/v1alpha1/PolicyTemplate" ] } }, "/apis/theme.halo.run/v1alpha1/themes": { "get": { "description": "List theme.halo.run/v1alpha1/Theme", "operationId": "List/theme.halo.run/v1alpha1/Theme", "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": [ "theme.halo.run/v1alpha1/Theme" ] }, "post": { "description": "Create theme.halo.run/v1alpha1/Theme", "operationId": "Create/theme.halo.run/v1alpha1/Theme", "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": [ "theme.halo.run/v1alpha1/Theme" ] } }, "/apis/theme.halo.run/v1alpha1/themes/{name}": { "delete": { "description": "Delete theme.halo.run/v1alpha1/Theme", "operationId": "Delete/theme.halo.run/v1alpha1/Theme", "parameters": [ { "description": "Name of theme", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response theme deleted just now" } }, "tags": [ "theme.halo.run/v1alpha1/Theme" ] }, "get": { "description": "Get theme.halo.run/v1alpha1/Theme", "operationId": "Get/theme.halo.run/v1alpha1/Theme", "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": [ "theme.halo.run/v1alpha1/Theme" ] }, "put": { "description": "Update theme.halo.run/v1alpha1/Theme", "operationId": "Update/theme.halo.run/v1alpha1/Theme", "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": [ "theme.halo.run/v1alpha1/Theme" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/attachments": { "post": { "description": "Create attachment for the given post.", "operationId": "CreateAttachmentForPost", "parameters": [ { "description": "Wait for permalink.", "in": "query", "name": "waitForPermalink", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PostAttachmentRequest" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Attachment" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/posts": { "get": { "description": "List posts owned by the current user.", "operationId": "ListMyPosts", "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" } } }, { "description": "Posts filtered by publish phase.", "in": "query", "name": "publishPhase", "schema": { "type": "string", "enum": [ "DRAFT", "PENDING_APPROVAL", "PUBLISHED", "FAILED" ] } }, { "description": "Posts filtered by keyword.", "in": "query", "name": "keyword", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListedPostList" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] }, "post": { "description": "Create my post. If you want to create a post with content, please set\n annotation: \"content.halo.run/content-json\" into annotations and refer\n to Content for corresponding data type.\n", "operationId": "CreateMyPost", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/posts/{name}": { "get": { "description": "Get post that belongs to the current user.", "operationId": "GetMyPost", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] }, "put": { "description": "Update my post.", "operationId": "UpdateMyPost", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/posts/{name}/draft": { "get": { "description": "Get my post draft.", "operationId": "GetMyPostDraft", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Should include patched content and raw or not.", "in": "query", "name": "patched", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] }, "put": { "description": "Update draft of my post. Please make sure set annotation:\n\"content.halo.run/content-json\" into annotations and refer to\nContent for corresponding data type.\n", "operationId": "UpdateMyPostDraft", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } } }, "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/posts/{name}/publish": { "put": { "description": "Publish my post.", "operationId": "PublishMyPost", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/posts/{name}/unpublish": { "put": { "description": "Unpublish my post.", "operationId": "UnpublishMyPost", "parameters": [ { "description": "Post name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Post" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Post" ] } }, "/apis/uc.api.content.halo.run/v1alpha1/snapshots/{name}": { "get": { "description": "Get snapshot for one post.", "operationId": "GetSnapshotForPost", "parameters": [ { "description": "Snapshot name.", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Post name.", "in": "query", "name": "postName", "required": true, "schema": { "type": "string" } }, { "description": "Should include patched content and raw or not.", "in": "query", "name": "patched", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "description": "default response" } }, "tags": [ "uc.api.content.halo.run/v1alpha1/Snapshot" ] } }, "/login/public-key": { "get": { "description": "Read public key for encrypting password.", "operationId": "GetPublicKey", "responses": { "default": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PublicKeyResponse" } } }, "description": "default response" } }, "tags": [ "Login" ] } } }, "components": { "schemas": { "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" } } }, "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", "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/AuthProvider" } }, "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" } } }, "AuthProviderSpec": { "required": [ "authenticationUrl", "displayName" ], "type": "object", "properties": { "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" }, "priority": { "type": "integer", "format": "int32" }, "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": { "$ref": "#/components/schemas/Backup" } }, "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" } } }, "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", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/CategorySpec" }, "status": { "$ref": "#/components/schemas/CategoryStatus" } } }, "CategoryList": { "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/Category" } }, "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" } } }, "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" }, "priority": { "type": "integer", "format": "int32", "default": 0 }, "slug": { "minLength": 1, "type": "string" }, "template": { "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" } } }, "ChangeOwnPasswordRequest": { "required": [ "oldPassword", "password" ], "type": "object", "properties": { "oldPassword": { "type": "string", "description": "Old password." }, "password": { "minLength": 6, "type": "string", "description": "New password." } } }, "ChangePasswordRequest": { "required": [ "password" ], "type": "object", "properties": { "password": { "minLength": 6, "type": "string", "description": "New password." } } }, "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" } } }, "CommentList": { "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/Comment" } }, "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": { "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" } } }, "CommentStats": { "type": "object", "properties": { "upvote": { "type": "integer", "format": "int32" } } }, "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." }, "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/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" } } }, "CommentWithReplyVo": { "required": [ "metadata", "owner", "spec", "stats" ], "type": "object", "properties": { "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." }, "CommentWithReplyVoList": { "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/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" } } }, "Condition": { "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object", "properties": { "lastTransitionTime": { "type": "string", "format": "date-time" }, "message": { "maxLength": 32768, "type": "string" }, "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" } } }, "ConfigMap": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, "ConfigMapList": { "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/ConfigMap" } }, "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" } } }, "ConfigMapRef": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } } }, "Content": { "type": "object", "properties": { "content": { "type": "string" }, "raw": { "type": "string" }, "rawType": { "type": "string" } } }, "ContentUpdateParam": { "type": "object", "properties": { "content": { "type": "string" }, "raw": { "type": "string" }, "rawType": { "type": "string" }, "version": { "type": "integer", "format": "int64" } } }, "ContentVo": { "type": "object", "properties": { "content": { "type": "string" }, "raw": { "type": "string" } } }, "ContentWrapper": { "type": "object", "properties": { "content": { "type": "string" }, "raw": { "type": "string" }, "rawType": { "type": "string" }, "snapshotName": { "type": "string" } } }, "Contributor": { "type": "object", "properties": { "avatar": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" } } }, "ContributorVo": { "required": [ "metadata" ], "type": "object", "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "displayName": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "permalink": { "type": "string" } } }, "Counter": { "required": [ "apiVersion", "kind", "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" }, "totalComment": { "type": "integer", "format": "int32" }, "upvote": { "type": "integer", "format": "int32" }, "visit": { "type": "integer", "format": "int32" } } }, "CounterList": { "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/Counter" } }, "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" } } }, "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" } } }, "CreateUserRequest": { "required": [ "email", "name" ], "type": "object", "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "avatar": { "type": "string" }, "bio": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" }, "roles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "CustomTemplates": { "type": "object", "properties": { "category": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateDescriptor" } }, "page": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateDescriptor" } }, "post": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateDescriptor" } } } }, "DashboardStats": { "type": "object", "properties": { "approvedComments": { "type": "integer", "format": "int32" }, "comments": { "type": "integer", "format": "int32" }, "posts": { "type": "integer", "format": "int32" }, "upvotes": { "type": "integer", "format": "int32" }, "users": { "type": "integer", "format": "int32" }, "visits": { "type": "integer", "format": "int32" } } }, "DetailedUser": { "required": [ "roles", "user" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "user": { "$ref": "#/components/schemas/User" } } }, "EmailConfigValidationRequest": { "type": "object", "properties": { "displayName": { "type": "string" }, "enable": { "type": "boolean" }, "encryption": { "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "sender": { "type": "string" }, "username": { "type": "string" } } }, "EmailVerifyRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "Excerpt": { "required": [ "autoGenerate" ], "type": "object", "properties": { "autoGenerate": { "type": "boolean", "default": true }, "raw": { "type": "string" } } }, "Extension": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, "ExtensionDefinition": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "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" }, "total": { "type": "integer", "description": "Total elements.", "format": "int64" }, "totalPages": { "type": "integer", "description": "Indicates total pages.", "format": "int64" } } }, "ExtensionPointDefinition": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/ExtensionPointSpec" } } }, "ExtensionPointDefinitionList": { "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/ExtensionPointDefinition" } }, "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" } } }, "ExtensionPointSpec": { "required": [ "className", "displayName", "type" ], "type": "object", "properties": { "className": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "icon": { "type": "string" }, "type": { "type": "string", "enum": [ "SINGLETON", "MULTI_INSTANCE" ] } } }, "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" } } }, "GrantRequest": { "type": "object", "properties": { "roles": { "uniqueItems": true, "type": "array", "items": { "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" } } }, "GroupKind": { "type": "object", "properties": { "group": { "type": "string" }, "kind": { "type": "string" } } }, "GroupList": { "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/Group" } }, "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" } } }, "GroupSpec": { "required": [ "displayName" ], "type": "object", "properties": { "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" }, "updateTimestamp": { "type": "string", "description": "Update timestamp of the group", "format": "date-time" } } }, "IAvatarUploadRequest": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "IUploadRequest": { "required": [ "file", "policyName" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "groupName": { "type": "string", "description": "The name of the group to which the attachment belongs" }, "policyName": { "type": "string", "description": "Storage policy name" } } }, "InstallFromUriRequest": { "required": [ "uri" ], "type": "object", "properties": { "uri": { "type": "string", "format": "uri" } } }, "InterestReason": { "required": [ "reasonType", "subject" ], "type": "object", "properties": { "expression": { "type": "string", "description": "The expression to be interested in" }, "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" }, "License": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } } }, "ListResultReplyVo": { "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/ReplyVo" } }, "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" } } }, "ListedAuthProvider": { "required": [ "displayName", "name" ], "type": "object", "properties": { "authenticationUrl": { "type": "string" }, "bindingUrl": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "helpPage": { "type": "string" }, "isBound": { "type": "boolean" }, "logo": { "type": "string" }, "name": { "type": "string" }, "privileged": { "type": "boolean" }, "supportsBinding": { "type": "boolean" }, "unbindingUrl": { "type": "string" }, "website": { "type": "string" } } }, "ListedComment": { "required": [ "comment", "owner", "stats" ], "type": "object", "properties": { "comment": { "$ref": "#/components/schemas/Comment" }, "owner": { "$ref": "#/components/schemas/OwnerInfo" }, "stats": { "$ref": "#/components/schemas/CommentStats" }, "subject": { "$ref": "#/components/schemas/Extension" } }, "description": "A chunk of items." }, "ListedCommentList": { "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/ListedComment" } }, "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" } } }, "ListedPost": { "required": [ "categories", "contributors", "owner", "post", "stats", "tags" ], "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "contributors": { "type": "array", "items": { "$ref": "#/components/schemas/Contributor" } }, "owner": { "$ref": "#/components/schemas/Contributor" }, "post": { "$ref": "#/components/schemas/Post" }, "stats": { "$ref": "#/components/schemas/Stats" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } }, "description": "A chunk of items." }, "ListedPostList": { "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/ListedPost" } }, "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" } } }, "ListedPostVo": { "required": [ "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/ContributorVo" }, "spec": { "$ref": "#/components/schemas/PostSpec" }, "stats": { "$ref": "#/components/schemas/StatsVo" }, "status": { "$ref": "#/components/schemas/PostStatus" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagVo" } } } }, "ListedPostVoList": { "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/ListedPostVo" } }, "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" } } }, "ListedReply": { "required": [ "owner", "reply", "stats" ], "type": "object", "properties": { "owner": { "$ref": "#/components/schemas/OwnerInfo" }, "reply": { "$ref": "#/components/schemas/Reply" }, "stats": { "$ref": "#/components/schemas/CommentStats" } }, "description": "A chunk of items." }, "ListedReplyList": { "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/ListedReply" } }, "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" } } }, "ListedSinglePage": { "required": [ "contributors", "owner", "page", "stats" ], "type": "object", "properties": { "contributors": { "type": "array", "items": { "$ref": "#/components/schemas/Contributor" } }, "owner": { "$ref": "#/components/schemas/Contributor" }, "page": { "$ref": "#/components/schemas/SinglePage" }, "stats": { "$ref": "#/components/schemas/Stats" } }, "description": "A chunk of items." }, "ListedSinglePageList": { "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/ListedSinglePage" } }, "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" } } }, "ListedSinglePageVo": { "required": [ "metadata" ], "type": "object", "properties": { "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" } }, "description": "A chunk of items." }, "ListedSinglePageVoList": { "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/ListedSinglePageVo" } }, "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" } } }, "ListedSnapshotDto": { "required": [ "metadata", "spec" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/ListedSnapshotSpec" } } }, "ListedSnapshotSpec": { "required": [ "owner" ], "type": "object", "properties": { "modifyTime": { "type": "string", "format": "date-time" }, "owner": { "type": "string" } } }, "ListedUser": { "required": [ "roles", "user" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "user": { "$ref": "#/components/schemas/User" } }, "description": "A chunk of items." }, "LoginHistory": { "required": [ "loginAt", "sourceIp", "successful", "userAgent" ], "type": "object", "properties": { "loginAt": { "type": "string", "format": "date-time" }, "reason": { "type": "string" }, "sourceIp": { "type": "string" }, "successful": { "type": "boolean" }, "userAgent": { "type": "string" } } }, "MarkSpecifiedRequest": { "type": "object", "properties": { "names": { "type": "array", "items": { "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": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/MenuItemSpec" }, "status": { "$ref": "#/components/schemas/MenuItemStatus" } } }, "MenuItemList": { "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/MenuItem" } }, "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" } } }, "MenuItemSpec": { "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" ] }, "targetRef": { "$ref": "#/components/schemas/Ref" } }, "description": "The spec of menu item." }, "MenuItemStatus": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Calculated Display name of menu item." }, "href": { "type": "string", "description": "Calculated href of manu item." } }, "description": "The status of menu item." }, "MenuItemVo": { "required": [ "metadata" ], "type": "object", "properties": { "displayName": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "parentName": { "type": "string" }, "spec": { "$ref": "#/components/schemas/MenuItemSpec" }, "status": { "$ref": "#/components/schemas/MenuItemStatus" } } }, "MenuList": { "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/Menu" } }, "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" } } }, "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." }, "MenuVo": { "required": [ "metadata" ], "type": "object", "properties": { "menuItems": { "type": "array", "items": { "$ref": "#/components/schemas/MenuItemVo" } }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/MenuSpec" } } }, "Metadata": { "required": [ "name" ], "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 } }, "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 } } }, "NavigationPostVo": { "type": "object", "properties": { "current": { "$ref": "#/components/schemas/PostVo" }, "next": { "$ref": "#/components/schemas/PostVo" }, "previous": { "$ref": "#/components/schemas/PostVo" } } }, "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" } } }, "NotificationTemplate": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/NotificationTemplateSpec" } } }, "NotificationTemplateList": { "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/NotificationTemplate" } }, "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" } } }, "NotificationTemplateSpec": { "type": "object", "properties": { "reasonSelector": { "$ref": "#/components/schemas/ReasonSelector" }, "template": { "$ref": "#/components/schemas/TemplateContent" } } }, "NotifierDescriptor": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/NotifierDescriptorSpec" } } }, "NotifierDescriptorList": { "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/NotifierDescriptor" } }, "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" } } }, "NotifierDescriptorSpec": { "required": [ "displayName", "notifierExtName" ], "type": "object", "properties": { "description": { "type": "string" }, "displayName": { "minLength": 1, "type": "string" }, "notifierExtName": { "minLength": 1, "type": "string" }, "receiverSettingRef": { "$ref": "#/components/schemas/NotifierSettingRef" }, "senderSettingRef": { "$ref": "#/components/schemas/NotifierSettingRef" } } }, "NotifierInfo": { "type": "object", "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" } } }, "NotifierSettingRef": { "required": [ "group", "name" ], "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" } } }, "OwnerInfo": { "type": "object", "properties": { "avatar": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" } } }, "PasswordRequest": { "required": [ "password" ], "type": "object", "properties": { "password": { "type": "string" } } }, "PasswordResetEmailRequest": { "required": [ "email", "username" ], "type": "object", "properties": { "email": { "type": "string" }, "username": { "type": "string" } } }, "PatSpec": { "required": [ "name", "tokenId", "username" ], "type": "object", "properties": { "description": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "lastUsed": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "revoked": { "type": "boolean" }, "revokesAt": { "type": "string", "format": "date-time" }, "roles": { "type": "array", "items": { "type": "string" } }, "scopes": { "type": "array", "items": { "type": "string" } }, "tokenId": { "type": "string" }, "username": { "type": "string" } } }, "PersonalAccessToken": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/PatSpec" } } }, "PersonalAccessTokenList": { "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/PersonalAccessToken" } }, "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" } } }, "Plugin": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/PluginSpec" }, "status": { "$ref": "#/components/schemas/PluginStatus" } } }, "PluginAuthor": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "website": { "type": "string" } } }, "PluginInstallRequest": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "presetName": { "type": "string", "description": "Plugin preset name. We will find the plugin from plugin presets" }, "source": { "type": "string", "description": "Install source. Default is file.", "enum": [ "FILE", "PRESET", "URL" ] } } }, "PluginList": { "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/Plugin" } }, "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" } } }, "PluginRunningStateRequest": { "type": "object", "properties": { "async": { "type": "boolean" }, "enable": { "type": "boolean" } } }, "PluginSpec": { "required": [ "version" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/PluginAuthor" }, "configMapName": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "homepage": { "type": "string" }, "issues": { "type": "string" }, "license": { "type": "array", "items": { "$ref": "#/components/schemas/License" } }, "logo": { "type": "string" }, "pluginClass": { "type": "string", "deprecated": true }, "pluginDependencies": { "type": "object", "additionalProperties": { "type": "string" } }, "repo": { "type": "string" }, "requires": { "type": "string" }, "settingName": { "type": "string" }, "version": { "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "type": "string" } } }, "PluginStatus": { "type": "object", "properties": { "conditions": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "$ref": "#/components/schemas/Condition" } }, "entry": { "type": "string" }, "lastProbeState": { "type": "string", "enum": [ "CREATED", "DISABLED", "RESOLVED", "STARTED", "STOPPED", "FAILED", "UNLOADED" ] }, "lastStartTime": { "type": "string", "format": "date-time" }, "loadLocation": { "type": "string", "description": "Load location of the plugin, often a path.", "format": "uri" }, "logo": { "type": "string" }, "phase": { "type": "string", "enum": [ "PENDING", "STARTING", "CREATED", "DISABLED", "RESOLVED", "STARTED", "STOPPED", "FAILED", "UNKNOWN" ] }, "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" } } }, "Post": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/PostSpec" }, "status": { "$ref": "#/components/schemas/PostStatus" } } }, "PostAttachmentRequest": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "postName": { "type": "string", "description": "Post name." }, "singlePageName": { "type": "string", "description": "Single page name." } } }, "PostHit": { "type": "object", "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "permalink": { "type": "string" }, "publishTimestamp": { "type": "string", "format": "date-time" }, "title": { "type": "string" } } }, "PostHits": { "type": "object", "properties": { "hits": { "type": "array", "items": { "$ref": "#/components/schemas/PostHit" } }, "keyword": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "processingTimeMillis": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "PostList": { "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/Post" } }, "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" } } }, "PostRequest": { "required": [ "post" ], "type": "object", "properties": { "content": { "$ref": "#/components/schemas/ContentUpdateParam" }, "post": { "$ref": "#/components/schemas/Post" } } }, "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", "enum": [ "PUBLIC", "INTERNAL", "PRIVATE" ], "default": "PUBLIC" } } }, "PostStatus": { "required": [ "phase" ], "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" }, "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" }, "status": { "$ref": "#/components/schemas/PostStatus" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagVo" } } } }, "PublicKeyResponse": { "type": "object", "properties": { "base64Format": { "type": "string" } } }, "Reason": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/ReasonSpec" } } }, "ReasonList": { "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/Reason" } }, "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" } } }, "ReasonProperty": { "required": [ "name", "type" ], "type": "object", "properties": { "description": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "optional": { "type": "boolean", "default": false }, "type": { "minLength": 1, "type": "string" } } }, "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": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "description": "Attributes used to transfer data" }, "author": { "type": "string" }, "reasonType": { "type": "string" }, "subject": { "$ref": "#/components/schemas/ReasonSubject" } } }, "ReasonSubject": { "required": [ "apiVersion", "kind", "name", "title" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "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" } } }, "ReasonTypeInfo": { "type": "object", "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "uiPermissions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "ReasonTypeList": { "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/ReasonType" } }, "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" } } }, "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" } } }, "ReasonTypeSpec": { "required": [ "description", "displayName" ], "type": "object", "properties": { "description": { "minLength": 1, "type": "string" }, "displayName": { "minLength": 1, "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ReasonProperty" } } } }, "Ref": { "required": [ "name" ], "type": "object", "properties": { "group": { "type": "string", "description": "Extension group" }, "kind": { "type": "string", "description": "Extension kind" }, "name": { "type": "string", "description": "Extension name. This field is mandatory" }, "version": { "type": "string", "description": "Extension version" } }, "description": "Extension reference object. The name is mandatory" }, "RegisterVerifyEmailRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "Reply": { "required": [ "apiVersion", "kind", "metadata", "spec", "status" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/ReplySpec" }, "status": { "$ref": "#/components/schemas/ReplyStatus" } } }, "ReplyList": { "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/Reply" } }, "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" } } }, "ReplyRequest": { "required": [ "content", "raw" ], "type": "object", "properties": { "allowNotification": { "type": "boolean", "default": false }, "content": { "minLength": 1, "type": "string" }, "owner": { "$ref": "#/components/schemas/CommentEmailOwner" }, "quoteReply": { "type": "string" }, "raw": { "minLength": 1, "type": "string" } } }, "ReplySpec": { "required": [ "allowNotification", "approved", "commentName", "content", "hidden", "owner", "priority", "raw", "top" ], "type": "object", "properties": { "allowNotification": { "type": "boolean", "default": true }, "approved": { "type": "boolean", "default": false }, "approvedTime": { "type": "string", "format": "date-time" }, "commentName": { "minLength": 1, "type": "string" }, "content": { "minLength": 1, "type": "string" }, "creationTime": { "type": "string", "format": "date-time" }, "hidden": { "type": "boolean", "default": false }, "ipAddress": { "type": "string" }, "owner": { "$ref": "#/components/schemas/CommentOwner" }, "priority": { "type": "integer", "format": "int32", "default": 0 }, "quoteReply": { "type": "string" }, "raw": { "minLength": 1, "type": "string" }, "top": { "type": "boolean", "default": false }, "userAgent": { "type": "string" } } }, "ReplyStatus": { "type": "object", "properties": { "observedVersion": { "type": "integer", "format": "int64" } } }, "ReplyVo": { "required": [ "metadata", "owner", "spec", "stats" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "owner": { "$ref": "#/components/schemas/OwnerInfo" }, "spec": { "$ref": "#/components/schemas/ReplySpec" }, "stats": { "$ref": "#/components/schemas/CommentStatsVo" } }, "description": "A chunk of items." }, "ReplyVoList": { "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/ReplyVo" } }, "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" } } }, "ResetPasswordRequest": { "required": [ "newPassword", "token" ], "type": "object", "properties": { "newPassword": { "minLength": 6, "type": "string" }, "token": { "type": "string" } } }, "RestoreRequest": { "type": "object", "properties": { "backupName": { "type": "string", "description": "Backup metadata name." }, "downloadUrl": { "type": "string", "description": "Remote backup HTTP URL." }, "file": { "type": "string", "format": "binary" } } }, "ReverseProxy": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/ReverseProxyRule" } } } }, "ReverseProxyList": { "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/ReverseProxy" } }, "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" } } }, "ReverseProxyRule": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/FileReverseProxyProvider" }, "path": { "type": "string" } } }, "RevertSnapshotForPostParam": { "required": [ "snapshotName" ], "type": "object", "properties": { "snapshotName": { "minLength": 1, "type": "string" } } }, "RevertSnapshotForSingleParam": { "required": [ "snapshotName" ], "type": "object", "properties": { "snapshotName": { "minLength": 1, "type": "string" } } }, "Role": { "required": [ "apiVersion", "kind", "metadata", "rules" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyRule" } } } }, "RoleBinding": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "roleRef": { "$ref": "#/components/schemas/RoleRef" }, "subjects": { "type": "array", "items": { "$ref": "#/components/schemas/Subject" } } } }, "RoleBindingList": { "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/RoleBinding" } }, "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" } } }, "RoleList": { "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/Role" } }, "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" } } }, "RoleRef": { "type": "object", "properties": { "apiGroup": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" } } }, "SearchEngine": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/SearchEngineSpec" } } }, "SearchEngineList": { "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/SearchEngine" } }, "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" } } }, "SearchEngineSpec": { "required": [ "displayName" ], "type": "object", "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "logo": { "type": "string" }, "postSearchImpl": { "type": "string" }, "settingRef": { "$ref": "#/components/schemas/Ref" }, "website": { "type": "string" } } }, "Secret": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "stringData": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string" } } }, "SecretList": { "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/Secret" } }, "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" } } }, "Setting": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/SettingSpec" } } }, "SettingForm": { "minLength": 1, "required": [ "formSchema", "group" ], "type": "object", "properties": { "formSchema": { "type": "array", "items": { "type": "object" } }, "group": { "type": "string" }, "label": { "type": "string" } } }, "SettingList": { "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/Setting" } }, "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" } } }, "SettingRef": { "required": [ "group", "name" ], "type": "object", "properties": { "group": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } } }, "SettingSpec": { "required": [ "forms" ], "type": "object", "properties": { "forms": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/SettingForm" } } } }, "SignUpRequest": { "required": [ "password", "user" ], "type": "object", "properties": { "password": { "minLength": 6, "type": "string" }, "user": { "$ref": "#/components/schemas/User" }, "verifyCode": { "maxLength": 6, "minLength": 6, "type": "string" } } }, "SinglePage": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/SinglePageSpec" }, "status": { "$ref": "#/components/schemas/SinglePageStatus" } } }, "SinglePageList": { "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/SinglePage" } }, "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" } } }, "SinglePageRequest": { "required": [ "content", "page" ], "type": "object", "properties": { "content": { "$ref": "#/components/schemas/ContentUpdateParam" }, "page": { "$ref": "#/components/schemas/SinglePage" } } }, "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", "enum": [ "PUBLIC", "INTERNAL", "PRIVATE" ], "default": "PUBLIC" } } }, "SinglePageStatus": { "required": [ "phase" ], "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" }, "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": { "category": { "type": "integer", "format": "int32" }, "comment": { "type": "integer", "format": "int32" }, "post": { "type": "integer", "format": "int32" }, "upvote": { "type": "integer", "format": "int32" }, "visit": { "type": "integer", "format": "int32" } } }, "SnapShotSpec": { "required": [ "owner", "rawType", "subjectRef" ], "type": "object", "properties": { "contentPatch": { "type": "string" }, "contributors": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "lastModifyTime": { "type": "string", "format": "date-time" }, "owner": { "minLength": 1, "type": "string" }, "parentSnapshotName": { "type": "string" }, "rawPatch": { "type": "string" }, "rawType": { "maxLength": 50, "minLength": 1, "type": "string" }, "subjectRef": { "$ref": "#/components/schemas/Ref" } } }, "Snapshot": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/SnapShotSpec" } } }, "SnapshotList": { "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/Snapshot" } }, "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" } } }, "Stats": { "type": "object", "properties": { "approvedComment": { "type": "integer", "format": "int32" }, "totalComment": { "type": "integer", "format": "int32" }, "upvote": { "type": "integer", "format": "int32" }, "visit": { "type": "integer", "format": "int32" } } }, "StatsVo": { "type": "object", "properties": { "comment": { "type": "integer", "format": "int32" }, "upvote": { "type": "integer", "format": "int32" }, "visit": { "type": "integer", "format": "int32" } } }, "Subject": { "type": "object", "properties": { "apiGroup": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" } } }, "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": { "type": "object", "properties": { "name": { "type": "string" } }, "description": "The subscriber to be notified" }, "SystemInitializationRequest": { "required": [ "password", "username" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "minLength": 3, "type": "string" }, "siteTitle": { "type": "string" }, "username": { "minLength": 1, "type": "string" } } }, "Tag": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/TagSpec" }, "status": { "$ref": "#/components/schemas/TagStatus" } } }, "TagList": { "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/Tag" } }, "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" } } }, "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" } } }, "TemplateContent": { "required": [ "title" ], "type": "object", "properties": { "htmlBody": { "type": "string" }, "rawBody": { "type": "string" }, "title": { "minLength": 1, "type": "string" } } }, "TemplateDescriptor": { "required": [ "file", "name" ], "type": "object", "properties": { "description": { "type": "string" }, "file": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "screenshot": { "type": "string" } } }, "Theme": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/ThemeSpec" }, "status": { "$ref": "#/components/schemas/ThemeStatus" } } }, "ThemeInstallRequest": { "type": "object" }, "ThemeList": { "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/Theme" } }, "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" } } }, "ThemeSpec": { "required": [ "author", "displayName", "version" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/Author" }, "configMapName": { "type": "string" }, "customTemplates": { "$ref": "#/components/schemas/CustomTemplates" }, "description": { "type": "string" }, "displayName": { "minLength": 1, "type": "string" }, "homepage": { "type": "string" }, "issues": { "type": "string" }, "license": { "type": "array", "items": { "$ref": "#/components/schemas/License" } }, "logo": { "type": "string" }, "repo": { "type": "string" }, "require": { "type": "string", "description": "Deprecated, use `requires` instead.", "deprecated": true }, "requires": { "type": "string" }, "settingName": { "type": "string" }, "version": { "type": "string" }, "website": { "type": "string", "deprecated": true } } }, "ThemeStatus": { "type": "object", "properties": { "conditions": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "$ref": "#/components/schemas/Condition" } }, "location": { "type": "string" }, "phase": { "type": "string", "enum": [ "READY", "FAILED", "UNKNOWN" ] } } }, "TotpAuthLinkResponse": { "type": "object", "properties": { "authLink": { "type": "string", "format": "uri" }, "rawSecret": { "type": "string" } } }, "TotpRequest": { "required": [ "code", "password", "secret" ], "type": "object", "properties": { "code": { "type": "string" }, "password": { "type": "string" }, "secret": { "type": "string" } } }, "TwoFactorAuthSettings": { "type": "object", "properties": { "available": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "enabled": { "type": "boolean" }, "totpConfigured": { "type": "boolean" } } }, "UpgradeFromUriRequest": { "required": [ "uri" ], "type": "object", "properties": { "uri": { "type": "string", "format": "uri" } } }, "UpgradeRequest": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "User": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/UserSpec" }, "status": { "$ref": "#/components/schemas/UserStatus" } } }, "UserConnection": { "required": [ "apiVersion", "kind", "metadata", "spec" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "spec": { "$ref": "#/components/schemas/UserConnectionSpec" } } }, "UserConnectionList": { "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/UserConnection" } }, "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" } } }, "UserConnectionSpec": { "required": [ "accessToken", "displayName", "providerUserId", "registrationId", "username" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "profileUrl": { "type": "string" }, "providerUserId": { "type": "string" }, "refreshToken": { "type": "string" }, "registrationId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "username": { "type": "string" } } }, "UserEndpoint.ListedUserList": { "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/ListedUser" } }, "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" } } }, "UserList": { "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/User" } }, "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" } } }, "UserPermission": { "required": [ "permissions", "roles", "uiPermissions" ], "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "roles": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "uiPermissions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "UserSpec": { "required": [ "displayName", "email" ], "type": "object", "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "disabled": { "type": "boolean" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "loginHistoryLimit": { "type": "integer", "format": "int32" }, "password": { "type": "string" }, "phone": { "type": "string" }, "registeredAt": { "type": "string", "format": "date-time" }, "totpEncryptedSecret": { "type": "string" }, "twoFactorAuthEnabled": { "type": "boolean" } } }, "UserStatus": { "type": "object", "properties": { "lastLoginAt": { "type": "string", "format": "date-time" }, "loginHistories": { "type": "array", "items": { "$ref": "#/components/schemas/LoginHistory" } }, "permalink": { "type": "string" } } }, "VerifyCodeRequest": { "required": [ "code", "password" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "password": { "type": "string" } } }, "VoteRequest": { "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" }, "plural": { "type": "string" } } } }, "securitySchemes": { "BasicAuth": { "scheme": "basic", "type": "http" }, "BearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } } }