Skip to content

Commit 062ecff

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Update CI Visibility pipelines write API endpoint fields (#1535)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent cdbd4d2 commit 062ecff

17 files changed

+42
-157
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.4",
7-
"regenerated": "2023-06-21 18:47:24.706777",
8-
"spec_repo_commit": "0f485c44"
7+
"regenerated": "2023-06-22 16:27:12.578518",
8+
"spec_repo_commit": "3823e339"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-06-21 18:47:24.722522",
13-
"spec_repo_commit": "0f485c44"
12+
"regenerated": "2023-06-22 16:27:12.592916",
13+
"spec_repo_commit": "3823e339"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1540,7 +1540,7 @@ components:
15401540
sha:
15411541
description: The git commit SHA.
15421542
example: da39a3ee5e6b4b0d3255bfef95601890afd80709
1543-
pattern: ^[a-fA-f0-9]{40}$
1543+
pattern: ^[a-fA-F0-9]{40}$
15441544
type: string
15451545
tag:
15461546
description: The tag name (if a branch use the branch parameter).
@@ -1725,8 +1725,6 @@ components:
17251725
description: The URL to look at the job in the CI provider UI.
17261726
example: https://ci-platform.com/job/your-job-name/build/123
17271727
type: string
1728-
user:
1729-
$ref: '#/components/schemas/CIAppUserInfo'
17301728
required:
17311729
- level
17321730
- id
@@ -1737,6 +1735,7 @@ components:
17371735
- end
17381736
- status
17391737
- url
1738+
- git
17401739
type: object
17411740
CIAppPipelineEventJobLevel:
17421741
default: job
@@ -1880,8 +1879,6 @@ components:
18801879
description: The URL to look at the pipeline in the CI provider UI.
18811880
example: https://my-ci-provider.example/pipelines/my-pipeline/run/1
18821881
type: string
1883-
user:
1884-
$ref: '#/components/schemas/CIAppUserInfo'
18851882
required:
18861883
- level
18871884
- unique_id
@@ -1891,6 +1888,7 @@ components:
18911888
- end
18921889
- status
18931890
- partial_retry
1891+
- git
18941892
type: object
18951893
CIAppPipelineEventPipelineLevel:
18961894
default: pipeline
@@ -1997,8 +1995,6 @@ components:
19971995
$ref: '#/components/schemas/CIAppPipelineEventStageStatus'
19981996
tags:
19991997
$ref: '#/components/schemas/CIAppPipelineEventTags'
2000-
user:
2001-
$ref: '#/components/schemas/CIAppUserInfo'
20021998
required:
20031999
- level
20042000
- id
@@ -2008,6 +2004,7 @@ components:
20082004
- start
20092005
- end
20102006
- status
2007+
- git
20112008
type: object
20122009
CIAppPipelineEventStageLevel:
20132010
default: stage
@@ -2098,8 +2095,6 @@ components:
20982095
description: The URL to look at the step in the CI provider UI.
20992096
nullable: true
21002097
type: string
2101-
user:
2102-
$ref: '#/components/schemas/CIAppUserInfo'
21032098
required:
21042099
- level
21052100
- id
@@ -2109,6 +2104,7 @@ components:
21092104
- start
21102105
- end
21112106
- status
2107+
- git
21122108
type: object
21132109
CIAppPipelineEventStepLevel:
21142110
default: step
@@ -2544,23 +2540,6 @@ components:
25442540
example: now
25452541
type: string
25462542
type: object
2547-
CIAppUserInfo:
2548-
description: 'Used to specify user-related information when the payload does
2549-
not have Git information.
2550-
2551-
For example, if Git information is missing for manually triggered pipelines,
2552-
this field can be used instead.'
2553-
nullable: true
2554-
properties:
2555-
email:
2556-
description: Email of the user.
2557-
format: email
2558-
type: string
2559-
name:
2560-
description: Name of the user.
2561-
example: John Doe
2562-
type: string
2563-
type: object
25642543
CIAppWarning:
25652544
description: A warning message indicating something that went wrong with the
25662545
query.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -848,13 +848,6 @@ ci\_app\_tests\_query\_filter
848848
:members:
849849
:show-inheritance:
850850

851-
ci\_app\_user\_info
852-
-------------------
853-
854-
.. automodule:: datadog_api_client.v2.model.ci_app_user_info
855-
:members:
856-
:show-inheritance:
857-
858851
ci\_app\_warning
859852
----------------
860853

‎examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
from datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data_type import (
1515
CIAppCreatePipelineEventRequestDataType,
1616
)
17+
from datadog_api_client.v2.model.ci_app_git_info import CIAppGitInfo
1718
from datadog_api_client.v2.model.ci_app_pipeline_event_pipeline import CIAppPipelineEventPipeline
1819
from datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_level import CIAppPipelineEventPipelineLevel
1920
from datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_status import CIAppPipelineEventPipelineStatus
@@ -30,6 +31,11 @@
3031
status=CIAppPipelineEventPipelineStatus.SUCCESS,
3132
unique_id="3eacb6f3-ff04-4e10-8a9c-46e6d054024a",
3233
url="https://my-ci-provider.example/pipelines/my-pipeline/run/1",
34+
git=CIAppGitInfo(
35+
repository_url="https://github.com/DataDog/datadog-agent",
36+
sha="7f263865994b76066c4612fd1965215e7dcb4cd2",
37+
author_email="john.doe@email.com",
38+
),
3339
),
3440
),
3541
type=CIAppCreatePipelineEventRequestDataType.CIPIPELINE_RESOURCE_REQUEST,

