Skip to content

Conversation

vas3a
Copy link
Collaborator

@vas3a vas3a commented Oct 8, 2025

https://topcoder.atlassian.net/browse/PM-2213 - GET /workflows/{workflowId}/runs/{runId}/attachments
https://topcoder.atlassian.net/browse/PM-2217 - GET /workflows/{workflowId}/runs/{runId}/attachments/{artifactId}/zip

@vas3a vas3a requested a review from kkartunov October 8, 2025 11:58
Copy link
Contributor

@kkartunov kkartunov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
Very good solution of uising streams and piping the response.
Let's fix minor comments and we done here...

@ApiOperation({
summary: 'List all attachments linked to the specific run',
})
@ApiParam({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shall have a @ApiParam for workflowId right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As bellow, the params are automatically added by swagger when you use @Param('workflowId') workflowId: string, in the method signature. I used @ApiParam to enhance the description in here.
image

@ApiOperation({
summary: 'Download an attachment archive linked to the specific run',
})
@ApiParam({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again we need to add workflowId and runId to docs call signature.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kkartunov in the new swagger version, these annotations are used only to add description.
When you use @Param('workflowId') workflowId: string, in the method signature, they're automatically added to swagger as inputs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

@vas3a vas3a merged commit 1e2fd72 into develop Oct 9, 2025
1 check passed
@vas3a vas3a deleted the PM-2213_workfow-run-attachments branch October 9, 2025 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants