Uploaded image for project: 'Xray for Jira Cloud'
  1. Xray for Jira Cloud
  2. XRAYCLOUD-11053

As a user I would like to get an option to fetch attachment filesize for Test Step and Test Run Step level in getTests(), getTestruns() API endpoint.

    XporterXMLWordPrintable

Details

    • Suggestion
    • Status: New
    • Resolution: Unresolved
    • None
    • None
    • GraphQL
    • None
    • Prod

    • UNCOVERED

    Description

      Description

      The user would like to retrieve the file size of step-level attachments through the getTests() and getTestRuns() API endpoints.

      Currently, the getTestRuns() endpoint provides attachment details for step-level and test-run-step-level attachments, but the attachment object does not include a file size field. It currently returns only fields such as:

      • id
      • filename
      • storedInJira
      • downloadLink

      The user can retrieve evidence file size in some existing API responses, but the file size is not available for step-level attachments.

      User Friction

      The inability to retrieve attachment file sizes makes it difficult for users to monitor and manage storage consumption.

      Providing the file size directly in the API response would allow users to identify large attachments and better manage their available storage space.

      Steps to Reproduce

      1. Execute the following API request for a test run containing tests with step-level attachments:

      {

        getTestRuns(

          testIssueIds: ["12345"]

          limit: 100

        ) {

          total

          limit

          start

          results {

            id

            status

      Unknown macro: {         name         color         description       }

            steps {

              action

              data

              result

              attachments

      Unknown macro: {           id           filename         }

              status

      Unknown macro: {           name           color         }

            }

            test

      Unknown macro: {         issueId       }

            testExecution

          }

        }

      }

      # Review the attachments object in the API response.

      Actual Result

      The response does not provide the file size of the step-level attachment.

      Impact

      Users cannot determine the size of step-level attachments through the API. This makes it more difficult to monitor attachment storage usage and identify attachments that may be consuming significant storage space.

      What Would Improve If Solved

      Add a fileSize (or equivalent) field to the attachment object returned by:

      • getTests()
      • getTestRuns()

      The field should be available for:

      • Test step-level attachments
      • Test run step-level attachments

      Impact on Stakeholders

      This improvement would help users and teams more effectively monitor and manage storage consumption associated with test attachments.

      Current Workaround

      Users have to check the attachment file size manually outside of the API response.

      Context & Examples

      N/A

      Concrete Example

      N/A

      Workaround Risk

      N/A

       

      Attachments

        Activity

          People

            bernardo.cottim Bernardo Cottim
            ankit.asati Ankit Asati
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: