Skip to content

Update log endpoint docs to clarify when logs are available #548

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.

Sign up for GitHub

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

Merged
MrCreosote merged 1 commit into from
Feb 9, 2026
Merged

Update log endpoint docs to clarify when logs are available #548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions cdmtaskservice/routes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,9 @@ async def get_job_exit_codes(
response_class=StreamingResponse,
summary="Get a job's stdout logs",
description="Get the stdout stream from a job container. "
+ "Only the submitting user may view the logs."
+ "Only the submitting user may view the logs.\n\n"
+ "Note that only jobs that have gone through the error processing stages will have logs. "
+ "If this is the case, the `logpath` field in the job record will be populated."
)
async def get_job_stdout(
r: Request,
Expand All @@ -367,7 +369,9 @@ async def get_job_stdout(
response_class=StreamingResponse,
summary="Get a job's stderr logs",
description="Get the stderr stream from a job container. "
+ "Only the submitting user may view the logs."
+ "Only the submitting user may view the logs.\n\n"
+ "Note that only jobs that have gone through the error processing stages will have logs. "
+ "If this is the case, the `logpath` field in the job record will be populated."
)
async def get_job_stderr(
r: Request,
Expand Down
Loading