Workspace API Specs

[isivaselvan]

Description

Added the Core features of Workspace resources with methods below at resource/workspace.py

• Creation of workspace --> create()
• Update the already created workspace using ID, Name --> update(), update_by_id()
• Provides a list of created workspace --> list()
• Reads the created workspace --> read(), read_with_options(), read_by_id(), read_by_id_with_options()
• Delete the existing workspace --> delete(), delete_by_id(), safe_delete(), safe_delete_by_id()
• VCS Operations --> remove_vcs_connection(), remove_vcs_connection_by_id()
• Lock Operations --> lock(), unlock(), force_unlock()
• SSH Key Operations --> assign_ssh_key(), unassign_ssh_key()
• Remote State Consumer Operations --> list_remote_state_consumers(), add_remote_state_consumers(), remove_remote_state_consumers(), update_remote_state_consumers()
• Tag Operations --> list_tags(), add_tags(), remove_tags()
• Tag Binding Operations --> list_tag_bindings(), list_effective_tag_bindings(), add_tag_bindings(), delete_all_tag_bindings()
• Data Retention Policy Operations --> read_data_retention_policy(), read_data_retention_policy_choice(), set_data_retention_policy(), set_data_retention_policy_delete_older(), set_data_retention_policy_dont_delete(), delete_data_retention_policy()

Added the Workspace specific

• Validation and Parameter Errors at errors.py
• Types at types.py
• Validations at utils.py

Testing plan

Refer the files

• Test file at tests/units/test_workspace.py
• Usage of module at examples/workspace_example.py

External links

JIRA

Output from tests

Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.

Rollback Plan

Changes to Security Controls

PCI review checklist

• I have documented a clear reason for, and description of, the change I am making.

• If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.

• If applicable, I've documented the impact of any changes to security controls.

  Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

If you have any questions, please contact your direct supervisor, GRC (#team-grc), or the PCI working group (#proj-pci-reboot). You can also find more information at PCI Compliance.

[iam404]

it should be TFEClient right ?

[iam404]

TFEClient ?

[iam404]

The content of this file should go under utils.py