Investigate exporting API documentation to Swagger format

[kauffj]

(This ticket is possibly under- or incorrectly specified since I don't know very much about Swagger.)

lbry.tech will need to display the API documentation for lbry, lbrycrd, and potentially other projects like lighthouse.

Having all repositories that provide an API export their API signatures in a shared, open format will allow lbry.tech to display all APIs in a similar fashion.

[hackrush01]

Next Steps

• Check what the output format for the documentation should be
• Assess the difficulty for changing the current one

[tiger5226]

As a reference, just in case it is useful, swagger documentation is used for chainquery here. It is not complete yet but might be helpful.

Also it can be done really easily now with the open api designer

[lyoshenka]

My understanding was that Swagger does not support JSONRPC, only REST. Is that true? Maybe that's not true anymore?

[tiger5226]

OAI/OpenAPI-Specification#801
Looks like it didn't get into 3.0 spec.

[lyoshenka]

I saw that. It’s over a year old. Have you seen anything newer?

…

On Thu, May 24, 2018 at 8:30 PM tiger5226 ***@***.***> wrote: OAI/OpenAPI-Specification#801 <OAI/OpenAPI-Specification#801> Looks like it didn't get into 3.0 spec. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1203 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAWJIL2SPt6QWE42mjKD2qEWEcdFxWy2ks5t11CKgaJpZM4T_nuX> .

[tiger5226]

No I could not find anything on the status of that. There was communication where people said they hacked it in, but I didn't think we would want follow suite there.

[lyoshenka]

bitshares is having the same issue: bitshares/bitshares-core#792