Skip to content

Fix Org Groups pagination response shape (meta.page + links) #3470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix Org Groups pagination response shape (meta.page + links) #3470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 120 additions & 13 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51964,6 +51964,8 @@ components:
items:
$ref: "#/components/schemas/OrgGroupMembershipData"
type: array
links:
$ref: "#/components/schemas/OrgGroupPaginationLinks"
meta:
$ref: "#/components/schemas/OrgGroupPaginationMeta"
required:
Expand Down Expand Up @@ -52081,6 +52083,8 @@ components:
items:
$ref: "#/components/schemas/OrgGroupMembershipData"
type: array
links:
$ref: "#/components/schemas/OrgGroupPaginationLinks"
meta:
$ref: "#/components/schemas/OrgGroupPaginationMeta"
required:
Expand Down Expand Up @@ -52181,24 +52185,71 @@ components:
required:
- data
type: object
OrgGroupPaginationLinks:
description: Pagination links for navigating between pages of an org group list response.
properties:
first:
description: Link to the first page.
type: string
last:
description: Link to the last page.
type: string
next:
description: Link to the next page.
nullable: true
type: string
prev:
description: Link to the previous page.
nullable: true
type: string
self:
description: Link to the current page.
type: string
type: object
OrgGroupPaginationMeta:
description: Pagination metadata.
description: Pagination metadata for org group list responses.
properties:
page:
$ref: "#/components/schemas/OrgGroupPaginationMetaPage"
required:
- page
type: object
OrgGroupPaginationMetaPage:
description: Page-based pagination details.
description: Page-based pagination details for org group list responses.
properties:
total_count:
description: The total number of items.
example: 42
first_number:
description: First page number.
format: int64
type: integer
required:
- total_count
last_number:
description: Last page number.
format: int64
nullable: true
type: integer
next_number:
description: Next page number.
format: int64
nullable: true
type: integer
number:
description: Page number.
format: int64
type: integer
prev_number:
description: Previous page number.
format: int64
nullable: true
type: integer
size:
description: Page size.
format: int64
type: integer
total:
description: Total number of results.
format: int64
type: integer
type:
description: Pagination type.
example: "number_size"
type: string
type: object
OrgGroupPolicyAttributes:
description: Attributes of an org group policy.
Expand Down Expand Up @@ -52388,6 +52439,8 @@ components:
items:
$ref: "#/components/schemas/OrgGroupPolicyData"
type: array
links:
$ref: "#/components/schemas/OrgGroupPaginationLinks"
meta:
$ref: "#/components/schemas/OrgGroupPaginationMeta"
required:
Expand Down Expand Up @@ -52501,6 +52554,8 @@ components:
items:
$ref: "#/components/schemas/OrgGroupPolicyOverrideData"
type: array
links:
$ref: "#/components/schemas/OrgGroupPaginationLinks"
meta:
$ref: "#/components/schemas/OrgGroupPaginationMeta"
required:
Expand Down Expand Up @@ -111582,9 +111637,22 @@ paths:
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
type: org_group_memberships
links:
first: "https://api.datadoghq.com/api/v2/org_group_memberships?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
last: "https://api.datadoghq.com/api/v2/org_group_memberships?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
next:
prev:
self: "https://api.datadoghq.com/api/v2/org_group_memberships?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
meta:
page:
total_count: 1
first_number: 0
last_number: 0
next_number:
number: 0
prev_number:
size: 50
total: 1
type: number_size
schema:
$ref: "#/components/schemas/OrgGroupMembershipListResponse"
description: OK
Expand Down Expand Up @@ -111883,9 +111951,22 @@ paths:
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
type: org_group_policies
links:
first: "https://api.datadoghq.com/api/v2/org_group_policies?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
last: "https://api.datadoghq.com/api/v2/org_group_policies?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
next:
prev:
self: "https://api.datadoghq.com/api/v2/org_group_policies?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
meta:
page:
total_count: 1
first_number: 0
last_number: 0
next_number:
number: 0
prev_number:
size: 50
total: 1
type: number_size
schema:
$ref: "#/components/schemas/OrgGroupPolicyListResponse"
description: OK
Expand Down Expand Up @@ -112274,9 +112355,22 @@ paths:
id: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
type: org_group_policies
type: org_group_policy_overrides
links:
first: "https://api.datadoghq.com/api/v2/org_group_policy_overrides?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
last: "https://api.datadoghq.com/api/v2/org_group_policy_overrides?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
next:
prev:
self: "https://api.datadoghq.com/api/v2/org_group_policy_overrides?filter%5Borg_group_id%5D=a1b2c3d4-e5f6-7890-abcd-ef0123456789&page%5Bnumber%5D=0&page%5Bsize%5D=50"
meta:
page:
total_count: 1
first_number: 0
last_number: 0
next_number:
number: 0
prev_number:
size: 50
total: 1
type: number_size
schema:
$ref: "#/components/schemas/OrgGroupPolicyOverrideListResponse"
description: OK
Expand Down Expand Up @@ -112615,9 +112709,22 @@ paths:
owner_org_uuid: "b2c3d4e5-f6a7-8901-bcde-f01234567890"
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
links:
first: "https://api.datadoghq.com/api/v2/org_groups?page%5Bnumber%5D=0&page%5Bsize%5D=50"
last: "https://api.datadoghq.com/api/v2/org_groups?page%5Bnumber%5D=0&page%5Bsize%5D=50"
next:
prev:
self: "https://api.datadoghq.com/api/v2/org_groups?page%5Bnumber%5D=0&page%5Bsize%5D=50"
meta:
page:
total_count: 1
first_number: 0
last_number: 0
next_number:
number: 0
prev_number:
size: 50
total: 1
type: number_size
schema:
$ref: "#/components/schemas/OrgGroupListResponse"
description: OK
Expand Down
7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22936,6 +22936,13 @@ datadog\_api\_client.v2.model.org\_group\_memberships\_relationship module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.org\_group\_pagination\_links module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.org_group_pagination_links
:members:
:show-inheritance:

