Skip to content

Commit 5483561

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 7cbd240 of spec repo
1 parent 5d87dab commit 5483561

20 files changed

Lines changed: 1107 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14293,6 +14293,147 @@ components:
1429314293
test_level:
1429414294
$ref: "#/components/schemas/CIAppTestLevel"
1429514295
type: object
14296+
CIAppGitHubAccountAttributes:
14297+
description: Attributes describing a GitHub account's CI Visibility opt-in status.
14298+
properties:
14299+
account:
14300+
description: The GitHub account (organization or user) name.
14301+
example: datadog
14302+
type: string
14303+
enabled:
14304+
description: Whether CI Visibility is enabled at the account level.
14305+
example: true
14306+
type: boolean
14307+
host:
14308+
description: The GitHub host (`github.com` or a GHES hostname) this account belongs to.
14309+
example: github.com
14310+
type: string
14311+
repo_count:
14312+
description: The number of repositories known for this account.
14313+
example: 12
14314+
format: int64
14315+
type: integer
14316+
repositories:
14317+
description: The repositories belonging to this account, with their individual opt-in status.
14318+
items:
14319+
$ref: "#/components/schemas/CIAppGitHubAccountRepository"
14320+
type: array
14321+
type: object
14322+
CIAppGitHubAccountData:
14323+
description: Data object for a GitHub account.
14324+
properties:
14325+
attributes:
14326+
$ref: "#/components/schemas/CIAppGitHubAccountAttributes"
14327+
id:
14328+
description: |-
14329+
The account's unique identifier, in the form `<host>/<account name>`
14330+
(for example `github.com/datadog`).
14331+
example: github.com/datadog
14332+
type: string
14333+
type:
14334+
$ref: "#/components/schemas/CIAppGitHubAccountType"
14335+
required:
14336+
- id
14337+
- type
14338+
- attributes
14339+
type: object
14340+
CIAppGitHubAccountRepository:
14341+
description: A GitHub repository within a GitHub account, and its CI Visibility opt-in status.
14342+
properties:
14343+
enabled:
14344+
description: Whether CI Visibility is enabled for this repository.
14345+
example: true
14346+
type: boolean
14347+
name:
14348+
description: The repository name.
14349+
example: shopist
14350+
type: string
14351+
type: object
14352+
CIAppGitHubAccountResponse:
14353+
description: Response object containing a single GitHub account's CI Visibility opt-in status.
14354+
properties:
14355+
data:
14356+
$ref: "#/components/schemas/CIAppGitHubAccountData"
14357+
type: object
14358+
CIAppGitHubAccountType:
14359+
description: |-
14360+
JSON:API type for the GitHub account resource.
14361+
The value must always be `ci_github_account`.
14362+
enum:
14363+
- ci_github_account
14364+
example: ci_github_account
14365+
type: string
14366+
x-enum-varnames:
14367+
- CI_GITHUB_ACCOUNT
14368+
CIAppGitHubAccountUpdateRequest:
14369+
description: Request object for updating a GitHub account's CI Visibility opt-in status.
14370+
properties:
14371+
data:
14372+
$ref: "#/components/schemas/CIAppGitHubAccountUpdateRequestData"
14373+
required:
14374+
- data
14375+
type: object
14376+
CIAppGitHubAccountUpdateRequestAttributes:
14377+
description: |-
14378+
Attributes for updating a GitHub account's CI Visibility opt-in status.
14379+
At least one of `enabled` or `repository.enabled` must be provided.
14380+
Account-level and repository-level opt-in changes are independent and may both be supplied in the same request.
14381+
properties:
14382+
account:
14383+
description: The GitHub account (organization or user) name to update, identified by name.
14384+
example: datadog
14385+
minLength: 1
14386+
type: string
14387+
enabled:
14388+
description: Whether to enable or disable CI Visibility at the account level.
14389+
example: true
14390+
type: boolean
14391+
host:
14392+
description: |-
14393+
The GitHub host (`github.com` or a GHES hostname) the account belongs to. Required to disambiguate
14394+
when the same account name exists on more than one host.
14395+
example: github.com
14396+
type: string
14397+
repository:
14398+
$ref: "#/components/schemas/CIAppGitHubAccountUpdateRequestRepository"
14399+
required:
14400+
- account
14401+
type: object
14402+
CIAppGitHubAccountUpdateRequestData:
14403+
description: Data object for updating a GitHub account's CI Visibility opt-in status.
14404+
properties:
14405+
attributes:
14406+
$ref: "#/components/schemas/CIAppGitHubAccountUpdateRequestAttributes"
14407+
type:
14408+
$ref: "#/components/schemas/CIAppGitHubAccountType"
14409+
required:
14410+
- type
14411+
- attributes
14412+
type: object
14413+
CIAppGitHubAccountUpdateRequestRepository:
14414+
description: Repository-level opt-in change to apply, identified by name.
14415+
properties:
14416+
enabled:
14417+
description: Whether to enable or disable CI Visibility for this repository.
14418+
example: true
14419+
type: boolean
14420+
name:
14421+
description: The repository name to update.
14422+
example: shopist
14423+
minLength: 1
14424+
type: string
14425+
required:
14426+
- name
14427+
- enabled
14428+
type: object
14429+
CIAppGitHubAccountsResponse:
14430+
description: Response object containing a list of GitHub accounts and their CI Visibility opt-in status.
14431+
properties:
14432+
data:
14433+
items:
14434+
$ref: "#/components/schemas/CIAppGitHubAccountData"
14435+
type: array
14436+
type: object
1429614437
CIAppGitInfo:
1429714438
description: |-
1429814439
If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.
@@ -130420,6 +130561,127 @@ paths:
130420130561
x-unstable: |-
130421130562
**Note**: This endpoint is in preview and is subject to change.
130422130563
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
130564+
/api/v2/ci/github/accounts:
130565+
get:
130566+
description: |-
130567+
Retrieve the list of GitHub accounts (organizations or users) available to this Datadog organization
130568+
through its GitHub App installation, along with each account's and repository's CI Visibility opt-in status.
130569+
operationId: ListCIAppGitHubAccounts
130570+
responses:
130571+
"200":
130572+
content:
130573+
application/json:
130574+
examples:
130575+
default:
130576+
value:
130577+
data:
130578+
- attributes:
130579+
account: datadog
130580+
enabled: true
130581+
host: github.com
130582+
repo_count: 2
130583+
repositories:
130584+
- enabled: true
130585+
name: shopist
130586+
- enabled: false
130587+
name: dd-source
130588+
id: github.com/datadog
130589+
type: ci_github_account
130590+
schema:
130591+
$ref: "#/components/schemas/CIAppGitHubAccountsResponse"
130592+
description: OK
130593+
"400":
130594+
$ref: "#/components/responses/BadRequestResponse"
130595+
"403":
130596+
$ref: "#/components/responses/NotAuthorizedResponse"
130597+
"404":
130598+
$ref: "#/components/responses/NotFoundResponse"
130599+
"429":
130600+
$ref: "#/components/responses/TooManyRequestsResponse"
130601+
security:
130602+
- apiKeyAuth: []
130603+
appKeyAuth: []
130604+
- AuthZ:
130605+
- integrations_read
130606+
summary: List GitHub CI Visibility status
130607+
tags: ["CI Visibility GitHub Accounts"]
130608+
x-permission:
130609+
operator: OR
130610+
permissions:
130611+
- integrations_read
130612+
patch:
130613+
description: |-
130614+
Enable or disable CI Visibility for a GitHub account, one of its repositories, or both in the same request.
130615+
The account (and, optionally, repository) are identified by name. Account-level and repository-level
130616+
changes are independent and may both be supplied in the same request. At least one of `enabled` or
130617+
`repository.enabled` must be provided. If the account name matches installations on more than one host,
130618+
`host` must be supplied to disambiguate, otherwise a 409 is returned. Returns a 404 if the CI Visibility
130619+
GitHub integration is not enabled for this organization, or if the given account or repository cannot be
130620+
found by name.
130621+
operationId: UpdateCIAppGitHubAccount
130622+
requestBody:
130623+
content:
130624+
application/json:
130625+
examples:
130626+
default:
130627+
value:
130628+
data:
130629+
attributes:
130630+
account: datadog
130631+
enabled: true
130632+
host: github.com
130633+
repository:
130634+
enabled: true
130635+
name: shopist
130636+
type: ci_github_account
130637+
schema:
130638+
$ref: "#/components/schemas/CIAppGitHubAccountUpdateRequest"
130639+
required: true
130640+
responses:
130641+
"200":
130642+
content:
130643+
application/json:
130644+
examples:
130645+
default:
130646+
value:
130647+
data:
130648+
attributes:
130649+
account: datadog
130650+
enabled: true
130651+
host: github.com
130652+
repo_count: 2
130653+
repositories:
130654+
- enabled: true
130655+
name: shopist
130656+
- enabled: false
130657+
name: dd-source
130658+
id: github.com/datadog
130659+
type: ci_github_account
130660+
schema:
130661+
$ref: "#/components/schemas/CIAppGitHubAccountResponse"
130662+
description: OK
130663+
"400":
130664+
$ref: "#/components/responses/BadRequestResponse"
130665+
"403":
130666+
$ref: "#/components/responses/NotAuthorizedResponse"
130667+
"404":
130668+
$ref: "#/components/responses/NotFoundResponse"
130669+
"409":
130670+
$ref: "#/components/responses/ConflictResponse"
130671+
"429":
130672+
$ref: "#/components/responses/TooManyRequestsResponse"
130673+
security:
130674+
- apiKeyAuth: []
130675+
appKeyAuth: []
130676+
- AuthZ:
130677+
- ci_provider_settings_write
130678+
summary: Update GitHub CI Visibility status
130679+
tags: ["CI Visibility GitHub Accounts"]
130680+
x-codegen-request-body-name: body
130681+
x-permission:
130682+
operator: OR
130683+
permissions:
130684+
- ci_provider_settings_write
130423130685
/api/v2/ci/pipeline:
130424130686
post:
130425130687
description: |-
@@ -213105,6 +213367,10 @@ tags:
213105213367
- description: |-
213106213368
Use the Bits AI endpoints to retrieve AI-powered investigations.
213107213369
name: Bits AI
213370+
- description: |-
213371+
Manage CI Visibility opt-in status for your GitHub accounts and repositories. See the
213372+
[CI Visibility GitHub Actions setup page](https://docs.datadoghq.com/continuous_integration/setup_dd_ci_visibility_pipelines/github_actions/) for more information.
213373+
name: CI Visibility GitHub Accounts
213108213374
- description: |-
213109213375
Search or aggregate your CI Visibility pipeline events and send them to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/) for more information.
213110213376
name: CI Visibility Pipelines

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,13 @@ datadog\_api\_client.v2.api.change\_management\_api module
137137
:members:
138138
:show-inheritance:
139139

