dosubot[bot] commented on issue #8181:
URL: 
https://github.com/apache/incubator-devlake/issues/8181#issuecomment-2588898700

   <!-- Answer -->
   To configure the AE plugin in DevLake, follow these steps:
   
   1. **Create a Connection**: Use the `PostConnections` endpoint to create a 
new AE connection. You need to send a JSON body with the connection details.
   
      ```go
      // @Summary create ae connection
      // @Description Create AE connection
      // @Tags plugins/ae
      // @Param body body models.AeConnection true "json body"
      // @Success 200 {object} models.AeConnection "Success"
      // @Failure 400  {string} errcode.Error "Bad Request"
      // @Failure 500  {string} errcode.Error "Internal Error"
      // @Router /plugins/ae/connections [POST]
      ```
   
   2. **Test the Connection**: After creating the connection, test it using the 
`TestConnection` endpoint to ensure it is set up correctly.
   
      ```go
      // TestConnection test ae connection
      // @Summary test ae connection
      // @Description Test AE Connection
      // @Tags plugins/ae
      // @Param body body models.AeConn true "json body"
      // @Success 200  {object} shared.ApiBody "Success"
      // @Failure 400  {string} errcode.Error "Bad Request"
      // @Failure 500  {string} errcode.Error "Internal Error"
      // @Router /plugins/ae/test [POST]
      ```
   
   3. **Manage Connections**: You can list, get details, update, or delete 
connections using the respective endpoints (`ListConnections`, `GetConnection`, 
`PatchConnection`, `DeleteConnection`).
   
   These steps should help you configure the AE plugin in DevLake 
<sup>[[1]](https://github.com/apache/incubator-devlake/blob/main/backend/plugins/ae/api/connection.go)</sup>.
   
   
   <!-- Dosu Comment Footer -->
   *To continue talking to [Dosu](https://dosu.dev), mention @dosu.*
   
   ---
   <sup>Help Dosu learn! Give it feedback: [Great 
Response](https://app.dosu.dev/response-feedback/a3bee1df-f1be-4609-87c2-3b67650340ad?feedback_type=great_response)
 | [Irrelevant 
Answer](https://app.dosu.dev/response-feedback/a3bee1df-f1be-4609-87c2-3b67650340ad?feedback_type=irrelevant_answer)
 | [Incorrect 
Sources](https://app.dosu.dev/response-feedback/a3bee1df-f1be-4609-87c2-3b67650340ad?feedback_type=incorrect_sources)
 | [Too 
Verbose](https://app.dosu.dev/response-feedback/a3bee1df-f1be-4609-87c2-3b67650340ad?feedback_type=too_verbose)
 | 
[Hallucination](https://app.dosu.dev/response-feedback/a3bee1df-f1be-4609-87c2-3b67650340ad?feedback_type=hallucination)
 | 
[Other](https://app.dosu.dev/response-feedback/a3bee1df-f1be-4609-87c2-3b67650340ad?feedback_type=other)</sup>
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscr...@devlake.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to