Skip to content

Commit cdb4f92

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit db7e16d of spec repo
1 parent 665a48a commit cdb4f92

13 files changed

Lines changed: 507 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1324,6 +1324,13 @@ components:
13241324
example: "9f8e7d6c-5b4a-3210-fedc-ba0987654321"
13251325
format: uuid
13261326
type: string
1327+
OrgGroupPolicySuggestionFilterConfigTier:
1328+
description: Filter policy suggestions by config tier. Defaults to `all`.
1329+
in: query
1330+
name: filter[config_tier]
1331+
required: false
1332+
schema:
1333+
$ref: "#/components/schemas/OrgGroupPolicySuggestionConfigTier"
13271334
OrgGroupSort:
13281335
description: >-
13291336
Field to sort org groups by. Supported values: `name`, `uuid`, `-name`, `-uuid`. Defaults to `uuid`.
@@ -72977,6 +72984,79 @@ components:
7297772984
- MINUS_ID
7297872985
- NAME
7297972986
- MINUS_NAME
72987+
OrgGroupPolicySuggestionAttributes:
72988+
description: Attributes of an org group policy suggestion.
72989+
properties:
72990+
consensus_ratio:
72991+
description: The ratio of member orgs whose configuration agrees on the recommended value.
72992+
example: 0.75
72993+
format: double
72994+
type: number
72995+
policy_name:
72996+
description: The name of the suggested policy.
72997+
example: "monitor_timezone"
72998+
type: string
72999+
recommended_value:
73000+
description: The recommended value for the policy, based on member org consensus.
73001+
example: "UTC"
73002+
status:
73003+
description: The status of the policy suggestion.
73004+
example: "pending"
73005+
type: string
73006+
required:
73007+
- policy_name
73008+
- status
73009+
- consensus_ratio
73010+
- recommended_value
73011+
type: object
73012+
OrgGroupPolicySuggestionConfigTier:
73013+
default: all
73014+
description: The config tier to filter policy suggestions by.
73015+
enum:
73016+
- preview
73017+
- ga
73018+
- all
73019+
example: all
73020+
type: string
73021+
x-enum-varnames:
73022+
- PREVIEW
73023+
- GA
73024+
- ALL
73025+
OrgGroupPolicySuggestionData:
73026+
description: An org group policy suggestion resource.
73027+
properties:
73028+
attributes:
73029+
$ref: "#/components/schemas/OrgGroupPolicySuggestionAttributes"
73030+
id:
73031+
description: The ID of the org group policy suggestion.
73032+
example: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
73033+
type: string
73034+
type:
73035+
$ref: "#/components/schemas/OrgGroupPolicySuggestionType"
73036+
required:
73037+
- id
73038+
- type
73039+
- attributes
73040+
type: object
73041+
OrgGroupPolicySuggestionListResponse:
73042+
description: Response containing a list of org group policy suggestions.
73043+
properties:
73044+
data:
73045+
description: An array of org group policy suggestions.
73046+
items:
73047+
$ref: "#/components/schemas/OrgGroupPolicySuggestionData"
73048+
type: array
73049+
required:
73050+
- data
73051+
type: object
73052+
OrgGroupPolicySuggestionType:
73053+
description: Org group policy suggestions resource type.
73054+
enum:
73055+
- org_group_policy_suggestions
73056+
example: org_group_policy_suggestions
73057+
type: string
73058+
x-enum-varnames:
73059+
- ORG_GROUP_POLICY_SUGGESTIONS
7298073060
OrgGroupPolicyType:
7298173061
description: Org group policies resource type.
7298273062
enum:
@@ -163544,6 +163624,53 @@ paths:
163544163624
x-unstable: |-
163545163625
**Note**: This endpoint is in preview and is subject to change.
163546163626
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
163627+
/api/v2/org_group_policy_suggestions:
163628+
get:
163629+
description: List suggested organization group policies. Requires a filter on org group ID.
163630+
operationId: ListOrgGroupPolicySuggestions
163631+
parameters:
163632+
- $ref: "#/components/parameters/OrgGroupPolicyFilterOrgGroupId"
163633+
- $ref: "#/components/parameters/OrgGroupPolicySuggestionFilterConfigTier"
163634+
responses:
163635+
"200":
163636+
content:
163637+
application/json:
163638+
examples:
163639+
default:
163640+
value:
163641+
data: []
163642+
schema:
163643+
$ref: "#/components/schemas/OrgGroupPolicySuggestionListResponse"
163644+
description: OK
163645+
"400":
163646+
content:
163647+
application/json:
163648+
schema:
163649+
$ref: "#/components/schemas/JSONAPIErrorResponse"
163650+
description: Bad Request
163651+
"401":
163652+
content:
163653+
application/json:
163654+
schema:
163655+
$ref: "#/components/schemas/JSONAPIErrorResponse"
163656+
description: Unauthorized
163657+
"403":
163658+
content:
163659+
application/json:
163660+
schema:
163661+
$ref: "#/components/schemas/JSONAPIErrorResponse"
163662+
description: Forbidden
163663+
"429":
163664+
$ref: "#/components/responses/TooManyRequestsResponse"
163665+
summary: List org group policy suggestions
163666+
tags: [Org Groups]
163667+
"x-permission":
163668+
operator: OR
163669+
permissions:
163670+
- org_group_read
163671+
x-unstable: |-
163672+
**Note**: This endpoint is in preview and is subject to change.
163673+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
163547163674
/api/v2/org_groups:
163548163675
get:
163549163676
description: List all organization groups that the requesting organization has access to.