140+
datadog\_api\_client.v2.api.ci\_visibility\_git\_hub\_accounts\_api module
141+
--------------------------------------------------------------------------
142+
143+
.. automodule:: datadog_api_client.v2.api.ci_visibility_git_hub_accounts_api
144+
:members:
145+
:show-inheritance:
146+
140147
datadog\_api\_client.v2.api.ci\_visibility\_pipelines\_api module
141148
-----------------------------------------------------------------
142149

docs/datadog_api_client.v2.model.rst

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6304,6 +6304,76 @@ datadog\_api\_client.v2.model.ci\_app\_event\_attributes module
63046304
:members:
63056305
:show-inheritance:
63066306

6307+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_attributes module
6308+
---------------------------------------------------------------------------
6309+
6310+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_attributes
6311+
:members:
6312+
:show-inheritance:
6313+
6314+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_data module
6315+
---------------------------------------------------------------------
6316+
6317+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_data
6318+
:members:
6319+
:show-inheritance:
6320+
6321+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_repository module
6322+
---------------------------------------------------------------------------
6323+
6324+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_repository
6325+
:members:
6326+
:show-inheritance:
6327+
6328+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_response module
6329+
-------------------------------------------------------------------------
6330+
6331+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_response
6332+
:members:
6333+
:show-inheritance:
6334+
6335+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_type module
6336+
---------------------------------------------------------------------
6337+
6338+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_type
6339+
:members:
6340+
:show-inheritance:
6341+
6342+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_update\_request module
6343+
--------------------------------------------------------------------------------
6344+
6345+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_update_request
6346+
:members:
6347+
:show-inheritance:
6348+
6349+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_update\_request\_attributes module
6350+
--------------------------------------------------------------------------------------------
6351+
6352+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_update_request_attributes
6353+
:members:
6354+
:show-inheritance:
6355+
6356+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_update\_request\_data module
6357+
--------------------------------------------------------------------------------------
6358+
6359+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_update_request_data
6360+
:members:
6361+
:show-inheritance:
6362+
6363+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_account\_update\_request\_repository module
6364+
--------------------------------------------------------------------------------------------
6365+
6366+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_account_update_request_repository
6367+
:members:
6368+
:show-inheritance:
6369+
6370+
datadog\_api\_client.v2.model.ci\_app\_git\_hub\_accounts\_response module
6371+
--------------------------------------------------------------------------
6372+
6373+
.. automodule:: datadog_api_client.v2.model.ci_app_git_hub_accounts_response
6374+
:members:
6375+
:show-inheritance:
6376+
63076377
datadog\_api\_client.v2.model.ci\_app\_git\_info module
63086378
-------------------------------------------------------
63096379

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
List GitHub CI Visibility status returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.ci_visibility_git_hub_accounts_api import CIVisibilityGitHubAccountsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = CIVisibilityGitHubAccountsApi(api_client)
11+
response = api_instance.list_ci_app_git_hub_accounts()
12+
13+
print(response)

0 commit comments

Comments
 (0)