SwaggerHub for Jenkins

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

SwaggerHub for Jenkins

Abhyudaya Sharma
Hi everyone!

I would like to suggest having a Jenkins organization account on SwaggerHub. For the new Folder Auth plugin, I have created a Swagger YAML specification for the plugin's REST APIs. You can check it out here. Having such a specification would help potential users find the APIs (and documentation) without needing to dig deep into the codebase. Also, SwaggerHub can generate stubs in multiple languages for users to easily interact with these APIs. Currently, the specification for the Folder Auth plugin is hosted on my personal account. It would be great to have a Jenkins organization account like on GitHub and have a common store for APIs of all plugins.

Thanks
Abhyudaya Sharma
GitHub: AbhyudayaSharma

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/da313b6f-d601-4892-89d8-c9b1ca4e4514%40googlegroups.com.
Reply | Threaded
Open this post in threaded view
|

Re: SwaggerHub for Jenkins

Oleg Nenashev
Just to bump this thread, I would say that it would be great to have REST API specs hosted in a centralized ways, similar to plugin Javadocs. Looks like SwaggerHub offers a pretty good user experience, so why not? 

Some notes:
  • We could also make Swagger documentation upload a part of the plugin continuous delivery flow once it is ready
  • Same, we could add links to REST API specs to plugins.jenkins.io once there is a critical mass of plugins using such approach
  • The story would be really interesting if combined with the automatic Swagger spec generation for Jenkins plugins (GSoC 2019 project idea)
Best regards,
Oleg

On Wednesday, August 14, 2019 at 7:09:47 PM UTC+2, Abhyudaya Sharma wrote:
Hi everyone!

I would like to suggest having a Jenkins organization account on SwaggerHub. For the new <a href="https://github.com/jenkinsci/folder-auth-plugin" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2Fjenkinsci%2Ffolder-auth-plugin\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNGeZ1agxdfZeNZyNqP18W8N0m5Xug&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2Fjenkinsci%2Ffolder-auth-plugin\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNGeZ1agxdfZeNZyNqP18W8N0m5Xug&#39;;return true;">Folder Auth plugin, I have created a Swagger YAML specification for the plugin's REST APIs. You can check it out <a href="https://app.swaggerhub.com/apis/abhyudaya/folder-auth/1.0.0" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapp.swaggerhub.com%2Fapis%2Fabhyudaya%2Ffolder-auth%2F1.0.0\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFFdgz5w-oVjX5F2Bh4QofrXX3cQA&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapp.swaggerhub.com%2Fapis%2Fabhyudaya%2Ffolder-auth%2F1.0.0\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFFdgz5w-oVjX5F2Bh4QofrXX3cQA&#39;;return true;">here. Having such a specification would help potential users find the APIs (and documentation) without needing to dig deep into the codebase. Also, SwaggerHub can generate stubs in multiple languages for users to easily interact with these APIs. Currently, the specification for the Folder Auth plugin is hosted on my personal account. It would be great to have a Jenkins organization account like on GitHub and have a common store for APIs of all plugins.

Thanks
Abhyudaya Sharma
GitHub: AbhyudayaSharma

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com.
Reply | Threaded
Open this post in threaded view
|

Re: SwaggerHub for Jenkins

Mark Waite-2
I like the idea of hosting the Jenkins REST API documentation on swaggerhub.  I think the GSoC 2019 project idea would make it even better.

While trying to learn more about swaggerhub, I created an organization called "Jenkins", assigned the e-mail address of Jenkins documentation google group ([hidden email]),  and have invited several people to join the organization as part of the experiment.  The organization is a 14 day trial plan, which I assume means that we'll need to fund the hosting of the API spec there, or we'll need to negotiate with them to donate hosting for the API.

Let me know if you'd like an invitation to the trial organization that I've created.  We can evaluate for two weeks and use that time to negotiate with SmartBear to ask them to donate hosting for the Jenkins project.

Mark Waite

I've sent 

On Wed, Aug 28, 2019 at 8:15 AM Oleg Nenashev <[hidden email]> wrote:
Just to bump this thread, I would say that it would be great to have REST API specs hosted in a centralized ways, similar to plugin Javadocs. Looks like SwaggerHub offers a pretty good user experience, so why not? 

Some notes:
  • We could also make Swagger documentation upload a part of the plugin continuous delivery flow once it is ready
  • Same, we could add links to REST API specs to plugins.jenkins.io once there is a critical mass of plugins using such approach
  • The story would be really interesting if combined with the automatic Swagger spec generation for Jenkins plugins (GSoC 2019 project idea)
Best regards,
Oleg

On Wednesday, August 14, 2019 at 7:09:47 PM UTC+2, Abhyudaya Sharma wrote:
Hi everyone!

