Help regarding the topic "Swagger / OpenAPI standardization for Jenkins REST API"

Contributing
1

Respected members of Jenkins community,

I saw the proposal regarding the title and wanted to try to contribute to the project, As a beginner i am very sorry if this feels like a waste of time, but please hear my concerns
As mentioned in the url:Swagger / OpenAPI standardization for Jenkins REST API in newbie friendly issue i started working to create an openapi/swagger spec for a plugin in the Jenkins project called prometheus-plugin.
I used swagger,jaxrs,jakarta and built a basic swagger-spec file but am unable to locate the correct url to access the swagger page to get the endpoints generated by swagger.
i believe there are some mistakes in my approach that i am unable to find as a beginner and would like some help regarding them.
When hitting with the url : http://localhost:8080/jenkins/api/swagger-ui.html
The error is shown as the fig :

Screenshot 2024-12-22 170740
Screenshot 2024-12-22 1707401214×748 101 KB

Any help would be much appreciated.

Thank you.

2

I assume you mean that you started working on issue 719 that you submitted to the Prometheus plugin. That issue is not labeled as a “good first issue”. I think that it probably is not a well suited to a new contributor.

I believe that the intent of sharing the project ideas is to seek a lead mentor from among experienced Jenkins developers and to seek additional mentors that will help the lead mentor.

You may want to use this time to develop your skills by contributing to Jenkins in other areas rather than trying to work on that specific project. Work on issues that are identified as good first issues or that are flagged as newbie-friendly.

3

May i still work on trying to create a specification for prometheus-plugin, I am stuck right now but i believe i can do it with some help.
I do understand the importance of your time and will try my best not to bother you.
I will also try to work on the newbie-friendly issues as you have mentioned.
Thank you.

4

I don’t know of anyone that is ready to help with questions related to adding a swagger specification to the prometheus plugin. If you’re stuck and no one is willing to help, I assume you’ll remain stuck.

I have been helping other new contributors as they work on newbie-friendly issues and good first issues. Other Jenkins contributors have been helping as well.