docs: document 200 OK response for upload file API when file exists #21071
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cstyan
approved these changes
Dec 8, 2025
Contributor
cstyan
left a comment
There was a problem hiding this comment.
had a quick look at the related function and this docs update appears to be correct AFAICT
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #21070
Description
The
POST /api/v2/filesendpoint returns200 OKwhen a file with the same hash already exists (idempotent upload behavior), but the API documentation only documented the201 Createdresponse.This PR updates the Swagger annotations to document both response codes:
200 OK- Returns existing file if duplicate201 Created- Returns newly created fileChanges
coderd/files.goto include both success response codes in the Swagger annotation