Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Misleading API docs for /api/v1/projects/{slug}/upload #1408

Open
TheSuperGamer20578 opened this issue Sep 15, 2024 · 0 comments
Open

Misleading API docs for /api/v1/projects/{slug}/upload #1408

TheSuperGamer20578 opened this issue Sep 15, 2024 · 0 comments
Labels
1. api This issue/pr relates to an issue/change on the api 1. documentation Improvements or additions to documentation

Comments

@TheSuperGamer20578
Copy link

Observed/problematic behavior

The documentation for /api/v1/projects/{slug}/upload fails to mark several fields as required in the versionUpload part and there is no error handling for this with the API responding with a status code of 500 with a generic message as opposed to the correct status of 400 with an appropriate message.

Expected behavior

The documentation should mark all required fields as required, and the API should return an appropriate status code and error message if any required fields are missing or invalid.

Steps to reproduce

  1. Send a request to /api/v1/projects/{slug}/upload with the minimum required payload stipulated by the documentation
  2. Observe a status code of 500

Other

No response

@kennytv kennytv added 1. documentation Improvements or additions to documentation 1. api This issue/pr relates to an issue/change on the api labels Sep 16, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
1. api This issue/pr relates to an issue/change on the api 1. documentation Improvements or additions to documentation
Projects
Status: New
Development

No branches or pull requests

2 participants