‎examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
from datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data_type import (
1515
CIAppCreatePipelineEventRequestDataType,
1616
)
17+
from datadog_api_client.v2.model.ci_app_git_info import CIAppGitInfo
1718
from datadog_api_client.v2.model.ci_app_pipeline_event_job import CIAppPipelineEventJob
1819
from datadog_api_client.v2.model.ci_app_pipeline_event_job_level import CIAppPipelineEventJobLevel
1920
from datadog_api_client.v2.model.ci_app_pipeline_event_job_status import CIAppPipelineEventJobStatus
@@ -31,6 +32,11 @@
3132
pipeline_unique_id="3eacb6f3-ff04-4e10-8a9c-46e6d054024a",
3233
pipeline_name="Deploy to AWS",
3334
url="https://my-ci-provider.example/jobs/my-jobs/run/1",
35+
git=CIAppGitInfo(
36+
repository_url="https://github.com/DataDog/datadog-agent",
37+
sha="7f263865994b76066c4612fd1965215e7dcb4cd2",
38+
author_email="john.doe@email.com",
39+
),
3440
),
3541
),
3642
type=CIAppCreatePipelineEventRequestDataType.CIPIPELINE_RESOURCE_REQUEST,

‎src/datadog_api_client/v2/model/ci_app_create_pipeline_event_request_attributes_resource.py‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def __init__(self, **kwargs):
2323
2424
:param git: If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.
2525
Note that either `tag` or `branch` has to be provided, but not both.
26-
:type git: CIAppGitInfo, none_type, optional
26+
:type git: CIAppGitInfo, none_type
2727
2828
:param is_manual: Whether or not the pipeline was triggered manually by the user.
2929
:type is_manual: bool, none_type, optional
@@ -79,10 +79,6 @@ def __init__(self, **kwargs):
7979
:param url: The URL to look at the pipeline in the CI provider UI.
8080
:type url: str
8181
82-
:param user: Used to specify user-related information when the payload does not have Git information.
83-
For example, if Git information is missing for manually triggered pipelines, this field can be used instead.
84-
:type user: CIAppUserInfo, none_type, optional
85-
8682
:param dependencies: A list of stage IDs that this stage depends on.
8783
:type dependencies: [str], none_type, optional
8884

‎src/datadog_api_client/v2/model/ci_app_pipeline_event_job.py‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
from datadog_api_client.v2.model.ci_app_host_info import CIAppHostInfo
2323
from datadog_api_client.v2.model.ci_app_pipeline_event_parameters import CIAppPipelineEventParameters
2424
from datadog_api_client.v2.model.ci_app_pipeline_event_job_status import CIAppPipelineEventJobStatus
25-
from datadog_api_client.v2.model.ci_app_user_info import CIAppUserInfo
2625

