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 <https://javadoc.jenkins.io/plugin/>. 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 <https://jenkins.io/projects/gsoc/2019/project-ideas/automatic-spec-generator-for-jenkins-rest-api/> ) 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 > <https://github.com/jenkinsci/folder-auth-plugin>, I have created a > Swagger YAML specification for the plugin's REST APIs. You can check it out > here <https://app.swaggerhub.com/apis/abhyudaya/folder-auth/1.0.0>. > 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 jenkinsci-dev+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/6764a04d-3d4a-45c2-80fe-1d186fcc0257%40googlegroups.com.
