narrowizard opened a new issue, #4699: URL: https://github.com/apache/incubator-devlake/issues/4699
## Documentation Scope This issue is related to the accuracy and correctness of devlake's Swagger documentation, specifically for the "create jira connection" API endpoint. ## Describe the Change The "create jira connection" API endpoint documentation currently includes three extraneous fields, namely id, createdAt, and updatedAt. These fields should not be included as they are not necessary for creating a new Jira connection. The Swagger documentation needs to be updated to remove these extra fields and to provide concise and clear instructions on the required parameters and their expected types. This will ensure that users can properly use this endpoint with the correct parameters without any confusion. ## Screenshots  ## Additional context To resolve this issue, it is recommended that someone from the devlake team reviews the API endpoint's Swagger documentation and makes the necessary changes to remove the unnecessary fields. It would also be helpful to remind users to refer to the updated documentation when creating any new Jira connections through the devlake platform. This can help prevent issues caused by using incorrect or outdated API documentation. Additionally, similar issues have been found in the Swagger documentation for other data sources, such as Tapd, suggesting that there may be a more general problem with the Swagger documentation. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
