From df8f36c8e60e494f234c45cb9b6eda3b90eedd02 Mon Sep 17 00:00:00 2001 From: Joel Hermanns Date: Mon, 3 Feb 2025 09:14:29 +0100 Subject: [PATCH 1/4] docs: fix example response of Create Teams endpoint Previously the docs suggested that an array of teams is returned when creating a new team. This is not the case. This commit fixes the api docs and clarifies the example response. --- docs/REST API/rest-api.md | 64 +++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 33 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 8807ce42c2b4..ad5fac18f504 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -10316,43 +10316,41 @@ _Available in Fleet Premium_ ```json { - "teams": [ - { - "name": "workstations", - "id": 1, - "user_count": 0, - "host_count": 0, - "agent_options": { - "config": { - "options": { - "pack_delimiter": "/", - "logger_tls_period": 10, - "distributed_plugin": "tls", - "disable_distributed": false, - "logger_tls_endpoint": "/api/v1/osquery/log", - "distributed_interval": 10, - "distributed_tls_max_attempts": 3 - }, - "decorators": { - "load": [ - "SELECT uuid AS host_uuid FROM system_info;", - "SELECT hostname AS hostname FROM system_info;" - ] - } +"teams": { + "name": "workstations", + "id": 1, + "user_count": 0, + "host_count": 0, + "agent_options": { + "config": { + "options": { + "pack_delimiter": "/", + "logger_tls_period": 10, + "distributed_plugin": "tls", + "disable_distributed": false, + "logger_tls_endpoint": "/api/v1/osquery/log", + "distributed_interval": 10, + "distributed_tls_max_attempts": 3 }, - "overrides": {}, - "command_line_flags": {} - }, - "webhook_settings": { - "failing_policies_webhook": { - "enable_failing_policies_webhook": false, - "destination_url": "", - "policy_ids": null, - "host_batch_size": 0 + "decorators": { + "load": [ + "SELECT uuid AS host_uuid FROM system_info;", + "SELECT hostname AS hostname FROM system_info;" + ] } + }, + "overrides": {}, + "command_line_flags": {} + }, + "webhook_settings": { + "failing_policies_webhook": { + "enable_failing_policies_webhook": false, + "destination_url": "", + "policy_ids": null, + "host_batch_size": 0 } } - ] + } } ``` From d9ccd35b0d8ba7cc69a4237a4fbc2a6efd5300f9 Mon Sep 17 00:00:00 2001 From: Rachael Shaw Date: Thu, 13 Feb 2025 06:34:34 -0600 Subject: [PATCH 2/4] Update docs/REST API/rest-api.md --- docs/REST API/rest-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index ad5fac18f504..ec0377c54c49 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -10316,7 +10316,7 @@ _Available in Fleet Premium_ ```json { -"teams": { +"team": { "name": "workstations", "id": 1, "user_count": 0, From 21a734c39583a47d2f74593e3b7a124a9156cdb1 Mon Sep 17 00:00:00 2001 From: Rachael Shaw Date: Thu, 13 Feb 2025 10:01:37 -0600 Subject: [PATCH 3/4] Fix indentation --- docs/REST API/rest-api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index ec0377c54c49..dae276fc4c85 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -10316,11 +10316,11 @@ _Available in Fleet Premium_ ```json { -"team": { - "name": "workstations", - "id": 1, - "user_count": 0, - "host_count": 0, + "team": { + "name": "workstations", + "id": 1, + "user_count": 0, + "host_count": 0, "agent_options": { "config": { "options": { From 92335a3d3719d53fc2aee84a445aad0402645526 Mon Sep 17 00:00:00 2001 From: Rachael Shaw Date: Thu, 13 Feb 2025 10:02:24 -0600 Subject: [PATCH 4/4] *actually* fix indentation --- docs/REST API/rest-api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index dae276fc4c85..1d0603f48f33 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -10317,10 +10317,10 @@ _Available in Fleet Premium_ ```json { "team": { - "name": "workstations", - "id": 1, - "user_count": 0, - "host_count": 0, + "name": "workstations", + "id": 1, + "user_count": 0, + "host_count": 0, "agent_options": { "config": { "options": {