Skip to content

Add OpenAPI specs for app-builder blueprints, tags, and private query endpoints #4163

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

Closed
api-clients-generation-pipeline wants to merge 1 commit into from
Closed

Add OpenAPI specs for app-builder blueprints, tags, and private query endpoints #4163

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
456 changes: 456 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions .../v2/App-Builder_216136899/Get-Blueprint-returns-Not-Found-response_2983025375/frozen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"2026-05-18T17:39:16.852Z"
57 changes: 57 additions & 0 deletions ...2/App-Builder_216136899/Get-Blueprint-returns-Not-Found-response_2983025375/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"log": {
"_recordingName": "App Builder/Get Blueprint returns \"Not Found\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
"version": "6.0.5"
},
"entries": [
{
"_id": "79b82b76e0bbb6c3c16ffc7ead4f10b4",
"_order": 0,
"cache": {},
"request": {
"bodySize": 0,
"cookies": [],
"headers": [
{
"_fromType": "array",
"name": "accept",
"value": "application/json"
}
],
"headersSize": 551,
"httpVersion": "HTTP/1.1",
"method": "GET",
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/app-builder/blueprint/00000000-0000-0000-0000-000000000001"
},
"response": {
"bodySize": 179,
"content": {
"mimeType": "application/vnd.api+json",
"size": 179,
"text": "{\"errors\":[{\"status\":\"404\",\"id\":\"75010b80-a44e-47bd-b903-e38f79efce20\",\"title\":\"blueprint not found\",\"detail\":\"blueprint with id 00000000-0000-0000-0000-000000000001 not found\"}]}"
},
"cookies": [],
"headers": [
{
"name": "content-type",
"value": "application/vnd.api+json"
}
],
"headersSize": 656,
"httpVersion": "HTTP/1.1",
"redirectURL": "",
"status": 404,
"statusText": "Not Found"
},
"startedDateTime": "2026-05-18T17:39:16.854Z",
"time": 692
}
],
"pages": [],
"version": "1.2"
}
}
1 change: 1 addition & 0 deletions ...der_216136899/Get-Blueprints-by-Integration-ID-returns-OK-response_1358691727/frozen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"2026-05-18T17:39:17.553Z"
57 changes: 57 additions & 0 deletions ...r_216136899/Get-Blueprints-by-Integration-ID-returns-OK-response_1358691727/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"log": {
"_recordingName": "App Builder/Get Blueprints by Integration ID returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
"version": "6.0.5"
},
"entries": [
{
"_id": "9e893e8506a54acb5d626f03f22f79a9",
"_order": 0,
"cache": {},
"request": {
"bodySize": 0,
"cookies": [],
"headers": [
{
"_fromType": "array",
"name": "accept",
"value": "application/json"
}
],
"headersSize": 550,
"httpVersion": "HTTP/1.1",
"method": "GET",
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/app-builder/blueprints/integration-id/aws"
},
"response": {
"bodySize": 11,
"content": {
"mimeType": "application/vnd.api+json",
"size": 11,
"text": "{\"data\":[]}"
},
"cookies": [],
"headers": [
{
"name": "content-type",
"value": "application/vnd.api+json"
}
],
"headersSize": 655,
"httpVersion": "HTTP/1.1",
"redirectURL": "",
"status": 200,
"statusText": "OK"
},
"startedDateTime": "2026-05-18T17:39:17.556Z",
"time": 514
}
],
"pages": [],
"version": "1.2"
}
}
1 change: 1 addition & 0 deletions .../App-Builder_216136899/Get-Blueprints-by-Slugs-returns-OK-response_1473250004/frozen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"2026-05-18T17:39:18.076Z"
57 changes: 57 additions & 0 deletions ...pp-Builder_216136899/Get-Blueprints-by-Slugs-returns-OK-response_1473250004/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"log": {
"_recordingName": "App Builder/Get Blueprints by Slugs returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
"version": "6.0.5"
},
"entries": [
{
"_id": "d58db21a252d04e00047c9427f7ef348",
"_order": 0,
"cache": {},
"request": {
"bodySize": 0,
"cookies": [],
"headers": [
{
"_fromType": "array",
"name": "accept",
"value": "application/json"
}
],
"headersSize": 549,
"httpVersion": "HTTP/1.1",
"method": "GET",
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/app-builder/blueprints/slugs/aws-service-manager"
},
"response": {
"bodySize": 11,
"content": {
"mimeType": "application/vnd.api+json",
"size": 11,
"text": "{\"data\":[]}"
},
"cookies": [],
"headers": [
{
"name": "content-type",
"value": "application/vnd.api+json"
}
],
"headersSize": 655,
"httpVersion": "HTTP/1.1",
"redirectURL": "",
"status": 200,
"statusText": "OK"
},
"startedDateTime": "2026-05-18T17:39:18.079Z",
"time": 692
}
],
"pages": [],
"version": "1.2"
}
}
1 change: 1 addition & 0 deletions cassettes/v2/App-Builder_216136899/List-Blueprints-returns-OK-response_195803873/frozen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"2026-05-18T17:39:19.135Z"
57 changes: 57 additions & 0 deletions ...ttes/v2/App-Builder_216136899/List-Blueprints-returns-OK-response_195803873/recording.har
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions cassettes/v2/App-Builder_216136899/List-Tags-returns-OK-response_704072488/frozen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"2026-05-18T17:39:19.668Z"
57 changes: 57 additions & 0 deletions cassettes/v2/App-Builder_216136899/List-Tags-returns-OK-response_704072488/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"log": {
"_recordingName": "App Builder/List Tags returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
"version": "6.0.5"
},
"entries": [
{
"_id": "90068ede3a13d0eceb7e543b27512f8e",
"_order": 0,
"cache": {},
"request": {
"bodySize": 0,
"cookies": [],
"headers": [
{
"_fromType": "array",
"name": "accept",
"value": "application/json"
}
],
"headersSize": 505,
"httpVersion": "HTTP/1.1",
"method": "GET",
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/app-builder/tags"
},
"response": {
"bodySize": 11,
"content": {
"mimeType": "application/vnd.api+json",
"size": 11,
"text": "{\"data\":[]}"
},
"cookies": [],
"headers": [
{
"name": "content-type",
"value": "application/vnd.api+json"
}
],
"headersSize": 655,
"httpVersion": "HTTP/1.1",
"redirectURL": "",
"status": 200,
"statusText": "OK"
},
"startedDateTime": "2026-05-18T17:39:19.672Z",
"time": 316
}
],
"pages": [],
"version": "1.2"
}
}
42 changes: 41 additions & 1 deletion features/v2/app_builder.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Feature: App Builder
When the request is sent
Then the response status is 400 Bad Request

