[GSoC 2025 PROPOSAL] Ayan - Swagger / OpenAPI standardization for Jenkins REST API

Contributing GSoC
1

Hello, Jenkins Community! I have submitted my GSoC draft proposal for the Swagger/OpenAPI standardization for Jenkins REST API project.

I would love to get some feedback on my proposal from the Jenkins community or GSoC mentors.

Thank you for reading and I’m looking forward to contributing.

Ayan Shah

1 Like
2

I think it would be best to remove the proposal.
Here is a link to a similar case.

Have a great day :slight_smile:
yongjun

1 Like
3

Thanks for your advice, Yongjun

1 Like
4

Hello @root9411, and welcome to this community. :waving_hand:

The document was well received, thanks! :+1:

1 Like
5

Thanks, @poddingue @Alyssat Sir, please suggest any updates to the document if I have made any mistakes or misunderstood anything

Short Introduction: - I am a software engineer who has worked on multiple systems from a young age while pursuing my graduation. I am currently preparing for admission to msc computer science. My primary responsibilities include designing system workflows, developing APIs, and documenting them using Swagger UI and Redoc. Before transitioning into tech, I was a computer teacher, instructing students in multiple programming languages, including HTML, CSS, JavaScript, Java, .NET, and Angular.

Proposal Link: [Swagger / OpenAPI standardization for Jenkins REST API]

1 Like
6

Thank you, Jenkins Community! :raising_hands:

Special thanks to @poddingue @alyssat @berviantoleo for your valuable suggestions. Based on your feedback, I’ve updated the approach and provided a more structured solution on how existing plugins can integrate with this mechanism, how we can convert the metadata into the API Spec and mechanism for new jenkins plugins developers to register APIs in the central documentation system

7

Thank you, @krisstern I love to see feedbacks from Jenkins Community! And I truly appreciate - it means a lot. :slight_smile:

I’ve made some improvements to the proposal document to make it clearer and more understandable based on your suggestions.

I understand that some of the points I mentioned might not be the perfect solutions, but I’ve done my best to provide thoughtful and practical ideas based on my current level of understanding and experience.

Thank you once again, Jenkins Community, for the support and encouragement!