I would like to suggest having a Jenkins organization account on SwaggerHub. For the new Folder Auth plugin, I have created a Swagger YAML specification for the plugin's REST APIs. You can check it out here. Having such a specification would help potential users find the APIs (and documentation) without needing to dig deep into the codebase. Also, SwaggerHub can generate stubs in multiple languages for users to easily interact with these APIs. Currently, the specification for the Folder Auth plugin is hosted on my personal account. It would be great to have a Jenkins organization account like on GitHub and have a common store for APIs of all plugins.

Thanks
Abhyudaya Sharma
GitHub: AbhyudayaSharma

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com.


--
Thanks!
Mark Waite

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAO49JtF9DypjqbQsaZOvXSZUmegfGBC1atN1PmsPC9M_tHrRNA%40mail.gmail.com.
Reply | Threaded
Open this post in threaded view
|

Re: SwaggerHub for Jenkins

Mark Waite-2
Abhyudaya Sharma could you send your e-mail address to [hidden email] so that I can invite you to the Jenkins organization that I created on swaggerhub?

I've started the conversation with Smartbear (the company that has created swaggerhub) to ask if they would be willing to donate hosting of the Jenkins organization.  I'd love to spend time in the next two weeks during the trial period to further test the idea. 

On Fri, Aug 30, 2019 at 5:31 AM Mark Waite <[hidden email]> wrote:
I like the idea of hosting the Jenkins REST API documentation on swaggerhub.  I think the GSoC 2019 project idea would make it even better.

While trying to learn more about swaggerhub, I created an organization called "Jenkins", assigned the e-mail address of Jenkins documentation google group ([hidden email]),  and have invited several people to join the organization as part of the experiment.  The organization is a 14 day trial plan, which I assume means that we'll need to fund the hosting of the API spec there, or we'll need to negotiate with them to donate hosting for the API.

Let me know if you'd like an invitation to the trial organization that I've created.  We can evaluate for two weeks and use that time to negotiate with SmartBear to ask them to donate hosting for the Jenkins project.

Mark Waite

I've sent 

On Wed, Aug 28, 2019 at 8:15 AM Oleg Nenashev <[hidden email]> wrote:
Just to bump this thread, I would say that it would be great to have REST API specs hosted in a centralized ways, similar to plugin Javadocs. Looks like SwaggerHub offers a pretty good user experience, so why not? 

Some notes:
  • We could also make Swagger documentation upload a part of the plugin continuous delivery flow once it is ready
  • Same, we could add links to REST API specs to plugins.jenkins.io once there is a critical mass of plugins using such approach
  • The story would be really interesting if combined with the automatic Swagger spec generation for Jenkins plugins (GSoC 2019 project idea)
Best regards,
Oleg

On Wednesday, August 14, 2019 at 7:09:47 PM UTC+2, Abhyudaya Sharma wrote:
Hi everyone!

I would like to suggest having a Jenkins organization account on SwaggerHub. For the new Folder Auth plugin, I have created a Swagger YAML specification for the plugin's REST APIs. You can check it out here. Having such a specification would help potential users find the APIs (and documentation) without needing to dig deep into the codebase. Also, SwaggerHub can generate stubs in multiple languages for users to easily interact with these APIs. Currently, the specification for the Folder Auth plugin is hosted on my personal account. It would be great to have a Jenkins organization account like on GitHub and have a common store for APIs of all plugins.

Thanks
Abhyudaya Sharma
GitHub: AbhyudayaSharma

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com.


--
Thanks!
Mark Waite


--
Thanks!
Mark Waite

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAO49JtF6o2EisCqudnWbsOpUS5FCBmk28Tq2ZAYF%2BemgU%2BQT9A%40mail.gmail.com.
Reply | Threaded
Open this post in threaded view
|

Re: SwaggerHub for Jenkins

Oleg Nenashev
Thanks to Mark and Abhyudaya for starting https://app.swaggerhub.com/organizations/Jenkins !
Right now we have only one project there, but indeed we can get more hosted later.

If someone wants to get their plugin Swagger specs to be posted there, I believe the best way is to manually create a Swagger specification and then to add it to the repository.
Then SwaggerHub admins can import it. If there is a high interest, we can automate it later using ci.jenkins.io

Best regards,
Oleg


On Friday, August 30, 2019 at 11:54:12 AM UTC+2, Mark Waite wrote:
Abhyudaya Sharma could you send your e-mail address to <a href="javascript:" target="_blank" gdf-obfuscated-mailto="42wBy8E3BAAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">mark.e...@... so that I can invite you to the Jenkins organization that I created on swaggerhub?

I've started the conversation with Smartbear (the company that has created swaggerhub) to ask if they would be willing to donate hosting of the Jenkins organization.  I'd love to spend time in the next two weeks during the trial period to further test the idea. 

On Fri, Aug 30, 2019 at 5:31 AM Mark Waite <<a href="javascript:" target="_blank" gdf-obfuscated-mailto="42wBy8E3BAAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">mark.e...@...> wrote:
I like the idea of hosting the Jenkins REST API documentation on swaggerhub.  I think the GSoC 2019 project idea would make it even better.

