Skip to content

Commit dc7a4e6

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 66bd9ba of spec repo
1 parent 1094864 commit dc7a4e6

19 files changed

Lines changed: 1445 additions & 0 deletions

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

Lines changed: 281 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,14 @@ components:
435435
schema:
436436
example: "service:myservice"
437437
type: string
438+
EntityIntegrationConfigID:
439+
description: The identifier of the integration whose configuration is being managed. Supported values are `github`, `jira`, and `pagerduty`.
440+
in: path
441+
name: integration_id
442+
required: true
443+
schema:
444+
example: github
445+
type: string
438446
FastlyAccountID:
439447
description: Fastly Account id.
440448
in: path
@@ -27199,6 +27207,103 @@ components:
2719927207
description: Entity.
2720027208
type: string
2720127209
type: object
27210+
EntityIntegrationConfigAttributes:
27211+
description: The organization ID, integration identifier, and integration-specific configuration payload for an entity integration configuration.
27212+
properties:
27213+
config:
27214+
$ref: "#/components/schemas/EntityIntegrationConfigPayload"
27215+
integration_id:
27216+
description: The identifier of the integration this configuration applies to (for example, `github`, `jira`, or `pagerduty`).
27217+
example: github
27218+
type: string
27219+
org_id:
27220+
description: The Datadog organization identifier that owns this configuration.
27221+
example: 1234
27222+
format: int64
27223+
type: integer
27224+
required:
27225+
- org_id
27226+
- integration_id
27227+
- config
27228+
type: object
27229+
EntityIntegrationConfigData:
27230+
description: JSON:API resource object for an entity integration configuration.
27231+
properties:
27232+
attributes:
27233+
$ref: "#/components/schemas/EntityIntegrationConfigAttributes"
27234+
id:
27235+
description: Unique identifier of the entity integration configuration.
27236+
example: 01HJABCD12345678ABCDEFGHIJ
27237+
type: string
27238+
type:
27239+
$ref: "#/components/schemas/EntityIntegrationConfigType"
27240+
required:
27241+
- id
27242+
- type
27243+
- attributes
27244+
type: object
27245+
EntityIntegrationConfigPayload:
27246+
additionalProperties: {}
27247+
description: Integration-specific configuration payload. The shape of this object depends on the integration identified by the path parameter. For `github`, the object must contain an `enabled_repos` array. For `jira`, it must contain an `enabled_projects` array. For `pagerduty`, it must contain an `accounts` array.
27248+
example:
27249+
enabled_repos:
27250+
- github_org_name: myorg
27251+
hostname: github.com
27252+
repo_name: myrepo
27253+
type: object
27254+
EntityIntegrationConfigRequest:
27255+
description: Request body used to create or replace the configuration for a given integration.
27256+
properties:
27257+
data:
27258+
$ref: "#/components/schemas/EntityIntegrationConfigRequestData"
27259+
required:
27260+
- data
27261+
type: object
27262+
EntityIntegrationConfigRequestAttributes:
27263+
description: Attributes used to create or update an entity integration configuration.
27264+
properties:
27265+
config:
27266+
$ref: "#/components/schemas/EntityIntegrationConfigPayload"
27267+
required:
27268+
- config
27269+
type: object
27270+
EntityIntegrationConfigRequestData:
27271+
description: JSON:API resource object used in a request to create or update an entity integration configuration.
27272+
properties:
27273+
attributes:
27274+
$ref: "#/components/schemas/EntityIntegrationConfigRequestAttributes"
27275+
type:
27276+
$ref: "#/components/schemas/EntityIntegrationConfigRequestType"
27277+
required:
27278+
- type
27279+
- attributes
27280+
type: object
27281+
EntityIntegrationConfigRequestType:
27282+
default: entity_integration_config_requests
27283+
description: JSON:API resource type for the entity integration configuration create or update request. Always `entity_integration_config_requests`.
27284+
enum:
27285+
- entity_integration_config_requests
27286+
example: entity_integration_config_requests
27287+
type: string
27288+
x-enum-varnames:
27289+
- ENTITY_INTEGRATION_CONFIG_REQUESTS
27290+
EntityIntegrationConfigResponse:
27291+
description: JSON:API document containing a single entity integration configuration resource.
27292+
properties:
27293+
data:
27294+
$ref: "#/components/schemas/EntityIntegrationConfigData"
27295+
required:
27296+
- data
27297+
type: object
27298+
EntityIntegrationConfigType:
27299+
default: entity_integration_configs
27300+
description: JSON:API resource type for an entity integration configuration. Always `entity_integration_configs`.
27301+
enum:
27302+
- entity_integration_configs
27303+
example: entity_integration_configs
27304+
type: string
27305+
x-enum-varnames:
27306+
- ENTITY_INTEGRATION_CONFIGS
2720227307
EntityMeta:
2720327308
description: Entity metadata.
2720427309
properties:
@@ -114501,6 +114606,180 @@ paths:
114501114606
x-unstable: |-
114502114607
**Note**: This endpoint is in public beta and is subject to change.
114503114608
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
114609+
/api/v2/idp/entity_integrations/{integration_id}:
114610+
delete:
114611+
description: Delete the configuration stored for a given integration in the caller's organization.
114612+
operationId: DeleteEntityIntegrationConfig
114613+
parameters:
114614+
- $ref: "#/components/parameters/EntityIntegrationConfigID"
114615+
responses:
114616+
"204":
114617+
description: No Content
114618+
"400":
114619+
content:
114620+
application/json:
114621+
schema:
114622+
$ref: "#/components/schemas/JSONAPIErrorResponse"
114623+
description: Bad Request
114624+
"403":
114625+
$ref: "#/components/responses/NotAuthorizedResponse"
114626+
"404":
114627+
content:
114628+
application/json:
114629+
schema:
114630+
$ref: "#/components/schemas/JSONAPIErrorResponse"
114631+
description: Not Found
114632+
"429":
114633+
$ref: "#/components/responses/TooManyRequestsResponse"
114634+
summary: Delete an entity integration configuration
114635+
tags:
114636+
- Entity Integration Configs
114637+
x-permission:
114638+
operator: OR
114639+
permissions:
114640+
- manage_integrations
114641+
x-unstable: |-
114642+
**Note**: This endpoint is in preview and is subject to change.
114643+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
114644+
get:
114645+
description: Retrieve the configuration currently stored for a given integration in the caller's organization.
114646+
operationId: GetEntityIntegrationConfig
114647+
parameters:
114648+
- $ref: "#/components/parameters/EntityIntegrationConfigID"
114649+
responses:
114650+
"200":
114651+
content:
114652+
application/json:
114653+
example:
114654+
data:
114655+
attributes:
114656+
config:
114657+
enabled_repos:
114658+
- github_org_name: myorg
114659+
hostname: github.com
114660+
repo_name: myrepo
114661+
integration_id: github
114662+
org_id: 1234
114663+
id: 01HJABCD12345678ABCDEFGHIJ
114664+
type: entity_integration_configs
114665+
schema:
114666+
$ref: "#/components/schemas/EntityIntegrationConfigResponse"
114667+
description: OK
114668+
"400":
114669+
content:
114670+
application/json:
114671+
schema:
114672+
$ref: "#/components/schemas/JSONAPIErrorResponse"
114673+
description: Bad Request
114674+
"403":
114675+
$ref: "#/components/responses/NotAuthorizedResponse"
114676+
"404":
114677+
content:
114678+
application/json:
114679+
schema:
114680+
$ref: "#/components/schemas/JSONAPIErrorResponse"
114681+
description: Not Found
114682+
"429":
114683+
$ref: "#/components/responses/TooManyRequestsResponse"
114684+
summary: Get an entity integration configuration
114685+
tags:
114686+
- Entity Integration Configs
114687+
x-permission:
114688+
operator: OR
114689+
permissions:
114690+
- integrations_read
114691+
x-unstable: |-
114692+
**Note**: This endpoint is in preview and is subject to change.
114693+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
114694+
put:
114695+
description: |-
114696+
Create or replace the configuration for a given integration in the caller's organization. The shape of `data.attributes.config` depends on the integration:
114697+
114698+
- For `github`: `config` must contain an `enabled_repos` array of objects with `hostname`, `github_org_name`, and `repo_name`.
114699+
- For `jira`: `config` must contain an `enabled_projects` array of objects with `hostname`, `account_id`, and `project_key`.
114700+
- For `pagerduty`: `config` must contain an `accounts` array of objects with a required `enabled` boolean and an optional `subdomain` string.
114701+
operationId: UpdateEntityIntegrationConfig
114702+
parameters:
114703+
- $ref: "#/components/parameters/EntityIntegrationConfigID"
114704+
requestBody:
114705+
content:
114706+
application/json:
114707+
examples:
114708+
default:
114709+
summary: GitHub integration configuration
114710+
value:
114711+
data:
114712+
attributes:
114713+
config:
114714+
enabled_repos:
114715+
- github_org_name: myorg
114716+
hostname: github.com
114717+
repo_name: myrepo
114718+
type: entity_integration_config_requests
114719+
jira:
114720+
summary: Jira integration configuration
114721+
value:
114722+
data:
114723+
attributes:
114724+
config:
114725+
enabled_projects:
114726+
- account_id: "123456789"
114727+
hostname: mycompany.atlassian.net
114728+
project_key: AAA
114729+
type: entity_integration_config_requests
114730+
pagerduty:
114731+
summary: PagerDuty integration configuration
114732+
value:
114733+
data:
114734+
attributes:
114735+
config:
114736+
accounts:
114737+
- enabled: true
114738+
subdomain: mycompany
114739+
type: entity_integration_config_requests
114740+
schema:
114741+
$ref: "#/components/schemas/EntityIntegrationConfigRequest"
114742+
required: true
114743+
responses:
114744+
"200":
114745+
content:
114746+
application/json:
114747+
example:
114748+
data:
114749+
attributes:
114750+
config:
114751+
enabled_repos:
114752+
- github_org_name: myorg
114753+
hostname: github.com
114754+
repo_name: myrepo
114755+
integration_id: github
114756+
org_id: 1234
114757+
id: 01HJABCD12345678ABCDEFGHIJ
114758+
type: entity_integration_configs
114759+
schema:
114760+
$ref: "#/components/schemas/EntityIntegrationConfigResponse"
114761+
description: OK
114762+
"400":
114763+
content:
114764+
application/json:
114765+
schema:
114766+
$ref: "#/components/schemas/JSONAPIErrorResponse"
114767+
description: Bad Request
114768+
"403":
114769+
$ref: "#/components/responses/NotAuthorizedResponse"
114770+
"429":
114771+
$ref: "#/components/responses/TooManyRequestsResponse"
114772+
summary: Create or update entity integration configuration
114773+
tags:
114774+
- Entity Integration Configs
114775+
x-codegen-request-body-name: body
114776+
x-permission:
114777+
operator: OR
114778+
permissions:
114779+
- integrations_read
114780+
x-unstable: |-
114781+
**Note**: This endpoint is in preview and is subject to change.
114782+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
114504114783
/api/v2/incidents:
114505114784
get:
114506114785
description: >-
@@ -161782,6 +162061,8 @@ tags:
161782162061
scopes from alerting. Downtime settings, which can be scheduled with start and
161783162062
end times, prevent all alerting related to specified Datadog tags.
161784162063
name: Downtimes
162064+
- description: Manage per-integration configurations for the Internal Developer Portal (IDP). These configurations control which external resources (for example, GitHub repositories, Jira projects, or PagerDuty services) are synced as entities into the Software Catalog.
162065+
name: Entity Integration Configs
161785162066
- description: Retrieves security risk scores for entities in your organization.
161786162067
name: Entity Risk Scores
161787162068
- description: View and manage issues within Error Tracking. See the [Error Tracking page](https://docs.datadoghq.com/error_tracking/) for more information.

‎examples/v2/entity-integration-configs/DeleteEntityIntegrationConfig.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* Delete an entity integration configuration returns "No Content" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
configuration.unstableOperations["v2.deleteEntityIntegrationConfig"] = true;
9+
const apiInstance = new v2.EntityIntegrationConfigsApi(configuration);
10+
11+
const params: v2.EntityIntegrationConfigsApiDeleteEntityIntegrationConfigRequest =
12+
{
13+
integrationId: "github",
14+
};
15+
16+
apiInstance
17+
.deleteEntityIntegrationConfig(params)
18+
.then((data: any) => {
19+
console.log(
20+
"API called successfully. Returned data: " + JSON.stringify(data)
21+
);
22+
})
23+
.catch((error: any) => console.error(error));

‎examples/v2/entity-integration-configs/GetEntityIntegrationConfig.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* Get an entity integration configuration returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
configuration.unstableOperations["v2.getEntityIntegrationConfig"] = true;
9+
const apiInstance = new v2.EntityIntegrationConfigsApi(configuration);
10+
11+
const params: v2.EntityIntegrationConfigsApiGetEntityIntegrationConfigRequest =
12+
{
13+
integrationId: "github",
14+
};
15+
16+
apiInstance
17+
.getEntityIntegrationConfig(params)
18+
.then((data: v2.EntityIntegrationConfigResponse) => {
19+
console.log(
20+
"API called successfully. Returned data: " + JSON.stringify(data)
21+
);
22+
})
23+
.catch((error: any) => console.error(error));

‎examples/v2/entity-integration-configs/UpdateEntityIntegrationConfig.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/**
2+
* Create or update entity integration configuration returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
configuration.unstableOperations["v2.updateEntityIntegrationConfig"] = true;
9+
const apiInstance = new v2.EntityIntegrationConfigsApi(configuration);
10+
11+
const params: v2.EntityIntegrationConfigsApiUpdateEntityIntegrationConfigRequest =
12+
{
13+
body: {
14+
data: {
15+
attributes: {
16+
config: {
17+
enabled_repos:
18+
"[{'github_org_name': 'myorg', 'hostname': 'github.com', 'repo_name': 'myrepo'}]",
19+
},
20+
},
21+
type: "entity_integration_config_requests",
22+
},
23+
},
24+
integrationId: "github",
25+
};
26+
27+
apiInstance
28+
.updateEntityIntegrationConfig(params)
29+
.then((data: v2.EntityIntegrationConfigResponse) => {
30+
console.log(
31+
"API called successfully. Returned data: " + JSON.stringify(data)
32+
);
33+
})
34+
.catch((error: any) => console.error(error));

0 commit comments

Comments
 (0)