Custom field key mismatch 'custom_automation_id'

[darrenuong]

TestRail CLI Version

1.6.3

CLI Environment

Windows 10, Python 3.11

TestRail Version

8.0.2

TestRail Instance Type

Professional Cloud

Current behavior

Following the setup instructions for the TestRail CLI, it states the custom field in TestRail should have the System Name set as 'automation_id'

When running the CLI, I get this error:

Checking project. Done.
Traceback (most recent call last):
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\Scripts\trcli.exe\__main__.py", line 7, in <module>
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\core.py", line 1128, in __call__
    return self.main(*args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\trcli\cli.py", line 239, in main
    return super().main(windows_expand_args=False, *args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\core.py", line 1053, in main
    rv = self.invoke(ctx)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\core.py", line 1659, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\core.py", line 1395, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\trcli\commands\results_parser_helpers.py", line 101, in wrapper_common_options
    return f(*args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\decorators.py", line 26, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\decorators.py", line 84, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\click\core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\trcli\commands\cmd_parse_junit.py", line 36, in cli
    result_uploader.upload_results()
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\trcli\api\results_uploader.py", line 67, in upload_results
    missing_test_cases, error_message = self.api_request_handler.check_missing_test_cases_ids(
  File "C:\Users\darrenuong\AppData\Local\Programs\Python\Python310\lib\site-packages\trcli\api\api_request_handler.py", line 297, in check_missing_test_cases_ids
    aut_case_id = case["custom_automation_id"]
KeyError: 'custom_automation_id'

After changing the 'custom_automation_id' references to 'automation_id' in api_request_handler.py, that error goes away but another comes up:

Processed 3 test cases in section TestMicrophone-20231206103614.
Checking project. The automation_id field is not properly configured. Please configure it in the TestRail Administration under Customizations > Case Fields.
The field should have the following mandatory details:
  - System Name: automation_id
  - Type: Text (or String)
  - Is Active: True

Is there a mismatch in key names that hasn't been updated in the documentation?

Desired behavior

No response

More Details

No response