@skip-typescript @team:DataDog/app-builder-backend
@skip @team:DataDog/app-builder-backend
Scenario: Get App returns "Gone" response
Given new "GetApp" request
And there is a valid "app" in the system
Expand All @@ -139,6 +139,34 @@ Feature: App Builder
And the response "data.id" has the same value as "app.data.id"
And the response "data.type" is equal to "appDefinitions"

@team:DataDog/app-builder-backend
Scenario: Get Blueprint returns "Not Found" response
Given new "GetBlueprint" request
And request contains "blueprint_id" parameter with value "00000000-0000-0000-0000-000000000001"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/app-builder-backend
Scenario: Get Blueprint returns "OK" response
Given new "GetBlueprint" request
And request contains "blueprint_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@team:DataDog/app-builder-backend
Scenario: Get Blueprints by Integration ID returns "OK" response
Given new "GetBlueprintsByIntegrationId" request
And request contains "integration_id" parameter with value "aws"
When the request is sent
Then the response status is 200 OK

@team:DataDog/app-builder-backend
Scenario: Get Blueprints by Slugs returns "OK" response
Given new "GetBlueprintsBySlugs" request
And request contains "slugs" parameter with value "aws-service-manager"
When the request is sent
Then the response status is 200 OK

@skip @team:DataDog/app-builder-backend
Scenario: List App Versions returns "Bad Request" response
Given new "ListAppVersions" request
Expand Down Expand Up @@ -173,6 +201,18 @@ Feature: App Builder
When the request is sent
Then the response status is 200 OK

@team:DataDog/app-builder-backend
Scenario: List Blueprints returns "OK" response
Given new "ListBlueprints" request
When the request is sent
Then the response status is 200 OK

@team:DataDog/app-builder-backend
Scenario: List Tags returns "OK" response
Given new "ListTags" request
When the request is sent
Then the response status is 200 OK

@skip @team:DataDog/app-builder-backend
Scenario: Name App Version returns "Bad Request" response
Given new "UpdateAppVersionName" request
Expand Down
30 changes: 30 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,36 @@
"type": "safe"
}
},
"GetBlueprint": {
"tag": "App Builder",
"undo": {
"type": "safe"
}
},
"ListBlueprints": {
"tag": "App Builder",
"undo": {
"type": "safe"
}
},
"GetBlueprintsByIntegrationId": {
"tag": "App Builder",
"undo": {
"type": "safe"
}
},
"GetBlueprintsBySlugs": {
"tag": "App Builder",
"undo": {
"type": "safe"
}
},
"ListTags": {
"tag": "App Builder",
"undo": {
"type": "safe"
}
},
"ListApplicationKeys": {
"tag": "Key Management",
"undo": {
Expand Down
35 changes: 35 additions & 0 deletions private/bdd_runner/src/support/scenarios_model_mapping.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4001,6 +4001,41 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "ListAppVersionsResponse",
},
"AppBuilderApi.V2.GetBlueprint": {
blueprintId: {
type: "string",
format: "uuid",
},
operationResponseType: "GetBlueprintResponse",
},
"AppBuilderApi.V2.ListBlueprints": {
limit: {
type: "number",
format: "int64",
},
page: {
type: "number",
format: "int64",
},
operationResponseType: "ListBlueprintsResponse",
},
"AppBuilderApi.V2.GetBlueprintsByIntegrationId": {
integrationId: {
type: "string",
format: "",
},
operationResponseType: "GetBlueprintsResponse",
},
"AppBuilderApi.V2.GetBlueprintsBySlugs": {
slugs: {
type: "string",
format: "",
},
operationResponseType: "GetBlueprintsResponse",
},
"AppBuilderApi.V2.ListTags": {
operationResponseType: "AppBuilderListTagsResponse",
},
"AuditApi.V2.ListAuditLogs": {
filterQuery: {
type: "string",
Expand Down
Loading
Loading