You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@answer.apache.org by ku...@apache.org on 2024/08/23 03:39:19 UTC

(incubator-answer) branch test updated (2cc47835 -> 6214fed8)

This is an automated email from the ASF dual-hosted git repository.

kumfo pushed a change to branch test
in repository https://gitbox.apache.org/repos/asf/incubator-answer.git


    from 2cc47835 Merge branch 'feat/1.4.0/config' into test
     new 1af1f77a feat: Add RenderController to handle rendering configuration
     new 6214fed8 docs: Add render api

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 cmd/wire_gen.go                                    |  3 +-
 docs/docs.go                                       | 53 +++++++++++++++++++++-
 docs/swagger.json                                  | 53 +++++++++++++++++++++-
 docs/swagger.yaml                                  | 31 ++++++++++++-
 internal/controller/controller.go                  |  1 +
 .../{embed_controller.go => render_controller.go}  | 30 ++++++------
 internal/router/plugin_api_router.go               |  4 ++
 plugin/plugin.go                                   |  4 ++
 plugin/{embed.go => render.go}                     | 15 +++---
 9 files changed, 166 insertions(+), 28 deletions(-)
 copy internal/controller/{embed_controller.go => render_controller.go} (63%)
 copy plugin/{embed.go => render.go} (79%)


(incubator-answer) 01/02: feat: Add RenderController to handle rendering configuration

Posted by ku...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

kumfo pushed a commit to branch test
in repository https://gitbox.apache.org/repos/asf/incubator-answer.git

commit 1af1f77a60afb2adec3034e06118c0d70610fffd
Author: robin <ro...@rnode.me>
AuthorDate: Fri Aug 23 11:10:31 2024 +0800

    feat: Add RenderController to handle rendering configuration
---
 cmd/wire_gen.go                                    |  3 +-
 internal/controller/controller.go                  |  1 +
 .../{controller.go => render_controller.go}        | 63 +++++++++++-----------
 internal/router/plugin_api_router.go               |  4 ++
 plugin/plugin.go                                   |  4 ++
 .../controller/controller.go => plugin/render.go   | 50 ++++++-----------
 6 files changed, 58 insertions(+), 67 deletions(-)

