The update_cases method appears incorrect/out-of-date

[tolstislon]

The update_cases method appears incorrect/out-of-date

[elliotweiser]

FWIW, I'm looking into this myself and will share my workaround once I get it working. Assuming it works as expected, I'll submit a PR.

[elliotweiser]

On closer inspection, it actually looks like latest version of (hosted) TestRail has a problem with this API as well. I'll probably need to switch to update_case until server side fix is ready. Then we can worry about client-side issue :)

[dsayling]

So I played around with the request with a single-suite project and multi-suite project and the documentation is right, except for one point.

Suite ID is required even for projects in single suite mode. The suite_id belongs in the path, with the case_ids to update in the request body.

Effectively the method should be like this

    def update_cases(self, suite_id: int, case_ids: List[int], **kwargs) -> dict:
        """
        Updates multiple test cases with the same values, such as setting a set
        of test cases to High priority. This does not support updating multiple
        test cases with different values per test case.

        Note: The online documentation is wrong. The suite_id is required in
        single suite mode as well.

        :param suite_id:
            The ID of the suite
        :case_ids: List[int]
            The IDs of the test cases to update with the kwargs
        :param kwargs:
            :key title: str
                The title of the test case
            :key section_id: int
                The ID of the section (requires TestRail 6.5.2 or later)
            :key template_id: int
                The ID of the template (requires TestRail 5.2 or later)
            :key type_id: int
                The ID of the case type
            :key priority_id: int
                The ID of the case priority
            :key estimate: str
                The estimate, e.g. "30s" or "1m 45s"
            :key milestone_id: int
                The ID of the milestone to link to the test case
            :key refs: str
                A comma-separated list of references/requirements
        """
        kwargs.update({"case_ids": case_ids})
        return self.s.post(endpoint=f"update_cases/{suite_id}", json=kwargs)

I'll work on a PR.

[dsayling]

Just for confirmation via curl that suite id is required for update_cases.

Suite mode of the project (1 for single suite mode, 2 for single suite + baselines, 3 for multiple suites)

⇒ curl -H "Content-Type: application/json" -u "$TESTRAIL_USR:$TESTRAIL_PSW" https://*******/index.php\?/api/v2/get_project/77 | jq                                                                                                                               
{
  "id": 77,
  "name": "Testrail Training",
  "announcement": "This project is used for testrail training.",
  "show_announcement": true,
  "is_completed": false,
  "completed_on": null,
  "suite_mode": 1,
  "default_role_id": null,
  "case_statuses_enabled": false,
  "url": "https://*****/index.php?/projects/overview/77",
  "users": [
    ....
  ],
  "groups": []
}

⇒ curl -H "Content-Type: application/json" -u "$TESTRAIL_USR:$TESTRAIL_PSW" https://******/index.php\?/api/v2/get_suites/77 | jq                                                                                                                                
[
  {
    "id": 27561,
    "name": "Master",
    "description": "Test Suite Description\r\n",
    "project_id": 77,
    "is_master": true,
    "is_baseline": false,
    "is_completed": false,
    "completed_on": null,
    "url": "https://*******/index.php?/suites/view/27561"
  }
]

⇒ curl -H "Content-Type: application/json" -u "$TESTRAIL_USR:$TESTRAIL_PSW" https://*********/index.php\?/api/v2/update_cases -d '{"custom_automation_bucket": [2,3], "case_ids": [4477220, 4477221]}'                                                             
{"error":"Field :suite_id is a required field."}%                                                                                                                                                                                                                                                                 

⇒ curl -H "Content-Type: application/json" -u "$TESTRAIL_USR:$TESTRAIL_PSW" https://*********/index.php\?/api/v2/update_cases/27561 -d '{"custom_automation_bucket": [2,3], "case_ids": [4477220, 4477221]}' | jq                                                  
{
  "updated_cases": [
    {
      "id": 4477220,
      "title": "[Negative] Making requests with improper authorization header",
      "section_id": 246871,
      "template_id": 2,
      "type_id": 7,
      "priority_id": 1,
      "milestone_id": null,
      "refs": "GROW-2566,GROW-2219,GROW-2568",
      "created_by": 196,
      "created_on": 1666373401,
      "updated_by": 196,
      "updated_on": 1666631763,
      "estimate": null,
      "estimate_forecast": null,
      "suite_id": 27561,
      "display_order": 2,
      "is_deleted": 0,
      "case_assignedto_id": null,
      "custom_automation_type": null,
      "custom_automation_state": null,
      "custom_approval_status": null,
      "custom_automation_category": 1,
      "custom_preconds": null,
      "custom_steps_separated": [
	....
      ],
      "custom_mission": null,
      "custom_goals": null,
      "custom_automation_comments": null,
      "comments": [],
      "custom_system_domain": [
        6
      ],
      "custom_automation_bucket": [
        2,
        3
      ],
      "custom_product_feature": [
        12,
        21
      ]
    },
    {
      "id": 4477221,
      "title": "[Positive] Making requests with correct authorization header",
      "section_id": 246871,
      "template_id": 2,
      "type_id": 7,
      "priority_id": 1,
      "milestone_id": null,
      "refs": "GROW-2566,GROW-2219,GROW-2568",
      "created_by": 196,
      "created_on": 1666373402,
      "updated_by": 196,
      "updated_on": 1666631763,
      "estimate": null,
      "estimate_forecast": null,
      "suite_id": 27561,
      "display_order": 3,
      "is_deleted": 0,
      "case_assignedto_id": null,
      "custom_automation_type": null,
      "custom_automation_state": null,
      "custom_approval_status": null,
      "custom_automation_category": 1,
      "custom_preconds": null,
      "custom_steps_separated": [
	....
      ],
      "custom_mission": null,
      "custom_goals": null,
      "custom_automation_comments": null,
      "comments": [],
      "custom_system_domain": [
        6
      ],
      "custom_automation_bucket": [
        2,
        3
      ],
      "custom_product_feature": [
        12,
        21
      ]
    }
  ]
}