Skip to content

Commit 235c18a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Document missing parameters (#1680)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent dc9e148 commit 235c18a

13 files changed

+293
-7
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2023-10-23 18:35:36.214958",
8-
"spec_repo_commit": "696abec0"
7+
"regenerated": "2023-10-24 18:01:02.090771",
8+
"spec_repo_commit": "7e490450"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2023-10-23 18:35:36.233010",
13-
"spec_repo_commit": "696abec0"
12+
"regenerated": "2023-10-24 18:01:02.104260",
13+
"spec_repo_commit": "7e490450"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 76 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ components:
44
headers: {}
55
links: {}
66
parameters:
7+
APIKeyCategoryParameter:
8+
description: Filter API keys by category.
9+
in: query
10+
name: filter[category]
11+
required: false
12+
schema:
13+
type: string
714
APIKeyFilterCreatedAtEndParameter:
815
description: Only include API keys created on or before the specified date.
916
in: query
@@ -59,6 +66,13 @@ components:
5966
schema:
6067
example: created_by,modified_by
6168
type: string
69+
APIKeyReadConfigReadEnabledParameter:
70+
description: Filter API keys by remote config read enabled status.
71+
in: query
72+
name: filter[remote_config_read_enabled]
73+
required: false
74+
schema:
75+
type: boolean
6276
APIKeysSortParameter:
6377
description: 'API key attribute used to sort results. Sort order is ascending
6478

@@ -17744,6 +17758,41 @@ components:
1774417758
required:
1774517759
- data
1774617760
type: object
17761+
TeamsField:
17762+
description: Supported teams field.
17763+
enum:
17764+
- id
17765+
- name
17766+
- handle
17767+
- summary
17768+
- description
17769+
- avatar
17770+
- banner
17771+
- visible_modules
17772+
- hidden_modules
17773+
- created_at
17774+
- modified_at
17775+
- user_count
17776+
- link_count
17777+
- team_links
17778+
- user_team_permissions
17779+
type: string
17780+
x-enum-varnames:
17781+
- ID
17782+
- NAME
17783+
- HANDLE
17784+
- SUMMARY
17785+
- DESCRIPTION
17786+
- AVATAR
17787+
- BANNER
17788+
- VISIBLE_MODULES
17789+
- HIDDEN_MODULES
17790+
- CREATED_AT
17791+
- MODIFIED_AT
17792+
- USER_COUNT
17793+
- LINK_COUNT
17794+
- TEAM_LINKS
17795+
- USER_TEAM_PERMISSIONS
1774717796
TeamsResponse:
1774817797
description: Response with multiple teams
1774917798
properties:
@@ -18378,8 +18427,8 @@ components:
1837818427
description: User team permission attributes
1837918428
properties:
1838018429
permissions:
18381-
description: Object of team permission actions and boolean values indicating
18382-
of the currently logged in user can perform them on this team
18430+
description: Object of team permission actions and boolean values that a
18431+
logged in user can perform on this team.
1838318432
readOnly: true
1838418433
type: object
1838518434
type: object
@@ -18634,6 +18683,8 @@ paths:
1863418683
- $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter'
1863518684
- $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter'
1863618685
- $ref: '#/components/parameters/APIKeyIncludeParameter'
18686+
- $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter'
18687+
- $ref: '#/components/parameters/APIKeyCategoryParameter'
1863718688
responses:
1863818689
'200':
1863918690
content:
@@ -19067,6 +19118,7 @@ paths:
1906719118
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
1906819119
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
1906919120
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
19121+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
1907019122
responses:
1907119123
'200':
1907219124
content:
@@ -20106,6 +20158,7 @@ paths:
2010620158
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
2010720159
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
2010820160
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
20161+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
2010920162
responses:
2011020163
'200':
2011120164
content:
@@ -25055,6 +25108,12 @@ paths:
2505525108
required: false
2505625109
schema:
2505725110
type: string
25111+
- description: Filter all roles by the given list of role IDs.
25112+
in: query
25113+
name: filter[id]
25114+
required: false
25115+
schema:
25116+
type: string
2505825117
responses:
2505925118
'200':
2506025119
content:
@@ -27775,12 +27834,14 @@ paths:
2777527834
- description: Specifies the order of the returned teams
2777627835
in: query
2777727836
name: sort
27837+
required: false
2777827838
schema:
2777927839
$ref: '#/components/schemas/ListTeamsSort'
2778027840
- description: 'Included related resources optionally requested. Allowed enum
2778127841
values: `team_links, user_team_permissions`'
2778227842
in: query
2778327843
name: include
27844+
required: false
2778427845
schema:
2778527846
items:
2778627847
$ref: '#/components/schemas/ListTeamsInclude'
@@ -27789,13 +27850,24 @@ paths:
2778927850
member
2779027851
in: query
2779127852
name: filter[keyword]
27853+
required: false
2779227854
schema:
2779327855
type: string
2779427856
- description: When true, only returns teams the current user belongs to
2779527857
in: query
2779627858
name: filter[me]
27859+
required: false
2779727860
schema:
2779827861
type: boolean
27862+
- description: List of fields that need to be fetched.
27863+
explode: false
27864+
in: query
27865+
name: fields[team]
27866+
required: false
27867+
schema:
27868+
items:
27869+
$ref: '#/components/schemas/TeamsField'
27870+
type: array
2779927871
responses:
2780027872
'200':
2780127873
content:
@@ -28210,11 +28282,13 @@ paths:
2821028282
- description: Specifies the order of returned team memberships
2821128283
in: query
2821228284
name: sort
28285+
required: false
2821328286
schema:
2821428287
$ref: '#/components/schemas/GetTeamMembershipsSort'
2821528288
- description: Search query, can be user email or name
2821628289
in: query
2821728290
name: filter[keyword]
28291+
required: false
2821828292
schema:
2821928293
type: string
2822028294
responses:

‎docs/datadog_api_client.v2.model.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7918,6 +7918,13 @@ team\_update\_request
79187918
:members:
79197919
:show-inheritance:
79207920

7921+
teams\_field
7922+
------------
7923+
7924+
.. automodule:: datadog_api_client.v2.model.teams_field
7925+
:members:
7926+
:show-inheritance:
7927+
79217928
teams\_response
79227929
---------------
79237930

‎examples/v2/teams/ListTeams_3429963470.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""
2+
Get all teams with fields_team parameter returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.teams_api import TeamsApi
7+
from datadog_api_client.v2.model.teams_field import TeamsField
8+
9+
configuration = Configuration()
10+
with ApiClient(configuration) as api_client:
11+
api_instance = TeamsApi(api_client)
12+
response = api_instance.list_teams(
13+
fields_team=[
14+
TeamsField.ID,
15+
TeamsField.NAME,
16+
TeamsField.HANDLE,
17+
],
18+
)
19+
20+
print(response)

‎src/datadog_api_client/v2/api/key_management_api.py

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,16 @@ def __init__(self, api_client=None):
279279
"attribute": "include",
280280
"location": "query",
281281
},
282+
"filter_remote_config_read_enabled": {
283+
"openapi_types": (bool,),
284+
"attribute": "filter[remote_config_read_enabled]",
285+
"location": "query",
286+
},
287+
"filter_category": {
288+
"openapi_types": (str,),
289+
"attribute": "filter[category]",
290+
"location": "query",
291+
},
282292
},
283293
headers_map={
284294
"accept": ["application/json"],
@@ -326,6 +336,11 @@ def __init__(self, api_client=None):
326336
"attribute": "filter[created_at][end]",
327337
"location": "query",
328338
},
339+
"include": {
340+
"openapi_types": (str,),
341+
"attribute": "include",
342+
"location": "query",
343+
},
329344
},
330345
headers_map={
331346
"accept": ["application/json"],
@@ -373,6 +388,11 @@ def __init__(self, api_client=None):
373388
"attribute": "filter[created_at][end]",
374389
"location": "query",
375390
},
391+
"include": {
392+
"openapi_types": (str,),
393+
"attribute": "include",
394+
"location": "query",
395+
},
376396
},
377397
headers_map={
378398
"accept": ["application/json"],
@@ -618,6 +638,8 @@ def list_api_keys(
618638
filter_modified_at_start: Union[str, UnsetType] = unset,
619639
filter_modified_at_end: Union[str, UnsetType] = unset,
620640
include: Union[str, UnsetType] = unset,
641+
filter_remote_config_read_enabled: Union[bool, UnsetType] = unset,
642+
filter_category: Union[str, UnsetType] = unset,
621643
) -> APIKeysResponse:
622644
"""Get all API keys.
623645
@@ -643,6 +665,10 @@ def list_api_keys(
643665
:type filter_modified_at_end: str, optional
644666
:param include: Comma separated list of resource paths for related resources to include in the response. Supported resource paths are ``created_by`` and ``modified_by``.
645667
:type include: str, optional
668+
:param filter_remote_config_read_enabled: Filter API keys by remote config read enabled status.
669+
:type filter_remote_config_read_enabled: bool, optional
670+
:param filter_category: Filter API keys by category.
671+
:type filter_category: str, optional
646672
:rtype: APIKeysResponse
647673
"""
648674
kwargs: Dict[str, Any] = {}
@@ -673,6 +699,12 @@ def list_api_keys(
673699
if include is not unset:
674700
kwargs["include"] = include
675701

702+
if filter_remote_config_read_enabled is not unset:
703+
kwargs["filter_remote_config_read_enabled"] = filter_remote_config_read_enabled
704+
705+
if filter_category is not unset:
706+
kwargs["filter_category"] = filter_category
707+
676708
return self._list_api_keys_endpoint.call_with_http_info(**kwargs)
677709

678710
def list_application_keys(
@@ -684,6 +716,7 @@ def list_application_keys(
684716
filter: Union[str, UnsetType] = unset,
685717
filter_created_at_start: Union[str, UnsetType] = unset,
686718
filter_created_at_end: Union[str, UnsetType] = unset,
719+
include: Union[str, UnsetType] = unset,
687720
) -> ListApplicationKeysResponse:
688721
"""Get all application keys.
689722
@@ -703,6 +736,8 @@ def list_application_keys(
703736
:type filter_created_at_start: str, optional
704737
:param filter_created_at_end: Only include application keys created on or before the specified date.
705738
:type filter_created_at_end: str, optional
739+
:param include: Resource path for related resources to include in the response. Only ``owned_by`` is supported.
740+
:type include: str, optional
706741
:rtype: ListApplicationKeysResponse
707742
"""
708743
kwargs: Dict[str, Any] = {}
@@ -724,6 +759,9 @@ def list_application_keys(
724759
if filter_created_at_end is not unset:
725760
kwargs["filter_created_at_end"] = filter_created_at_end
726761

762+
if include is not unset:
763+
kwargs["include"] = include
764+
727765
return self._list_application_keys_endpoint.call_with_http_info(**kwargs)
728766

729767
def list_current_user_application_keys(
@@ -735,6 +773,7 @@ def list_current_user_application_keys(
735773
filter: Union[str, UnsetType] = unset,
736774
filter_created_at_start: Union[str, UnsetType] = unset,
737775
filter_created_at_end: Union[str, UnsetType] = unset,
776+
include: Union[str, UnsetType] = unset,
738777
) -> ListApplicationKeysResponse:
739778
"""Get all application keys owned by current user.
740779
@@ -754,6 +793,8 @@ def list_current_user_application_keys(
754793
:type filter_created_at_start: str, optional
755794
:param filter_created_at_end: Only include application keys created on or before the specified date.
756795
:type filter_created_at_end: str, optional
796+
:param include: Resource path for related resources to include in the response. Only ``owned_by`` is supported.
797+
:type include: str, optional
757798
:rtype: ListApplicationKeysResponse
758799
"""
759800
kwargs: Dict[str, Any] = {}
@@ -775,6 +816,9 @@ def list_current_user_application_keys(
775816
if filter_created_at_end is not unset:
776817
kwargs["filter_created_at_end"] = filter_created_at_end
777818

819+
if include is not unset:
820+
kwargs["include"] = include
821+
778822
return self._list_current_user_application_keys_endpoint.call_with_http_info(**kwargs)
779823

780824
def update_api_key(

‎src/datadog_api_client/v2/api/roles_api.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,11 @@ def __init__(self, api_client=None):
255255
"attribute": "filter",
256256
"location": "query",
257257
},
258+
"filter_id": {
259+
"openapi_types": (str,),
260+
"attribute": "filter[id]",
261+
"location": "query",
262+
},
258263
},
259264
headers_map={
260265
"accept": ["application/json"],
@@ -532,6 +537,7 @@ def list_roles(
532537
page_number: Union[int, UnsetType] = unset,
533538
sort: Union[RolesSort, UnsetType] = unset,
534539
filter: Union[str, UnsetType] = unset,
540+
filter_id: Union[str, UnsetType] = unset,
535541
) -> RolesResponse:
536542
"""List roles.
537543
@@ -547,6 +553,8 @@ def list_roles(
547553
:type sort: RolesSort, optional
548554
:param filter: Filter all roles by the given string.
549555
:type filter: str, optional
556+
:param filter_id: Filter all roles by the given list of role IDs.
557+
:type filter_id: str, optional
550558
:rtype: RolesResponse
551559
"""
552560
kwargs: Dict[str, Any] = {}
@@ -562,6 +570,9 @@ def list_roles(
562570
if filter is not unset:
563571
kwargs["filter"] = filter
564572

573+
if filter_id is not unset:
574+
kwargs["filter_id"] = filter_id
575+
565576
return self._list_roles_endpoint.call_with_http_info(**kwargs)
566577

567578
def list_role_users(

0 commit comments

Comments
 (0)