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

/update specs #1357

Open
davidoskky opened this issue Sep 28, 2022 · 2 comments
Open

/update specs #1357

davidoskky opened this issue Sep 28, 2022 · 2 comments

Comments

@davidoskky
Copy link
Contributor

Hi, I'm sorry about opening an issue just regarding some information about the api, but couldn't find it in the documentation.
What are the plausible response of /update?
I reckon that if everything works fine you get a successful response containing "finished"
Are there other possible response messages?

@jtojnar
Copy link
Member

jtojnar commented Sep 28, 2022

That is completely fine. After all, the API endpoint is not documented, which is either a documentation bug, or an intentional omission.

Both controllers\Sources\Update::updateAll (POST /update) and controllers\Sources\Update::update (POST /source/:sourceId/update) actions only return finished when completed and unallowed access when no user is not logged in and updating sources is not allowed for public. But the later also currently has 200 status code, which is suboptimal.

Ideally, we would also report back errors that occur during updating a single source, and update progress for updating all sources.

@jtojnar
Copy link
Member

jtojnar commented Apr 12, 2023

#1428 will add alternative response format to GET /update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants