From 97a5e87448717e5551abb441eb3237f5e0ade644 Mon Sep 17 00:00:00 2001 From: Alan Rominger Date: Fri, 17 Feb 2023 10:49:25 -0500 Subject: [PATCH] Update templates for feature removals MOVE the config template v1 to v2 delete other v1 views since v1 is deleted the host fact gather collection over time was removed also the job start view was removed Insights integration was changed and the host insights view no longer exists Slightly modernize config help --- awx/api/templates/api/api_v1_root_view.md | 4 ---- ...1_config_view.md => api_v2_config_view.md} | 4 +++- .../templates/api/host_fact_compare_view.md | 11 ---------- .../templates/api/host_fact_versions_list.md | 11 ---------- awx/api/templates/api/host_insights.md | 1 - awx/api/templates/api/job_start.md | 21 ------------------- 6 files changed, 3 insertions(+), 49 deletions(-) delete mode 100644 awx/api/templates/api/api_v1_root_view.md rename awx/api/templates/api/{api_v1_config_view.md => api_v2_config_view.md} (86%) delete mode 100644 awx/api/templates/api/host_fact_compare_view.md delete mode 100644 awx/api/templates/api/host_fact_versions_list.md delete mode 100644 awx/api/templates/api/host_insights.md delete mode 100644 awx/api/templates/api/job_start.md diff --git a/awx/api/templates/api/api_v1_root_view.md b/awx/api/templates/api/api_v1_root_view.md deleted file mode 100644 index 8cfa97f5f1..0000000000 --- a/awx/api/templates/api/api_v1_root_view.md +++ /dev/null @@ -1,4 +0,0 @@ -Version 1 of the Ansible Tower REST API. - -Make a GET request to this resource to obtain a list of all child resources -available via the API. diff --git a/awx/api/templates/api/api_v1_config_view.md b/awx/api/templates/api/api_v2_config_view.md similarity index 86% rename from awx/api/templates/api/api_v1_config_view.md rename to awx/api/templates/api/api_v2_config_view.md index d037ff4408..725669bd54 100644 --- a/awx/api/templates/api/api_v1_config_view.md +++ b/awx/api/templates/api/api_v2_config_view.md @@ -7,10 +7,12 @@ the following fields (some fields may not be visible to all users): * `project_base_dir`: Path on the server where projects and playbooks are \ stored. * `project_local_paths`: List of directories beneath `project_base_dir` to - use when creating/editing a project. + use when creating/editing a manual project. * `time_zone`: The configured time zone for the server. * `license_info`: Information about the current license. * `version`: Version of Ansible Tower package installed. +* `custom_virtualenvs`: Deprecated venv locations from before migration to + execution environments. Export tooling is in `awx-manage` commands. * `eula`: The current End-User License Agreement {% endifmeth %} diff --git a/awx/api/templates/api/host_fact_compare_view.md b/awx/api/templates/api/host_fact_compare_view.md deleted file mode 100644 index 871bc75068..0000000000 --- a/awx/api/templates/api/host_fact_compare_view.md +++ /dev/null @@ -1,11 +0,0 @@ -# List Fact Scans for a Host Specific Host Scan - -Make a GET request to this resource to retrieve system tracking data for a particular scan - -You may filter by datetime: - -`?datetime=2015-06-01` - -and module - -`?datetime=2015-06-01&module=ansible` diff --git a/awx/api/templates/api/host_fact_versions_list.md b/awx/api/templates/api/host_fact_versions_list.md deleted file mode 100644 index e2948505a7..0000000000 --- a/awx/api/templates/api/host_fact_versions_list.md +++ /dev/null @@ -1,11 +0,0 @@ -# List Fact Scans for a Host by Module and Date - -Make a GET request to this resource to retrieve system tracking scans by module and date/time - -You may filter scan runs using the `from` and `to` properties: - -`?from=2015-06-01%2012:00:00&to=2015-06-03` - -You may also filter by module - -`?module=packages` diff --git a/awx/api/templates/api/host_insights.md b/awx/api/templates/api/host_insights.md deleted file mode 100644 index a474be953a..0000000000 --- a/awx/api/templates/api/host_insights.md +++ /dev/null @@ -1 +0,0 @@ -# List Red Hat Insights for a Host diff --git a/awx/api/templates/api/job_start.md b/awx/api/templates/api/job_start.md deleted file mode 100644 index 43104dd2bc..0000000000 --- a/awx/api/templates/api/job_start.md +++ /dev/null @@ -1,21 +0,0 @@ -{% ifmeth GET %} -# Determine if a Job can be started - -Make a GET request to this resource to determine if the job can be started and -whether any passwords are required to start the job. The response will include -the following fields: - -* `can_start`: Flag indicating if this job can be started (boolean, read-only) -* `passwords_needed_to_start`: Password names required to start the job (array, - read-only) -{% endifmeth %} - -{% ifmeth POST %} -# Start a Job -Make a POST request to this resource to start the job. If any passwords are -required, they must be passed via POST data. - -If successful, the response status code will be 202. If any required passwords -are not provided, a 400 status code will be returned. If the job cannot be -started, a 405 status code will be returned. -{% endifmeth %}