You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "JoshuaPoddoku (via GitHub)" <gi...@apache.org> on 2023/02/09 19:41:09 UTC

[GitHub] [incubator-devlake] JoshuaPoddoku opened a new issue, #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

JoshuaPoddoku opened a new issue, #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374

   ## Documentation Scope
   Proposing to add Swagger API info in Troubleshooting Docs: https://devlake.apache.org/docs/Troubleshooting/Configuration
   
   ## Describe the Change
   Need to update that DevLake has Swagger API (http://localhost:4000/api/swagger/index.html#/) to support Blueprint API and others. This also helps devs to locate easily as it is asked in our slack community several times. 
   
   ## Screenshots
   We may add the info of Swagger API in [Configuration and Blueprint Troubleshooting](https://devlake.apache.org/docs/Troubleshooting/Configuration)
   <img width="1440" alt="Screenshot 2023-02-10 at 1 06 27 AM" src="https://user-images.githubusercontent.com/31725457/217919225-9e40a0e9-2cec-42ce-9184-c4c01eb34f22.png">
   
   
   ## Additional context
   - [Slack discussion thread #1](https://devlake-io.slack.com/archives/C03APJ20VM4/p1669774594375629?thread_ts=1669739595.405099&cid=C03APJ20VM4)
   - [Slack discussion thread #2](https://devlake-io.slack.com/archives/C03APJ20VM4/p1675942841997909?thread_ts=1675941825.603859&cid=C03APJ20VM4)
   <img width="513" alt="Screenshot 2023-02-10 at 1 02 39 AM" src="https://user-images.githubusercontent.com/31725457/217918519-7e1a2182-bd3f-4a34-832c-6929b81c7717.png">


-- 
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: commits-unsubscribe@devlake.apache.org.apache.org

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


[GitHub] [incubator-devlake] github-actions[bot] closed issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info 
URL: https://github.com/apache/incubator-devlake/issues/4374


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] github-actions[bot] commented on issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on issue #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374#issuecomment-1500736823

   This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] github-actions[bot] commented on issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on issue #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374#issuecomment-1512267299

   This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] Startrekzky closed issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky closed issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info 
URL: https://github.com/apache/incubator-devlake/issues/4374


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] github-actions[bot] closed issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info 
URL: https://github.com/apache/incubator-devlake/issues/4374


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] mappjzc commented on issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "mappjzc (via GitHub)" <gi...@apache.org>.
mappjzc commented on issue #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374#issuecomment-1425064225

   Thanks for your issue. can you have a look  @klesh 


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] Startrekzky commented on issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on issue #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374#issuecomment-1547775287

   Hi @JoshuaPoddoku , this issue has been solved by 
   1. adding a doc: https://devlake.apache.org/docs/Overview/References
   2. adding an entry to the API docs in the Config UI in v0.17 
      ![image](https://github.com/apache/incubator-devlake/assets/14050754/41232c68-1457-4e08-86e6-a3a7c41ff05d)
   


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] klesh commented on issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "klesh (via GitHub)" <gi...@apache.org>.
klesh commented on issue #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374#issuecomment-1447783847

   We already have the doc for the swagger API on https://devlake.apache.org/docs/next/DeveloperManuals/DeveloperSetup#using-devlake-api
   
   Maybe we just need to link them up.


-- 
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: commits-unsubscribe@devlake.apache.org

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


[GitHub] [incubator-devlake] github-actions[bot] commented on issue #4374: [Doc][Troubleshooting] Proposing to add Swagger API info

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on issue #4374:
URL: https://github.com/apache/incubator-devlake/issues/4374#issuecomment-1491125216

   This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.


-- 
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: commits-unsubscribe@devlake.apache.org

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