Skip to content

Commit

Permalink
doc: Fixup API description of new retrieve routes
Browse files Browse the repository at this point in the history
  • Loading branch information
JulianFP committed Oct 29, 2024
1 parent c207bd9 commit 1ad2426
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions project_W/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -1015,13 +1015,12 @@ def retrieveJobAudio():
- The runner has to currently be registered. All runners will be unregistered automatically after 60-70 seconds since the last heartbeat.
- There has to be a job assigned to the runner associated with the given Runner Token.
.. :quickref: Runners; Runner retrieves the job that got assigned to it.
.. :quickref: Runners; Runner retrieves audio data of the job that got assigned to it.
:reqheader Authorization: Has to be string "Bearer {Token}", where {Token} is the Runner Token that the /runners/create route returned.
:resjson string error: Human-readable error message that tells you why the request failed.
if successful then returns just the binary audio data. In this case the Content-Type is audio/basic instaed of application/json.
:status 200: Returning assigned job.
:status 200: Just returning the binary audio data. In this case the Content-Type is audio/basic instead of application/json.
:status 400: Failed. Refer to ``error`` field for the reason.
"""
online_runner, error = runner_manager.get_online_runner_for_req(request)
Expand All @@ -1043,15 +1042,15 @@ def retrieveJobInfo():
- The runner has to currently be registered. All runners will be unregistered automatically after 60-70 seconds since the last heartbeat.
- There has to be a job assigned to the runner associated with the given Runner Token.
.. :quickref: Runners; Runner retrieves the job that got assigned to it.
.. :quickref: Runners; Runner retrieves information about the job that got assigned to it.
:reqheader Authorization: Has to be string "Bearer {Token}", where {Token} is the Runner Token that the /runners/create route returned.
:resjson string error: Human-readable error message that tells you why the request failed.
:resjson integer jobID: ID of the assigned job
:resjson string model: Whisper model that should be used for the job. May be null.
:resjson string language: Language of the audio. May be null.
:status 200: Returning assigned job.
:status 200: Returning information of the assigned job.
:status 400: Failed. Refer to ``error`` field for the reason.
"""
online_runner, error = runner_manager.get_online_runner_for_req(request)
Expand Down

0 comments on commit 1ad2426

Please sign in to comment.