2726

2827
class CIAppPipelineEventJob(ModelNormal):
@@ -40,7 +39,6 @@ def openapi_types(_):
4039
from datadog_api_client.v2.model.ci_app_host_info import CIAppHostInfo
4140
from datadog_api_client.v2.model.ci_app_pipeline_event_parameters import CIAppPipelineEventParameters
4241
from datadog_api_client.v2.model.ci_app_pipeline_event_job_status import CIAppPipelineEventJobStatus
43-
from datadog_api_client.v2.model.ci_app_user_info import CIAppUserInfo
4442

4543
return {
4644
"dependencies": ([str], none_type),
@@ -62,7 +60,6 @@ def openapi_types(_):
6260
"status": (CIAppPipelineEventJobStatus,),
6361
"tags": ([str],),
6462
"url": (str,),
65-
"user": (CIAppUserInfo,),
6663
}
6764

6865
attribute_map = {
@@ -85,12 +82,12 @@ def openapi_types(_):
8582
"status": "status",
8683
"tags": "tags",
8784
"url": "url",
88-
"user": "user",
8985
}
9086

9187
def __init__(
9288
self_,
9389
end: datetime,
90+
git: Union[CIAppGitInfo, none_type],
9491
id: str,
9592
level: CIAppPipelineEventJobLevel,
9693
name: str,
@@ -101,15 +98,13 @@ def __init__(
10198
url: str,
10299
dependencies: Union[List[str], none_type, UnsetType] = unset,
103100
error: Union[CIAppCIError, none_type, UnsetType] = unset,
104-
git: Union[CIAppGitInfo, none_type, UnsetType] = unset,
105101
metrics: Union[List[str], none_type, UnsetType] = unset,
106102
node: Union[CIAppHostInfo, none_type, UnsetType] = unset,
107103
parameters: Union[CIAppPipelineEventParameters, none_type, UnsetType] = unset,
108104
queue_time: Union[int, none_type, UnsetType] = unset,
109105
stage_id: Union[str, none_type, UnsetType] = unset,
110106
stage_name: Union[str, none_type, UnsetType] = unset,
111107
tags: Union[List[str], none_type, UnsetType] = unset,
112-
user: Union[CIAppUserInfo, none_type, UnsetType] = unset,
113108
**kwargs,
114109
):
115110
"""
@@ -126,7 +121,7 @@ def __init__(
126121
127122
:param git: If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.
128123
Note that either ``tag`` or ``branch`` has to be provided, but not both.
129-
:type git: CIAppGitInfo, none_type, optional
124+
:type git: CIAppGitInfo, none_type
130125
131126
:param id: The UUID for the job. It has to be unique within each pipeline execution.
132127
:type id: str
@@ -172,17 +167,11 @@ def __init__(
172167
173168
:param url: The URL to look at the job in the CI provider UI.
174169
:type url: str
175-
176-
:param user: Used to specify user-related information when the payload does not have Git information.
177-
For example, if Git information is missing for manually triggered pipelines, this field can be used instead.
178-
:type user: CIAppUserInfo, none_type, optional
179170
"""
180171
if dependencies is not unset:
181172
kwargs["dependencies"] = dependencies
182173
if error is not unset:
183174
kwargs["error"] = error
184-
if git is not unset:
185-
kwargs["git"] = git
186175
if metrics is not unset:
187176
kwargs["metrics"] = metrics
188177
if node is not unset:
@@ -197,11 +186,10 @@ def __init__(
197186
kwargs["stage_name"] = stage_name
198187
if tags is not unset:
199188
kwargs["tags"] = tags
200-
if user is not unset:
201-
kwargs["user"] = user
202189
super().__init__(kwargs)
203190

204191
self_.end = end
192+
self_.git = git
205193
self_.id = id
206194
self_.level = level
207195
self_.name = name

‎src/datadog_api_client/v2/model/ci_app_pipeline_event_pipeline.py‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
from datadog_api_client.v2.model.ci_app_pipeline_event_parent_pipeline import CIAppPipelineEventParentPipeline
2525
from datadog_api_client.v2.model.ci_app_pipeline_event_previous_pipeline import CIAppPipelineEventPreviousPipeline
2626
from datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_status import CIAppPipelineEventPipelineStatus
27-
from datadog_api_client.v2.model.ci_app_user_info import CIAppUserInfo
2827

2928

3029
class CIAppPipelineEventPipeline(ModelNormal):
@@ -46,7 +45,6 @@ def openapi_types(_):
4645
CIAppPipelineEventPreviousPipeline,
4746
)
4847
from datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_status import CIAppPipelineEventPipelineStatus
49-
from datadog_api_client.v2.model.ci_app_user_info import CIAppUserInfo
5048

5149
return {
5250
"end": (datetime,),
@@ -69,7 +67,6 @@ def openapi_types(_):
6967
"tags": ([str],),
7068
"unique_id": (str,),
7169
"url": (str,),
72-
"user": (CIAppUserInfo,),
7370
}
7471

7572
attribute_map = {
@@ -93,12 +90,12 @@ def openapi_types(_):
9390
"tags": "tags",
9491
"unique_id": "unique_id",
9592
"url": "url",
96-
"user": "user",
9793
}
9894

9995
def __init__(
10096
self_,
10197
end: datetime,
98+
git: Union[CIAppGitInfo, none_type],
10299
level: CIAppPipelineEventPipelineLevel,
103100
name: str,
104101
partial_retry: bool,
@@ -107,7 +104,6 @@ def __init__(
107104
unique_id: str,
108105
url: str,
109106
error: Union[CIAppCIError, none_type, UnsetType] = unset,
110-
git: Union[CIAppGitInfo, none_type, UnsetType] = unset,
111107
is_manual: Union[bool, none_type, UnsetType] = unset,
112108
is_resumed: Union[bool, none_type, UnsetType] = unset,
113109
metrics: Union[List[str], none_type, UnsetType] = unset,
@@ -118,7 +114,6 @@ def __init__(
118114
previous_attempt: Union[CIAppPipelineEventPreviousPipeline, none_type, UnsetType] = unset,
119115
queue_time: Union[int, none_type, UnsetType] = unset,
120116
tags: Union[List[str], none_type, UnsetType] = unset,
121-
user: Union[CIAppUserInfo, none_type, UnsetType] = unset,
122117
**kwargs,
123118
):
124119
"""
@@ -132,7 +127,7 @@ def __init__(
132127
133128
:param git: If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.
134129
Note that either ``tag`` or ``branch`` has to be provided, but not both.
135-
:type git: CIAppGitInfo, none_type, optional
130+
:type git: CIAppGitInfo, none_type
136131
137132
:param is_manual: Whether or not the pipeline was triggered manually by the user.
138133
:type is_manual: bool, none_type, optional
@@ -187,15 +182,9 @@ def __init__(
187182
188183
:param url: The URL to look at the pipeline in the CI provider UI.
189184
:type url: str
190-
191-
:param user: Used to specify user-related information when the payload does not have Git information.
192-
For example, if Git information is missing for manually triggered pipelines, this field can be used instead.
193-
:type user: CIAppUserInfo, none_type, optional
194185
"""
195186
if error is not unset:
196187
kwargs["error"] = error
197-
if git is not unset:
198-
kwargs["git"] = git
199188
if is_manual is not unset:
200189
kwargs["is_manual"] = is_manual
201190
if is_resumed is not unset:
@@ -216,11 +205,10 @@ def __init__(
216205
kwargs["queue_time"] = queue_time
217206
if tags is not unset:
218207
kwargs["tags"] = tags
219-
if user is not unset:
220-
kwargs["user"] = user
221208
super().__init__(kwargs)
222209

223210
self_.end = end
211+
self_.git = git
224212
self_.level = level
225213
self_.name = name
226214
self_.partial_retry = partial_retry

0 commit comments

Comments
 (0)