datadog\_api\_client.v2.model.org\_group\_pagination\_meta module
-----------------------------------------------------------------

Expand Down
12 changes: 11 additions & 1 deletion src/datadog_api_client/v2/model/org_group_list_response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
if TYPE_CHECKING:
from datadog_api_client.v2.model.org_group_data import OrgGroupData
from datadog_api_client.v2.model.org_group_membership_data import OrgGroupMembershipData
from datadog_api_client.v2.model.org_group_pagination_links import OrgGroupPaginationLinks
from datadog_api_client.v2.model.org_group_pagination_meta import OrgGroupPaginationMeta


Expand All @@ -24,24 +25,28 @@ class OrgGroupListResponse(ModelNormal):
def openapi_types(_):
from datadog_api_client.v2.model.org_group_data import OrgGroupData
from datadog_api_client.v2.model.org_group_membership_data import OrgGroupMembershipData
from datadog_api_client.v2.model.org_group_pagination_links import OrgGroupPaginationLinks
from datadog_api_client.v2.model.org_group_pagination_meta import OrgGroupPaginationMeta

return {
"data": ([OrgGroupData],),
"included": ([OrgGroupMembershipData],),
"links": (OrgGroupPaginationLinks,),
"meta": (OrgGroupPaginationMeta,),
}

attribute_map = {
"data": "data",
"included": "included",
"links": "links",
"meta": "meta",
}

def __init__(
self_,
data: List[OrgGroupData],
included: Union[List[OrgGroupMembershipData], UnsetType] = unset,
links: Union[OrgGroupPaginationLinks, UnsetType] = unset,
meta: Union[OrgGroupPaginationMeta, UnsetType] = unset,
**kwargs,
):
Expand All @@ -54,11 +59,16 @@ def __init__(
:param included: Related resources included in the response when requested with the ``include`` parameter.
:type included: [OrgGroupMembershipData], optional

:param meta: Pagination metadata.
:param links: Pagination links for navigating between pages of an org group list response.
:type links: OrgGroupPaginationLinks, optional

:param meta: Pagination metadata for org group list responses.
:type meta: OrgGroupPaginationMeta, optional
"""
if included is not unset:
kwargs["included"] = included
if links is not unset:
kwargs["links"] = links
if meta is not unset:
kwargs["meta"] = meta
super().__init__(kwargs)
Expand Down
17 changes: 15 additions & 2 deletions src/datadog_api_client/v2/model/org_group_membership_list_response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,50 @@

if TYPE_CHECKING:
from datadog_api_client.v2.model.org_group_membership_data import OrgGroupMembershipData
from datadog_api_client.v2.model.org_group_pagination_links import OrgGroupPaginationLinks
from datadog_api_client.v2.model.org_group_pagination_meta import OrgGroupPaginationMeta


class OrgGroupMembershipListResponse(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.org_group_membership_data import OrgGroupMembershipData
from datadog_api_client.v2.model.org_group_pagination_links import OrgGroupPaginationLinks
from datadog_api_client.v2.model.org_group_pagination_meta import OrgGroupPaginationMeta

return {
"data": ([OrgGroupMembershipData],),
"links": (OrgGroupPaginationLinks,),
"meta": (OrgGroupPaginationMeta,),
}

attribute_map = {
"data": "data",
"links": "links",
"meta": "meta",
}

def __init__(
self_, data: List[OrgGroupMembershipData], meta: Union[OrgGroupPaginationMeta, UnsetType] = unset, **kwargs
self_,
data: List[OrgGroupMembershipData],
links: Union[OrgGroupPaginationLinks, UnsetType] = unset,
meta: Union[OrgGroupPaginationMeta, UnsetType] = unset,
**kwargs,
):
"""
Response containing a list of org group memberships.

:param data: An array of org group memberships.
:type data: [OrgGroupMembershipData]

:param meta: Pagination metadata.
:param links: Pagination links for navigating between pages of an org group list response.
:type links: OrgGroupPaginationLinks, optional

:param meta: Pagination metadata for org group list responses.
:type meta: OrgGroupPaginationMeta, optional
"""
if links is not unset:
kwargs["links"] = links
if meta is not unset:
kwargs["meta"] = meta
super().__init__(kwargs)
Expand Down
Loading
Loading