Adding the swagger configuration/openapispec to the repository

[nagu165]

What feature do you want to see added?

As per the proposed project to "Standardizing Jenkins REST API documentation using Swagger or the OpenAPI specifications" by the jenkins team. I would like your suggestion on whether it would be okay to work on the openapispec/swagger configuration for this project as a demonstration on how it might be done and what changes would be possible.

Upstream changes

No response

Are you interested in contributing this feature?

I have already started working on creating the swagger configuration and am facing some significant issues and would like some help.

Thank you.

[Waschndolos]

I generally have nothing against it. Not so sure what would be the benefit in having a swagger doc in this plugin. Can you explain what you intend to do?

[nagu165]

This is what the Jenkins community is trying to achieve :

Developers need to know what to expect in terms of responses for each REST API endpoint, so external tools like jenkins-rest can be developed with confidence, and possibly with the help of some REST specification automation. For example, this could be done using the OpenAPI Specification (formerly known as Swagger Specification). Users of the REST API most often want:
HTTP responses and codes
Body of message and its format (e.g. JSON, html, etc.)
Jenkins does not have automated REST API documentation at all at this time. A lot of APIs are contributed from extensions, so there are multiple REST APIs (core and plugins) of varying versions. The goal of this project is to find and implement the extraction of the REST APIs from the sources and generate and publish the REST APIs' respective documentation.

I thought of trying to start with the relatively simple ( in terms of number of endpoints one can access ) plugin and add a swagger-configuration to demonstrate how it might be done, Hence i thought this plugin would be the best to start with.

[Waschndolos]

Ok, sure go ahead. Let me know if you Need assist