docs/datadog_api_client.v2.model.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30587,6 +30587,41 @@ datadog\_api\_client.v2.model.org\_group\_policy\_sort\_option module
3058730587
:members:
3058830588
:show-inheritance:
3058930589

30590+
datadog\_api\_client.v2.model.org\_group\_policy\_suggestion\_attributes module
30591+
-------------------------------------------------------------------------------
30592+
30593+
.. automodule:: datadog_api_client.v2.model.org_group_policy_suggestion_attributes
30594+
:members:
30595+
:show-inheritance:
30596+
30597+
datadog\_api\_client.v2.model.org\_group\_policy\_suggestion\_config\_tier module
30598+
---------------------------------------------------------------------------------
30599+
30600+
.. automodule:: datadog_api_client.v2.model.org_group_policy_suggestion_config_tier
30601+
:members:
30602+
:show-inheritance:
30603+
30604+
datadog\_api\_client.v2.model.org\_group\_policy\_suggestion\_data module
30605+
-------------------------------------------------------------------------
30606+
30607+
.. automodule:: datadog_api_client.v2.model.org_group_policy_suggestion_data
30608+
:members:
30609+
:show-inheritance:
30610+
30611+
datadog\_api\_client.v2.model.org\_group\_policy\_suggestion\_list\_response module
30612+
-----------------------------------------------------------------------------------
30613+
30614+
.. automodule:: datadog_api_client.v2.model.org_group_policy_suggestion_list_response
30615+
:members:
30616+
:show-inheritance:
30617+
30618+
datadog\_api\_client.v2.model.org\_group\_policy\_suggestion\_type module
30619+
-------------------------------------------------------------------------
30620+
30621+
.. automodule:: datadog_api_client.v2.model.org_group_policy_suggestion_type
30622+
:members:
30623+
:show-inheritance:
30624+
3059030625
datadog\_api\_client.v2.model.org\_group\_policy\_type module
3059130626
-------------------------------------------------------------
3059230627

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""
2+
List org group policy suggestions returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.org_groups_api import OrgGroupsApi
7+
from uuid import UUID
8+
9+
configuration = Configuration()
10+
configuration.unstable_operations["list_org_group_policy_suggestions"] = True
11+
with ApiClient(configuration) as api_client:
12+
api_instance = OrgGroupsApi(api_client)
13+
response = api_instance.list_org_group_policy_suggestions(
14+
filter_org_group_id=UUID("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
15+
)
16+
17+
print(response)

src/datadog_api_client/configuration.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,7 @@ def __init__(
695695
"v2.list_org_group_policies": False,
696696
"v2.list_org_group_policy_configs": False,
697697
"v2.list_org_group_policy_overrides": False,
698+
"v2.list_org_group_policy_suggestions": False,
698699
"v2.list_org_groups": False,
699700
"v2.update_org_group": False,
700701
"v2.update_org_group_membership": False,

src/datadog_api_client/v2/api/org_groups_api.py

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
from datadog_api_client.v2.model.org_group_policy_override_response import OrgGroupPolicyOverrideResponse
2929
from datadog_api_client.v2.model.org_group_policy_override_create_request import OrgGroupPolicyOverrideCreateRequest
3030
from datadog_api_client.v2.model.org_group_policy_override_update_request import OrgGroupPolicyOverrideUpdateRequest
31+
from datadog_api_client.v2.model.org_group_policy_suggestion_list_response import OrgGroupPolicySuggestionListResponse
32+
from datadog_api_client.v2.model.org_group_policy_suggestion_config_tier import OrgGroupPolicySuggestionConfigTier
3133
from datadog_api_client.v2.model.org_group_list_response import OrgGroupListResponse
3234
from datadog_api_client.v2.model.org_group_sort_option import OrgGroupSortOption
3335
from datadog_api_client.v2.model.org_group_response import OrgGroupResponse
@@ -451,6 +453,34 @@ def __init__(self, api_client=None):
451453
api_client=api_client,
452454
)
453455

456+
self._list_org_group_policy_suggestions_endpoint = _Endpoint(
457+
settings={
458+
"response_type": (OrgGroupPolicySuggestionListResponse,),
459+
"auth": ["apiKeyAuth", "appKeyAuth"],
460+
"endpoint_path": "/api/v2/org_group_policy_suggestions",
461+
"operation_id": "list_org_group_policy_suggestions",
462+
"http_method": "GET",
463+
"version": "v2",
464+
},
465+
params_map={
466+
"filter_org_group_id": {
467+
"required": True,
468+
"openapi_types": (UUID,),
469+
"attribute": "filter[org_group_id]",
470+
"location": "query",
471+
},
472+
"filter_config_tier": {
473+
"openapi_types": (OrgGroupPolicySuggestionConfigTier,),
474+
"attribute": "filter[config_tier]",
475+
"location": "query",
476+
},
477+
},
478+
headers_map={
479+
"accept": ["application/json"],
480+
},
481+
api_client=api_client,
482+
)
483+
454484
self._list_org_groups_endpoint = _Endpoint(
455485
settings={
456486
"response_type": (OrgGroupListResponse,),
@@ -916,6 +946,30 @@ def list_org_group_policy_overrides(
916946

917947
return self._list_org_group_policy_overrides_endpoint.call_with_http_info(**kwargs)
918948

949+
def list_org_group_policy_suggestions(
950+
self,
951+
filter_org_group_id: UUID,
952+
*,
953+
filter_config_tier: Union[OrgGroupPolicySuggestionConfigTier, UnsetType] = unset,
954+
) -> OrgGroupPolicySuggestionListResponse:
955+
"""List org group policy suggestions.
956+
957+
List suggested organization group policies. Requires a filter on org group ID.
958+
959+
:param filter_org_group_id: Filter policies by org group ID.
960+
:type filter_org_group_id: UUID
961+
:param filter_config_tier: Filter policy suggestions by config tier. Defaults to ``all``.
962+
:type filter_config_tier: OrgGroupPolicySuggestionConfigTier, optional
963+
:rtype: OrgGroupPolicySuggestionListResponse
964+
"""
965+
kwargs: Dict[str, Any] = {}
966+
kwargs["filter_org_group_id"] = filter_org_group_id
967+
968+
if filter_config_tier is not unset:
969+
kwargs["filter_config_tier"] = filter_config_tier
970+
971+
return self._list_org_group_policy_suggestions_endpoint.call_with_http_info(**kwargs)
972+
919973
def list_org_groups(
920974
self,
921975
*,
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import Any
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
date,
12+
datetime,
13+
none_type,
14+
UUID,
15+
)
16+
17+
18+
class OrgGroupPolicySuggestionAttributes(ModelNormal):
19+
@cached_property
20+
def openapi_types(_):
21+
return {
22+
"consensus_ratio": (float,),
23+
"policy_name": (str,),
24+
"recommended_value": (
25+
bool,
26+
date,
27+
datetime,
28+
dict,
29+
float,
30+
int,
31+
list,
32+
str,
33+
UUID,
34+
none_type,
35+
),
36+
"status": (str,),
37+
}
38+
39+
attribute_map = {
40+
"consensus_ratio": "consensus_ratio",
41+
"policy_name": "policy_name",
42+
"recommended_value": "recommended_value",
43+
"status": "status",
44+
}
45+
46+
def __init__(self_, consensus_ratio: float, policy_name: str, recommended_value: Any, status: str, **kwargs):
47+
"""
48+
Attributes of an org group policy suggestion.
49+
50+
:param consensus_ratio: The ratio of member orgs whose configuration agrees on the recommended value.
51+
:type consensus_ratio: float
52+
53+
:param policy_name: The name of the suggested policy.
54+
:type policy_name: str
55+
56+
:param recommended_value: The recommended value for the policy, based on member org consensus.
57+
:type recommended_value: bool, date, datetime, dict, float, int, list, str, UUID, none_type
58+
59+
:param status: The status of the policy suggestion.
60+
:type status: str
61+
"""
62+
super().__init__(kwargs)
63+
64+
self_.consensus_ratio = consensus_ratio
65+
self_.policy_name = policy_name
66+
self_.recommended_value = recommended_value
67+
self_.status = status

0 commit comments

Comments
 (0)