Create and maintain a swagger file for FPP API's

[patdelaney]

Is your feature request related to a problem? Please describe.
A few wees ago I was checking to see if we had a swagger file for the FPP API's and I don't think we have one. Last night in the Zoom Room I was asked by Paul T if one exists.

My use case was so that I could import them into Postman so that I could either do some API testing or build scripts to do repetitive tasks.
IE longevity testing

For those of you that watch these issues, please comment if you'd like to see a swagger file created,

[jcrossbdn]

It would be nice to have something that can be imported into postman as long as it can have someone to make sure it is up to date and complete:). The existing documentation is quite good but can’t be expected to be 100% complete all the time.JasonSent from my iPhoneOn Feb 6, 2025, at 6:43 AM, patdelaney ***@***.***> wrote: Is your feature request related to a problem? Please describe. A few wees ago I was checking to see if we had a swagger file for the FPP API's and I don't think we have one. Last night in the Zoom Room I was asked by Paul T if one exists. My use case was so that I could import them into Postman so that I could either do some API testing or build scripts to do repetitive tasks. IE longevity testing For those of you that watch these issues, please comment if you'd like to see a swagger file created, —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[patdelaney]

Jason, If you have any experience creating the swagger file, we'd appreciate the help. :-)

…

On Thu, Feb 6, 2025 at 7:29 AM Jason Cross ***@***.***> wrote: It would be nice to have something that can be imported into postman as long as it can have someone to make sure it is up to date and complete:). The existing documentation is quite good but can’t be expected to be 100% complete all the time.JasonSent from my iPhoneOn Feb 6, 2025, at 6:43 AM, patdelaney ***@***.***> wrote: Is your feature request related to a problem? Please describe. A few wees ago I was checking to see if we had a swagger file for the FPP API's and I don't think we have one. Last night in the Zoom Room I was asked by Paul T if one exists. My use case was so that I could import them into Postman so that I could either do some API testing or build scripts to do repetitive tasks. IE longevity testing For those of you that watch these issues, please comment if you'd like to see a swagger file created, —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***> — Reply to this email directly, view it on GitHub <#2144 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB6FEA4PVKD2R2MYTYYIZFD2ONPS5AVCNFSM6AAAAABWTONQ7WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMZZHAZTGOJXHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[jcrossbdn]

I don’t have experience with creating swagger files, but it is something I want to figure out for work.  Would be happy to use this to learn… but it would be a few weeks before I could start.JasonSent from my iPhoneOn Feb 6, 2025, at 8:48 AM, patdelaney ***@***.***> wrote: Jason, If you have any experience creating the swagger file, we'd appreciate the help. :-)

On Thu, Feb 6, 2025 at 7:29 AM Jason Cross ***@***.***> wrote: It would be nice to have something that can be imported into postman as long as it can have someone to make sure it is up to date and complete:). The existing documentation is quite good but can’t be expected to be 100% complete all the time.JasonSent from my iPhoneOn Feb 6, 2025, at 6:43 AM, patdelaney ***@***.***> wrote: Is your feature request related to a problem? Please describe. A few wees ago I was checking to see if we had a swagger file for the FPP API's and I don't think we have one. Last night in the Zoom Room I was asked by Paul T if one exists. My use case was so that I could import them into Postman so that I could either do some API testing or build scripts to do repetitive tasks. IE longevity testing For those of you that watch these issues, please comment if you'd like to see a swagger file created, —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***> — Reply to this email directly, view it on GitHub <#2144 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB6FEA4PVKD2R2MYTYYIZFD2ONPS5AVCNFSM6AAAAABWTONQ7WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMZZHAZTGOJXHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you commented.Message ID: ***@***.***>

[ghormann]

Very much welcome the help. Please note that the current API documentation and online testing page is generated from https://github.com/FalconChristmas/fpp/blob/master/www/api/endpoints.json I don't think API developers should have to maintain the API documentation in two separate json schemas so any solution we need to replace the API help menu item as well.