Skip to content

Commit 2ffd8d1

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Rename Tiers for Org Group Policies and Remove Include Memberships Support (#3568)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 1ab8293 commit 2ffd8d1

17 files changed

Lines changed: 35 additions & 338 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 13 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,20 +1051,6 @@ components:
10511051
example: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
10521052
format: uuid
10531053
type: string
1054-
OrgGroupInclude:
1055-
description: >-
1056-
List of related resources to include.
1057-
explode: false
1058-
in: query
1059-
name: include
1060-
required: false
1061-
schema:
1062-
example:
1063-
- memberships
1064-
items:
1065-
$ref: "#/components/schemas/OrgGroupIncludeOption"
1066-
type: array
1067-
style: form
10681054
OrgGroupMembershipFilterOrgGroupId:
10691055
description: Filter memberships by org group ID. Required when `filter[org_uuid]` is not provided.
10701056
in: query
@@ -59532,22 +59518,13 @@ components:
5953259518
example: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
5953359519
format: uuid
5953459520
type: string
59535-
relationships:
59536-
$ref: "#/components/schemas/OrgGroupRelationships"
5953759521
type:
5953859522
$ref: "#/components/schemas/OrgGroupType"
5953959523
required:
5954059524
- id
5954159525
- type
5954259526
- attributes
5954359527
type: object
59544-
OrgGroupIncludeOption:
59545-
description: Allowed include options for org group endpoints.
59546-
enum:
59547-
- memberships
59548-
type: string
59549-
x-enum-varnames:
59550-
- MEMBERSHIPS
5955159528
OrgGroupListResponse:
5955259529
description: Response containing a list of org groups.
5955359530
properties:
@@ -59556,11 +59533,6 @@ components:
5955659533
items:
5955759534
$ref: "#/components/schemas/OrgGroupData"
5955859535
type: array
59559-
included:
59560-
description: Related resources included in the response when requested with the `include` parameter.
59561-
items:
59562-
$ref: "#/components/schemas/OrgGroupMembershipData"
59563-
type: array
5956459536
links:
5956559537
$ref: "#/components/schemas/OrgGroupPaginationLinks"
5956659538
meta:
@@ -59687,20 +59659,6 @@ components:
5968759659
required:
5968859660
- data
5968959661
type: object
59690-
OrgGroupMembershipRelationshipData:
59691-
description: A reference to an org group membership.
59692-
properties:
59693-
id:
59694-
description: The ID of the membership.
59695-
example: "f1e2d3c4-b5a6-7890-1234-567890abcdef"
59696-
format: uuid
59697-
type: string
59698-
type:
59699-
$ref: "#/components/schemas/OrgGroupMembershipType"
59700-
required:
59701-
- id
59702-
- type
59703-
type: object
5970459662
OrgGroupMembershipRelationships:
5970559663
description: Relationships of an org group membership.
5970659664
properties:
@@ -59771,17 +59729,6 @@ components:
5977159729
required:
5977259730
- data
5977359731
type: object
59774-
OrgGroupMembershipsRelationship:
59775-
description: Relationship to org group memberships.
59776-
properties:
59777-
data:
59778-
description: An array of membership relationship references.
59779-
items:
59780-
$ref: "#/components/schemas/OrgGroupMembershipRelationshipData"
59781-
type: array
59782-
required:
59783-
- data
59784-
type: object
5978559732
OrgGroupPaginationLinks:
5978659733
description: Pagination links for navigating between pages of an org group list response.
5978759734
properties:
@@ -60015,18 +59962,18 @@ components:
6001559962
- attributes
6001659963
type: object
6001759964
OrgGroupPolicyEnforcementTier:
60018-
default: DEFAULT
59965+
default: OVERRIDE_ALLOWED
6001959966
description: >-
60020-
The enforcement tier of the policy. `DEFAULT` means the policy is set but member orgs may mutate it. `ENFORCE` means the policy is strictly controlled and mutations are blocked for affected orgs. `DELEGATE` means each member org controls its own value.
59967+
The enforcement tier of the policy. `OVERRIDE_ALLOWED` means the policy is set but member orgs may mutate it. `GROUP_MANAGED` means the policy is strictly controlled and mutations are blocked for affected orgs. `DELEGATE` means each member org controls its own value.
6002159968
enum:
60022-
- DEFAULT
60023-
- ENFORCE
59969+
- OVERRIDE_ALLOWED
59970+
- GROUP_MANAGED
6002459971
- DELEGATE
60025-
example: DEFAULT
59972+
example: OVERRIDE_ALLOWED
6002659973
type: string
6002759974
x-enum-varnames:
60028-
- DEFAULT
60029-
- ENFORCE
59975+
- OVERRIDE_ALLOWED
59976+
- GROUP_MANAGED
6003059977
- DELEGATE
6003159978
OrgGroupPolicyListResponse:
6003259979
description: Response containing a list of org group policies.
@@ -60367,12 +60314,6 @@ components:
6036760314
- id
6036860315
- type
6036960316
type: object
60370-
OrgGroupRelationships:
60371-
description: Relationships of an org group.
60372-
properties:
60373-
memberships:
60374-
$ref: "#/components/schemas/OrgGroupMembershipsRelationship"
60375-
type: object
6037660317
OrgGroupResponse:
6037760318
description: Response containing a single org group.
6037860319
properties:
@@ -134194,7 +134135,7 @@ paths:
134194134135
- attributes:
134195134136
content:
134196134137
value: "UTC"
134197-
enforcement_tier: "DEFAULT"
134138+
enforcement_tier: "OVERRIDE_ALLOWED"
134198134139
modified_at: "2024-01-15T10:30:00Z"
134199134140
policy_name: "monitor_timezone"
134200134141
policy_type: "org_config"
@@ -134266,7 +134207,7 @@ paths:
134266134207
attributes:
134267134208
content:
134268134209
value: "UTC"
134269-
enforcement_tier: "DEFAULT"
134210+
enforcement_tier: "OVERRIDE_ALLOWED"
134270134211
policy_name: "monitor_timezone"
134271134212
policy_type: "org_config"
134272134213
relationships:
@@ -134289,7 +134230,7 @@ paths:
134289134230
attributes:
134290134231
content:
134291134232
value: "UTC"
134292-
enforcement_tier: "DEFAULT"
134233+
enforcement_tier: "OVERRIDE_ALLOWED"
134293134234
modified_at: "2024-01-15T10:30:00Z"
134294134235
policy_name: "monitor_timezone"
134295134236
policy_type: "org_config"
@@ -134398,7 +134339,7 @@ paths:
134398134339
attributes:
134399134340
content:
134400134341
value: "UTC"
134401-
enforcement_tier: "DEFAULT"
134342+
enforcement_tier: "OVERRIDE_ALLOWED"
134402134343
modified_at: "2024-01-15T10:30:00Z"
134403134344
policy_name: "monitor_timezone"
134404134345
policy_type: "org_config"
@@ -134462,7 +134403,7 @@ paths:
134462134403
attributes:
134463134404
content:
134464134405
value: "US/Eastern"
134465-
enforcement_tier: "ENFORCE"
134406+
enforcement_tier: "GROUP_MANAGED"
134466134407
id: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
134467134408
type: org_group_policies
134468134409
schema:
@@ -134479,7 +134420,7 @@ paths:
134479134420
attributes:
134480134421
content:
134481134422
value: "US/Eastern"
134482-
enforcement_tier: "ENFORCE"
134423+
enforcement_tier: "GROUP_MANAGED"
134483134424
modified_at: "2024-01-16T14:00:00Z"
134484134425
policy_name: "monitor_timezone"
134485134426
policy_type: "org_config"
@@ -134946,7 +134887,6 @@ paths:
134946134887
- $ref: "#/components/parameters/OrgGroupPageNumber"
134947134888
- $ref: "#/components/parameters/OrgGroupPageSize"
134948134889
- $ref: "#/components/parameters/OrgGroupSort"
134949-
- $ref: "#/components/parameters/OrgGroupInclude"
134950134890
responses:
134951134891
"200":
134952134892
content:

docs/datadog_api_client.v2.model.rst

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25610,13 +25610,6 @@ datadog\_api\_client.v2.model.org\_group\_data module
2561025610
:members:
2561125611
:show-inheritance:
2561225612

25613-
datadog\_api\_client.v2.model.org\_group\_include\_option module
25614-
----------------------------------------------------------------
25615-
25616-
.. automodule:: datadog_api_client.v2.model.org_group_include_option
25617-
:members:
25618-
:show-inheritance:
25619-
2562025613
datadog\_api\_client.v2.model.org\_group\_list\_response module
2562125614
---------------------------------------------------------------
2562225615

@@ -25680,13 +25673,6 @@ datadog\_api\_client.v2.model.org\_group\_membership\_list\_response module
2568025673
:members:
2568125674
:show-inheritance:
2568225675

25683-
datadog\_api\_client.v2.model.org\_group\_membership\_relationship\_data module
25684-
-------------------------------------------------------------------------------
25685-
25686-
.. automodule:: datadog_api_client.v2.model.org_group_membership_relationship_data
25687-
:members:
25688-
:show-inheritance:
25689-
2569025676
datadog\_api\_client.v2.model.org\_group\_membership\_relationships module
2569125677
--------------------------------------------------------------------------
2569225678

@@ -25736,13 +25722,6 @@ datadog\_api\_client.v2.model.org\_group\_membership\_update\_request module
2573625722
:members:
2573725723
:show-inheritance:
2573825724

25739-
datadog\_api\_client.v2.model.org\_group\_memberships\_relationship module
25740-
--------------------------------------------------------------------------
25741-
25742-
.. automodule:: datadog_api_client.v2.model.org_group_memberships_relationship
25743-
:members:
25744-
:show-inheritance:
25745-
2574625725
datadog\_api\_client.v2.model.org\_group\_pagination\_links module
2574725726
------------------------------------------------------------------
2574825727

@@ -26030,13 +26009,6 @@ datadog\_api\_client.v2.model.org\_group\_relationship\_to\_one\_data module
2603026009
:members:
2603126010
:show-inheritance:
2603226011

26033-
datadog\_api\_client.v2.model.org\_group\_relationships module
26034-
--------------------------------------------------------------
26035-
26036-
.. automodule:: datadog_api_client.v2.model.org_group_relationships
26037-
:members:
26038-
:show-inheritance:
26039-
2604026012
datadog\_api\_client.v2.model.org\_group\_response module
2604126013
---------------------------------------------------------
2604226014

examples/v2/org-groups/CreateOrgGroupPolicy.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
data=OrgGroupPolicyCreateData(
2121
attributes=OrgGroupPolicyCreateAttributes(
2222
content=dict([("value", "UTC")]),
23-
enforcement_tier=OrgGroupPolicyEnforcementTier.DEFAULT,
23+
enforcement_tier=OrgGroupPolicyEnforcementTier.OVERRIDE_ALLOWED,
2424
policy_name="monitor_timezone",
2525
policy_type=OrgGroupPolicyPolicyType.ORG_CONFIG,
2626
),

examples/v2/org-groups/UpdateOrgGroupPolicy.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
data=OrgGroupPolicyUpdateData(
1616
attributes=OrgGroupPolicyUpdateAttributes(
1717
content=dict([("value", "UTC")]),
18-
enforcement_tier=OrgGroupPolicyEnforcementTier.DEFAULT,
18+
enforcement_tier=OrgGroupPolicyEnforcementTier.OVERRIDE_ALLOWED,
1919
),
2020
id=UUID("1a2b3c4d-5e6f-7890-abcd-ef0123456789"),
2121
type=OrgGroupPolicyType.ORG_GROUP_POLICIES,

src/datadog_api_client/v2/api/org_groups_api.py

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Copyright 2019-Present Datadog, Inc.
44
from __future__ import annotations
55

6-
from typing import Any, Dict, List, Union
6+
from typing import Any, Dict, Union
77

88
from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
99
from datadog_api_client.configuration import Configuration
@@ -30,7 +30,6 @@
3030
from datadog_api_client.v2.model.org_group_policy_override_update_request import OrgGroupPolicyOverrideUpdateRequest
3131
from datadog_api_client.v2.model.org_group_list_response import OrgGroupListResponse
3232
from datadog_api_client.v2.model.org_group_sort_option import OrgGroupSortOption
33-
from datadog_api_client.v2.model.org_group_include_option import OrgGroupIncludeOption
3433
from datadog_api_client.v2.model.org_group_response import OrgGroupResponse
3534
from datadog_api_client.v2.model.org_group_create_request import OrgGroupCreateRequest
3635
from datadog_api_client.v2.model.org_group_update_request import OrgGroupUpdateRequest
@@ -484,12 +483,6 @@ def __init__(self, api_client=None):
484483
"attribute": "sort",
485484
"location": "query",
486485
},
487-
"include": {
488-
"openapi_types": ([OrgGroupIncludeOption],),
489-
"attribute": "include",
490-
"location": "query",
491-
"collection_format": "csv",
492-
},
493486
},
494487
headers_map={
495488
"accept": ["application/json"],
@@ -929,7 +922,6 @@ def list_org_groups(
929922
page_number: Union[int, UnsetType] = unset,
930923
page_size: Union[int, UnsetType] = unset,
931924
sort: Union[OrgGroupSortOption, UnsetType] = unset,
932-
include: Union[List[OrgGroupIncludeOption], UnsetType] = unset,
933925
) -> OrgGroupListResponse:
934926
"""List org groups.
935927
@@ -941,8 +933,6 @@ def list_org_groups(
941933
:type page_size: int, optional
942934
:param sort: Field to sort org groups by. Supported values: ``name`` , ``uuid`` , ``-name`` , ``-uuid``. Defaults to ``uuid``.
943935
:type sort: OrgGroupSortOption, optional
944-
:param include: List of related resources to include.
945-
:type include: [OrgGroupIncludeOption], optional
946936
:rtype: OrgGroupListResponse
947937
"""
948938
kwargs: Dict[str, Any] = {}
@@ -955,9 +945,6 @@ def list_org_groups(
955945
if sort is not unset:
956946
kwargs["sort"] = sort
957947

958-
if include is not unset:
959-
kwargs["include"] = include
960-
961948
return self._list_org_groups_endpoint.call_with_http_info(**kwargs)
962949

963950
def update_org_group(

src/datadog_api_client/v2/model/org_group_data.py

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,52 +3,39 @@
33
# Copyright 2019-Present Datadog, Inc.
44
from __future__ import annotations
55

6-
from typing import Union, TYPE_CHECKING
6+
from typing import TYPE_CHECKING
77

88
from datadog_api_client.model_utils import (
99
ModelNormal,
1010
cached_property,
11-
unset,
12-
UnsetType,
1311
UUID,
1412
)
1513

1614

1715
if TYPE_CHECKING:
1816
from datadog_api_client.v2.model.org_group_attributes import OrgGroupAttributes
19-
from datadog_api_client.v2.model.org_group_relationships import OrgGroupRelationships
2017
from datadog_api_client.v2.model.org_group_type import OrgGroupType
2118

2219

2320
class OrgGroupData(ModelNormal):
2421
@cached_property
2522
def openapi_types(_):
2623
from datadog_api_client.v2.model.org_group_attributes import OrgGroupAttributes
27-
from datadog_api_client.v2.model.org_group_relationships import OrgGroupRelationships
2824
from datadog_api_client.v2.model.org_group_type import OrgGroupType
2925

3026
return {
3127
"attributes": (OrgGroupAttributes,),
3228
"id": (UUID,),
33-
"relationships": (OrgGroupRelationships,),
3429
"type": (OrgGroupType,),
3530
}
3631

3732
attribute_map = {
3833
"attributes": "attributes",
3934
"id": "id",
40-
"relationships": "relationships",
4135
"type": "type",
4236
}
4337

44-
def __init__(
45-
self_,
46-
attributes: OrgGroupAttributes,
47-
id: UUID,
48-
type: OrgGroupType,
49-
relationships: Union[OrgGroupRelationships, UnsetType] = unset,
50-
**kwargs,
51-
):
38+
def __init__(self_, attributes: OrgGroupAttributes, id: UUID, type: OrgGroupType, **kwargs):
5239
"""
5340
An org group resource.
5441
@@ -58,14 +45,9 @@ def __init__(
5845
:param id: The ID of the org group.
5946
:type id: UUID
6047
61-
:param relationships: Relationships of an org group.
62-
:type relationships: OrgGroupRelationships, optional
63-
6448
:param type: Org groups resource type.
6549
:type type: OrgGroupType
6650
"""
67-
if relationships is not unset:
68-
kwargs["relationships"] = relationships
6951
super().__init__(kwargs)
7052

7153
self_.attributes = attributes

0 commit comments

Comments
 (0)