Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Rename result to status in upload API response schema #21

Open
daniil-berg opened this issue Sep 13, 2024 · 1 comment
Open

Rename result to status in upload API response schema #21

daniil-berg opened this issue Sep 13, 2024 · 1 comment
Assignees
Labels
breaking change Changes to public functions that are not backwards compatible consistency An inconsistency that should be (re-)aligned web api Changes to the API exposed via HTTP endpoints

Comments

@daniil-berg
Copy link
Contributor

For the sake of consistency, the result field in the FileUploaded response model should be renamed to status. This would align it with all the other storage response schemas. Right now it is the "odd one out" among the models.

class FileUploaded(BaseResponseModel):
result: Literal["ok"] = "ok"
jwt: str
url: AnyHttpUrl
thumbnails: list[AnyHttpUrl]

I believe this would have no impact on mod_videoservice because the VueJS logic handling that response does not consider the result property anyway. @larsbonczek I am tagging you here again, so you can verify this.

@daniil-berg daniil-berg self-assigned this Sep 13, 2024
@larsbonczek
Copy link
Member

Correct, mod_videoservice does not read that field. I think you can change it.

@daniil-berg daniil-berg added breaking change Changes to public functions that are not backwards compatible consistency An inconsistency that should be (re-)aligned web api Changes to the API exposed via HTTP endpoints labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Changes to public functions that are not backwards compatible consistency An inconsistency that should be (re-)aligned web api Changes to the API exposed via HTTP endpoints
Projects
None yet
Development

No branches or pull requests

2 participants