search

tus / tus-resumable-upload-protocol

Open Protocol for Resumable File Uploads
https://tus.io
MIT License
1.48k stars 103 forks source link

Request: Swagger / OpenAPI documentation of the API #169

Closed RubenGarcia closed 3 years ago

RubenGarcia commented 3 years ago

I could not find any swagger or OpenAPI documentation of the tus protocol. This would be useful, e.g., when creating proxies with go-swagger. Is there unpublished OpenAPI documentation which could be added to this project?

Acconut commented 3 years ago

Interesting idea! We don't have an OpenAPI document but would be happy to accept one if you want to contribute.

RubenGarcia commented 3 years ago

I'll try to make one when I can.

Acconut commented 3 years ago

Great! Let me know if you have any questions

RubenGarcia commented 3 years ago

First draft.

swagger-openapi2.yaml.txt

openapi3.yaml.txt

RubenGarcia commented 3 years ago

I have not heard any updates regarding this in a while. Did you have problems setting up cicd?

Acconut commented 3 years ago

I am sorry, @RubenGarcia, I lost track of this discussion. We haven't yet tried to set up the CI for OpenAPI. I explained some more details in https://github.com/tus/tus-resumable-upload-protocol/pull/170#issuecomment-761906862.

RubenGarcia commented 3 years ago

The last comment on #170 seem to indicate that CI is now working, so this can be closed.

Acconut commented 3 years ago

Good catch! Thanks for closing the issue!