Define API using OpenAPI standard

[jlosito]

Rather than defining this API using a README, I much rather view it via the OpenAPI standard which would provide much more features compared to what Clapfoot currently has. In addition, the file that would define the API could be used to host public documentation using GitHub pages.

https://spec.openapis.org/oas/latest.html#openapi-specification

[444B]

I am in support of this and am happy to help implement it

[hayden-t]

nice idea, but it will never happen. 1- devs cant even fix bugs in api let alone completely restructure the format, 2 - it would break all existing integrations...

[jlosito]

@hayden-t can you expand on why it would break existing integrations?

[hayden-t]

because the data structure would be different to what existing integrations have been built to use

[jlosito]

@444B i just took a double look at the current schemas. I believe their api could be defined using the standard without breaking any integrations. Would you agree?

[hayden-t]

no, not unless they ran parallel output formats, any difference would be breaking, not to say integrations couldnt adapt, but i can confidently say judging by progress here over the last 5+ years it aint going to happen.

[attrib]

Not sure if he just means something like this: https://attrib.github.io/warapi/

See https://github.com/attrib/warapi/blob/master/openapi.yaml

[jlosito]

@attrib it does! Thank you.