Describe the bug
The public API in deadline.client.api has inconsistent parameter naming conventions across list functions.
Functions from _list_apis.py use camelCase **kwargs that pass through directly to boto3:
list_farms(principalId=..., nextToken=...)
list_queues(farmId=..., principalId=...)
list_jobs(farmId=..., queueId=...)
list_fleets(farmId=..., displayName=...)
list_storage_profiles_for_queue(farmId=..., queueId=...)
Functions from _mcp.py use snake_case explicit parameters:
list_sessions(farm_id=..., queue_id=...)
list_steps(farm_id=..., queue_id=...)
list_tasks(farm_id=..., queue_id=..., step_id=...)
get_job(farm_id=..., queue_id=...)
get_session(farm_id=..., queue_id=...)
search_jobs(farm_id=..., queue_ids=...)
All of these are exported from deadline.client.api as public API.
Expected Behaviour
Standardize on snake_case for all public API functions, following Python conventions. The older camelCase **kwargs functions could be updated to use explicit snake_case parameters that convert internally, matching the pattern already used in _mcp.py. Explicit parameters also helps typing and code hints.
This would be a breaking change to the existing public API and would need to be handled accordingly.
Current Behaviour
Not standardized.
Reproduction Steps
n/a
Environment
At minimum:
- Operating system (e.g. Windows Server 2022; Amazon Linux 2023; etc.)
- Output of
python3 --version
- Output of
deadline --version
- If this is from a version installed by the Deadline Cloud Submitter installer, then what version of the submitter installer?
Please share other details about your environment that you think might be relevant to reproducing the bug.
Describe the bug
The public API in
deadline.client.apihas inconsistent parameter naming conventions across list functions.Functions from
_list_apis.pyuse camelCase**kwargsthat pass through directly to boto3:list_farms(principalId=..., nextToken=...)list_queues(farmId=..., principalId=...)list_jobs(farmId=..., queueId=...)list_fleets(farmId=..., displayName=...)list_storage_profiles_for_queue(farmId=..., queueId=...)Functions from
_mcp.pyuse snake_case explicit parameters:list_sessions(farm_id=..., queue_id=...)list_steps(farm_id=..., queue_id=...)list_tasks(farm_id=..., queue_id=..., step_id=...)get_job(farm_id=..., queue_id=...)get_session(farm_id=..., queue_id=...)search_jobs(farm_id=..., queue_ids=...)All of these are exported from
deadline.client.apias public API.Expected Behaviour
Standardize on snake_case for all public API functions, following Python conventions. The older camelCase
**kwargsfunctions could be updated to use explicit snake_case parameters that convert internally, matching the pattern already used in_mcp.py. Explicit parameters also helps typing and code hints.This would be a breaking change to the existing public API and would need to be handled accordingly.
Current Behaviour
Not standardized.
Reproduction Steps
n/a
Environment
At minimum:
python3 --versiondeadline --versionPlease share other details about your environment that you think might be relevant to reproducing the bug.