diff --git a/cmd/wire_gen.go b/cmd/wire_gen.go
index cc245aea..940c0dc1 100644
--- a/cmd/wire_gen.go
+++ b/cmd/wire_gen.go
@@ -282,7 +282,8 @@ func initApplication(debug bool, serverConf *conf.Server, dbConf *data.Database,
 	userCenterController := controller.NewUserCenterController(userCenterLoginService, siteInfoCommonService)
 	captchaController := controller.NewCaptchaController()
 	embedController := controller.NewEmbedController()
-	pluginAPIRouter := router.NewPluginAPIRouter(connectorController, userCenterController, captchaController, embedController)
+	renderController := controller.NewRenderController()
+	pluginAPIRouter := router.NewPluginAPIRouter(connectorController, userCenterController, captchaController, embedController, renderController)
 	ginEngine := server.NewHTTPServer(debug, staticRouter, answerAPIRouter, swaggerRouter, uiRouter, authUserMiddleware, avatarMiddleware, shortIDMiddleware, templateRouter, pluginAPIRouter, uiConf)
 	scheduledTaskManager := cron.NewScheduledTaskManager(siteInfoCommonService, questionService)
 	application := newApplication(serverConf, ginEngine, scheduledTaskManager)
diff --git a/internal/controller/controller.go b/internal/controller/controller.go
index 8fad918a..cbf80f7f 100644
--- a/internal/controller/controller.go
+++ b/internal/controller/controller.go
@@ -52,4 +52,5 @@ var ProviderSetController = wire.NewSet(
 	NewMetaController,
 	NewEmbedController,
 	NewBadgeController,
+	NewRenderController,
 )
diff --git a/internal/controller/controller.go b/internal/controller/render_controller.go
similarity index 51%
copy from internal/controller/controller.go
copy to internal/controller/render_controller.go
index 8fad918a..05e49d0b 100644
--- a/internal/controller/controller.go
+++ b/internal/controller/render_controller.go
@@ -19,37 +19,34 @@
 
 package controller
 
-import "github.com/google/wire"
-
-// ProviderSetController is controller providers.
-var ProviderSetController = wire.NewSet(
-	NewLangController,
-	NewCommentController,
-	NewReportController,
-	NewVoteController,
-	NewTagController,
-	NewFollowController,
-	NewCollectionController,
-	NewUserController,
-	NewQuestionController,
-	NewAnswerController,
-	NewSearchController,
-	NewRevisionController,
-	NewRankController,
-	NewReasonController,
-	NewNotificationController,
-	NewSiteInfoController,
-	NewDashboardController,
-	NewUploadController,
-	NewActivityController,
-	NewTemplateController,
-	NewConnectorController,
-	NewUserCenterController,
-	NewPermissionController,
-	NewUserPluginController,
-	NewReviewController,
-	NewCaptchaController,
-	NewMetaController,
-	NewEmbedController,
-	NewBadgeController,
+import (
+	"github.com/apache/incubator-answer/internal/base/handler"
+	"github.com/apache/incubator-answer/plugin"
+	"github.com/gin-gonic/gin"
 )
+
+type RenderController struct {
+}
+
+func NewRenderController() *RenderController {
+	return &RenderController{}
+}
+
+// GetRenderConfig godoc
+// @Summary GetRenderConfig
+// @Description GetRenderConfig
+// @Tags PluginRender
+// @Accept json
+// @Produce json
+// @Router /answer/api/v1/render/config [get]
+// @Success 200 {object} handler.RespBody{data=plugin.RenderConfig}
+func (c *RenderController) GetRenderConfig(ctx *gin.Context) {
+	var resp *plugin.RenderConfig
+
+	_ = plugin.CallRender(func(render plugin.Render) (err error) {
+		resp = render.GetRenderConfig(ctx)
+		return nil
+	})
+
+	handler.HandleResponse(ctx, nil, resp)
+}
diff --git a/internal/router/plugin_api_router.go b/internal/router/plugin_api_router.go
index e4a85a15..e69e0b6b 100644
--- a/internal/router/plugin_api_router.go
+++ b/internal/router/plugin_api_router.go
@@ -29,6 +29,7 @@ type PluginAPIRouter struct {
 	userCenterController *controller.UserCenterController
 	captchaController    *controller.CaptchaController
 	embedController      *controller.EmbedController
+	renderController     *controller.RenderController
 }
 
 func NewPluginAPIRouter(
@@ -36,12 +37,14 @@ func NewPluginAPIRouter(
 	userCenterController *controller.UserCenterController,
 	captchaController *controller.CaptchaController,
 	embedController *controller.EmbedController,
+	renderController *controller.RenderController,
 ) *PluginAPIRouter {
 	return &PluginAPIRouter{
 		connectorController:  connectorController,
 		userCenterController: userCenterController,
 		captchaController:    captchaController,
 		embedController:      embedController,
+		renderController:     renderController,
 	}
 }
 
@@ -64,6 +67,7 @@ func (pr *PluginAPIRouter) RegisterUnAuthConnectorRouter(r *gin.RouterGroup) {
 	// captcha plugin
 	r.GET("/captcha/config", pr.captchaController.GetCaptchaConfig)
 	r.GET("/embed/config", pr.embedController.GetEmbedConfig)
+	r.GET("/render/config", pr.renderController.GetRenderConfig)
 }
 
 func (pr *PluginAPIRouter) RegisterAuthUserConnectorRouter(r *gin.RouterGroup) {
diff --git a/plugin/plugin.go b/plugin/plugin.go
index 85286855..9c144346 100644
--- a/plugin/plugin.go
+++ b/plugin/plugin.go
@@ -103,6 +103,10 @@ func Register(p Base) {
 		registerEmbed(p.(Embed))
 	}
 
+	if _, ok := p.(Render); ok {
+		registerRender(p.(Render))
+	}
+
 	if _, ok := p.(CDN); ok {
 		registerCDN(p.(CDN))
 	}
diff --git a/internal/controller/controller.go b/plugin/render.go
similarity index 51%
copy from internal/controller/controller.go
copy to plugin/render.go
index 8fad918a..4fc2edf6 100644
--- a/internal/controller/controller.go
+++ b/plugin/render.go
@@ -17,39 +17,23 @@
  * under the License.
  */
 
-package controller
+package plugin
 
-import "github.com/google/wire"
+import "github.com/gin-gonic/gin"
 
-// ProviderSetController is controller providers.
-var ProviderSetController = wire.NewSet(
-	NewLangController,
-	NewCommentController,
-	NewReportController,
-	NewVoteController,
-	NewTagController,
-	NewFollowController,
-	NewCollectionController,
-	NewUserController,
-	NewQuestionController,
-	NewAnswerController,
-	NewSearchController,
-	NewRevisionController,
-	NewRankController,
-	NewReasonController,
-	NewNotificationController,
-	NewSiteInfoController,
-	NewDashboardController,
-	NewUploadController,
-	NewActivityController,
-	NewTemplateController,
-	NewConnectorController,
-	NewUserCenterController,
-	NewPermissionController,
-	NewUserPluginController,
-	NewReviewController,
-	NewCaptchaController,
-	NewMetaController,
-	NewEmbedController,
-	NewBadgeController,
+type RenderConfig struct {
+	SelectTheme string `json:"select_theme"`
+}
+
+// select_theme
+
+type Render interface {
+	Base
+	GetRenderConfig(ctx *gin.Context) (renderConfig *RenderConfig)
+}
+
+var (
+	// CallReviewer is a function that calls all registered parsers
+	CallRender,
+	registerRender = MakePlugin[Render](false)
 )


(incubator-answer) 02/02: docs: Add render api

Posted by ku...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

kumfo pushed a commit to branch test
in repository https://gitbox.apache.org/repos/asf/incubator-answer.git

commit 6214fed8ae75ac01df5ec937348e295b032e29ed
Author: robin <ro...@rnode.me>
AuthorDate: Fri Aug 23 11:24:41 2024 +0800

    docs: Add render api
---
 docs/docs.go      | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 docs/swagger.json | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 docs/swagger.yaml | 31 ++++++++++++++++++++++++++++++-
 3 files changed, 132 insertions(+), 5 deletions(-)

diff --git a/docs/docs.go b/docs/docs.go
index daef6851..389f3bdf 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -4854,6 +4854,41 @@ const docTemplate = `{
                 }
             }
         },
+        "/answer/api/v1/render/config": {
+            "get": {
+                "description": "GetRenderConfig",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "PluginRender"
+                ],
+                "summary": "GetRenderConfig",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "allOf": [
+                                {
+                                    "$ref": "#/definitions/handler.RespBody"
+                                },
+                                {
+                                    "type": "object",
+                                    "properties": {
+                                        "data": {
+                                            "$ref": "#/definitions/plugin.RenderConfig"
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                }
+            }
+        },
         "/answer/api/v1/report": {
             "post": {
                 "security": [
@@ -7420,6 +7455,14 @@ const docTemplate = `{
                 }
             }
         },
+        "plugin.RenderConfig": {
+            "type": "object",
+            "properties": {
+                "select_theme": {
+                    "type": "string"
+                }
+            }
+        },
         "schema.AcceptAnswerReq": {
             "type": "object",
             "required": [
@@ -9257,10 +9300,16 @@ const docTemplate = `{
         },
         "schema.NotificationClearRequest": {
             "type": "object",
+            "required": [
+                "type"
+            ],
             "properties": {
                 "type": {
-                    "description": "inbox achievement",
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                        "inbox",
+                        "achievement"
+                    ]
                 }
             }
         },
diff --git a/docs/swagger.json b/docs/swagger.json
index c7ad452e..3d6f07c8 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -4828,6 +4828,41 @@
                 }
             }
         },
+        "/answer/api/v1/render/config": {
+            "get": {
+                "description": "GetRenderConfig",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "PluginRender"
+                ],
+                "summary": "GetRenderConfig",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "allOf": [
+                                {
+                                    "$ref": "#/definitions/handler.RespBody"
+                                },
+                                {
+                                    "type": "object",
+                                    "properties": {
+                                        "data": {
+                                            "$ref": "#/definitions/plugin.RenderConfig"
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                }
+            }
+        },
         "/answer/api/v1/report": {
             "post": {
                 "security": [
@@ -7394,6 +7429,14 @@
                 }
             }
         },
+        "plugin.RenderConfig": {
+            "type": "object",
+            "properties": {
+                "select_theme": {
+                    "type": "string"
+                }
+            }
+        },
         "schema.AcceptAnswerReq": {
             "type": "object",
             "required": [
@@ -9231,10 +9274,16 @@
         },
         "schema.NotificationClearRequest": {
             "type": "object",
+            "required": [
+                "type"
+            ],
             "properties": {
                 "type": {
-                    "description": "inbox achievement",
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                        "inbox",
+                        "achievement"
+                    ]
                 }
             }
         },
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 1cf29862..d2d43504 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -135,6 +135,11 @@ definitions:
       platform:
         type: string
     type: object
+  plugin.RenderConfig:
+    properties:
+      select_theme:
+        type: string
+    type: object
   schema.AcceptAnswerReq:
     properties:
       answer_id:
@@ -1414,8 +1419,12 @@ definitions:
   schema.NotificationClearRequest:
     properties:
       type:
-        description: inbox achievement
+        enum:
+        - inbox
+        - achievement
         type: string
+    required:
+    - type
     type: object
   schema.OnCompleteAction:
     properties:
@@ -5817,6 +5826,26 @@ paths:
       summary: get reasons by object type and action
       tags:
       - reason
+  /answer/api/v1/render/config:
+    get:
+      consumes:
+      - application/json
+      description: GetRenderConfig
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            allOf:
+            - $ref: '#/definitions/handler.RespBody'
+            - properties:
+                data:
+                  $ref: '#/definitions/plugin.RenderConfig'
+              type: object
+      summary: GetRenderConfig
+      tags:
+      - PluginRender
   /answer/api/v1/report:
     post:
       consumes: