uploadthing icon indicating copy to clipboard operation
uploadthing copied to clipboard

docs: Add example values for REST api

Open ljrahn opened this issue 1 year ago โ€ข 3 comments

Area of Improvement

For the REST API documentation, all of the examples only contain required fields, but not examples for values. As someone who is not intimately familiar with all the terms used throughout the rest of the documentation, it would make it simpler to see an example value eg:

POST deleteFiles. What is files? Is it an array of urls? What are customIds?

Link to related docs

https://docs.uploadthing.com/api-reference/openapi-spec

Additional information

No response

๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Contributing

  • [ ] ๐Ÿ™‹โ€โ™‚๏ธ Yes, I'd be down to file a PR implementing the suggested changes!

ljrahn avatar Sep 17 '24 14:09 ljrahn

Good callout, will need to check if the tool we use for generating those docs supports this or if we will need to build something to support it.

markflorkowski avatar Sep 17 '24 17:09 markflorkowski

This issue has been automatically marked as stale because it has not had any activity for 10 days. It will be closed in 5 days if no further activity occurs.

github-actions[bot] avatar Sep 28 '24 00:09 github-actions[bot]

This issue has been closed because it has not had any activity for 5 days since being marked as stale.

github-actions[bot] avatar Oct 03 '24 00:10 github-actions[bot]

Any updates?

tonycky avatar Oct 05 '24 10:10 tonycky

I'm having hard time integrating the REST API on my application, I'll just use UTApi at the mean time...

realnikitimi avatar Nov 08 '24 18:11 realnikitimi