pingdotgg / uploadthing

File uploads for modern web devs
https://uploadthing.com
MIT License
4.05k stars 296 forks source link

docs: Add example values for REST api #957

Open ljrahn opened 1 day ago

ljrahn commented 1 day ago

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

markflorkowski commented 1 day ago

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.