While trying to learn more about swaggerhub, I created an organization called "Jenkins", assigned the e-mail address of Jenkins documentation google group (<a href="javascript:" target="_blank" gdf-obfuscated-mailto="42wBy8E3BAAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">jenkins...@googlegroups.com),  and have invited several people to join the organization as part of the experiment.  The organization is a 14 day trial plan, which I assume means that we'll need to fund the hosting of the API spec there, or we'll need to negotiate with them to donate hosting for the API.

Let me know if you'd like an invitation to the trial organization that I've created.  We can evaluate for two weeks and use that time to negotiate with SmartBear to ask them to donate hosting for the Jenkins project.

Mark Waite

I've sent 

On Wed, Aug 28, 2019 at 8:15 AM Oleg Nenashev <<a href="javascript:" target="_blank" gdf-obfuscated-mailto="42wBy8E3BAAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">o.v.n...@...> wrote:
Just to bump this thread, I would say that it would be great to have REST API specs hosted in a centralized ways, similar to <a href="https://javadoc.jenkins.io/plugin/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fjavadoc.jenkins.io%2Fplugin%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNE_jU-H_n2u_cYeniRnrXcXiwRp9g&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fjavadoc.jenkins.io%2Fplugin%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNE_jU-H_n2u_cYeniRnrXcXiwRp9g&#39;;return true;">plugin Javadocs. Looks like SwaggerHub offers a pretty good user experience, so why not? 

Some notes:
  • We could also make Swagger documentation upload a part of the plugin continuous delivery flow once it is ready
  • Same, we could add links to REST API specs to <a href="http://plugins.jenkins.io" target="_blank" rel="nofollow" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fplugins.jenkins.io\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHbzOwz67aV6GYSsTTC8sHeRwDrFA&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fplugins.jenkins.io\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHbzOwz67aV6GYSsTTC8sHeRwDrFA&#39;;return true;">plugins.jenkins.io once there is a critical mass of plugins using such approach
  • The story would be really interesting if combined with the automatic Swagger spec generation for Jenkins plugins (<a href="https://jenkins.io/projects/gsoc/2019/project-ideas/automatic-spec-generator-for-jenkins-rest-api/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fjenkins.io%2Fprojects%2Fgsoc%2F2019%2Fproject-ideas%2Fautomatic-spec-generator-for-jenkins-rest-api%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFaIZRUDcYl_j2xNwdPY2P7M5cllQ&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fjenkins.io%2Fprojects%2Fgsoc%2F2019%2Fproject-ideas%2Fautomatic-spec-generator-for-jenkins-rest-api%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFaIZRUDcYl_j2xNwdPY2P7M5cllQ&#39;;return true;">GSoC 2019 project idea)
Best regards,
Oleg

On Wednesday, August 14, 2019 at 7:09:47 PM UTC+2, Abhyudaya Sharma wrote:
Hi everyone!

I would like to suggest having a Jenkins organization account on SwaggerHub. For the new <a href="https://github.com/jenkinsci/folder-auth-plugin" rel="nofollow" target="_blank" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2Fjenkinsci%2Ffolder-auth-plugin\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNGeZ1agxdfZeNZyNqP18W8N0m5Xug&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2Fjenkinsci%2Ffolder-auth-plugin\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNGeZ1agxdfZeNZyNqP18W8N0m5Xug&#39;;return true;">Folder Auth plugin, I have created a Swagger YAML specification for the plugin's REST APIs. You can check it out <a href="https://app.swaggerhub.com/apis/abhyudaya/folder-auth/1.0.0" rel="nofollow" target="_blank" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapp.swaggerhub.com%2Fapis%2Fabhyudaya%2Ffolder-auth%2F1.0.0\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFFdgz5w-oVjX5F2Bh4QofrXX3cQA&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapp.swaggerhub.com%2Fapis%2Fabhyudaya%2Ffolder-auth%2F1.0.0\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFFdgz5w-oVjX5F2Bh4QofrXX3cQA&#39;;return true;">here. Having such a specification would help potential users find the APIs (and documentation) without needing to dig deep into the codebase. Also, SwaggerHub can generate stubs in multiple languages for users to easily interact with these APIs. Currently, the specification for the Folder Auth plugin is hosted on my personal account. It would be great to have a Jenkins organization account like on GitHub and have a common store for APIs of all plugins.

Thanks
Abhyudaya Sharma
GitHub: AbhyudayaSharma

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to <a href="javascript:" target="_blank" gdf-obfuscated-mailto="42wBy8E3BAAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">jenkin...@googlegroups.com.
To view this discussion on the web visit <a href="https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com?utm_medium=email&amp;utm_source=footer" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com?utm_medium\x3demail\x26utm_source\x3dfooter&#39;;return true;" onclick="this.href=&#39;https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com?utm_medium\x3demail\x26utm_source\x3dfooter&#39;;return true;">https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com.


--
Thanks!
Mark Waite


--
Thanks!
Mark Waite

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/8ab6e94b-2c94-478b-8de4-33e1bf57aa18%40googlegroups.com.