Skip to content

Add OpenAPI documentation for statuspage-subscriptions-api #3483

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Add OpenAPI documentation for statuspage-subscriptions-api #3483

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

Large diffs are not rendered by default.

69 changes: 69 additions & 0 deletions features/v2/status_pages.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,24 @@ Feature: Status Pages
And a valid "appKeyAuth" key in the system
And an instance of "StatusPages" API

@generated @skip @team:DataDog/incident-app
Scenario: Create an internal email subscription returns "Bad Request" response
Given operation "CreateInternalEmailSubscription" enabled
And new "CreateInternalEmailSubscription" request
And request contains "page_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"email_address": "test@example.com"}, "relationships": {"subscribed_components": {"data": [{"id": "00000000-0000-0000-0000-000000000000", "type": "status_page_components"}]}}, "type": "email_subscriptions"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/incident-app
Scenario: Create an internal email subscription returns "Created" response
Given operation "CreateInternalEmailSubscription" enabled
And new "CreateInternalEmailSubscription" request
And request contains "page_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"email_address": "test@example.com"}, "relationships": {"subscribed_components": {"data": [{"id": "00000000-0000-0000-0000-000000000000", "type": "status_page_components"}]}}, "type": "email_subscriptions"}}
When the request is sent
Then the response status is 201 Created

@team:DataDog/incident-app
Scenario: Create component returns "Created" response
Given there is a valid "status_page" in the system
Expand Down Expand Up @@ -91,6 +109,33 @@ Feature: Status Pages
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/incident-app
Scenario: Import email subscriptions returns "Bad Request" response
Given operation "ImportEmailSubscriptions" enabled
And new "ImportEmailSubscriptions" request
And request contains "page_id" parameter from "REPLACE.ME"
And body with value {"data": [{"attributes": {"email_address": "test@example.com"}, "relationships": {"subscribed_components": {"data": [{"id": "00000000-0000-0000-0000-000000000000", "type": "status_page_components"}]}}, "type": "email_subscriptions"}]}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/incident-app
Scenario: Import email subscriptions returns "Created" response
Given operation "ImportEmailSubscriptions" enabled
And new "ImportEmailSubscriptions" request
And request contains "page_id" parameter from "REPLACE.ME"
And body with value {"data": [{"attributes": {"email_address": "test@example.com"}, "relationships": {"subscribed_components": {"data": [{"id": "00000000-0000-0000-0000-000000000000", "type": "status_page_components"}]}}, "type": "email_subscriptions"}]}
When the request is sent
Then the response status is 201 Created

@generated @skip @team:DataDog/incident-app
Scenario: Import email subscriptions returns "No Content" response
Given operation "ImportEmailSubscriptions" enabled
And new "ImportEmailSubscriptions" request
And request contains "page_id" parameter from "REPLACE.ME"
And body with value {"data": [{"attributes": {"email_address": "test@example.com"}, "relationships": {"subscribed_components": {"data": [{"id": "00000000-0000-0000-0000-000000000000", "type": "status_page_components"}]}}, "type": "email_subscriptions"}]}
When the request is sent
Then the response status is 204 No Content

@team:DataDog/incident-app
Scenario: List components returns "OK" response
Given new "ListComponents" request
Expand All @@ -107,6 +152,30 @@ Feature: Status Pages
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/incident-app
Scenario: List email subscriptions returns "Bad Request" response
Given operation "ListEmailSubscriptions" enabled
And new "ListEmailSubscriptions" request
And request contains "page_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/incident-app
Scenario: List email subscriptions returns "Not Found" response
Given operation "ListEmailSubscriptions" enabled
And new "ListEmailSubscriptions" request
And request contains "page_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/incident-app
Scenario: List email subscriptions returns "OK" response
Given operation "ListEmailSubscriptions" enabled
And new "ListEmailSubscriptions" request
And request contains "page_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@team:DataDog/incident-app
Scenario: List status pages returns "OK" response
Given new "ListStatusPages" request
Expand Down
22 changes: 22 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5201,6 +5201,14 @@
"type": "safe"
}
},
"CreateInternalEmailSubscription": {
"tag": "Status Pages",
"undo": {
"operationId": "TODO",
"parameters": [],
"type": "unsafe"
}
},
"DeleteStatusPage": {
"tag": "Status Pages",
"undo": {
Expand Down Expand Up @@ -5295,6 +5303,20 @@
"type": "idempotent"
}
},
"ListEmailSubscriptions": {
"tag": "Status Pages",
"undo": {
"type": "safe"
}
},
"ImportEmailSubscriptions": {
"tag": "Status Pages",
"undo": {
"operationId": "TODO",
"parameters": [],
"type": "unsafe"
}
},
"GetOnDemandConcurrencyCap": {
"tag": "Synthetics",
"undo": {
Expand Down
45 changes: 45 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 @@ -10135,6 +10135,17 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "DegradationArray",
},
"StatusPagesApi.V2.CreateInternalEmailSubscription": {
pageId: {
type: "string",
format: "uuid",
},
body: {
type: "StatusPageEmailSubscriptionRequest",
format: "",
},
operationResponseType: "StatusPageEmailSubscriptionResponse",
},
"StatusPagesApi.V2.GetStatusPage": {
pageId: {
type: "string",
Expand Down Expand Up @@ -10311,6 +10322,40 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "Degradation",
},
"StatusPagesApi.V2.ListEmailSubscriptions": {
pageId: {
type: "string",
format: "uuid",
},
filterStatus: {
type: "StatusPageEmailSubscriptionStatus",
format: "",
},
pageOffset: {
type: "number",
format: "int64",
},
pageLimit: {
type: "number",
format: "int64",
},
sort: {
type: "string",
format: "",
},
operationResponseType: "StatusPageEmailSubscriptionsResponse",
},
"StatusPagesApi.V2.ImportEmailSubscriptions": {
pageId: {
type: "string",
format: "uuid",
},
body: {
type: "StatusPageEmailSubscriptionsRequest",
format: "",
},
operationResponseType: "StatusPageEmailSubscriptionsResponse",
},
"SyntheticsApi.V2.GetOnDemandConcurrencyCap": {
operationResponseType: "OnDemandConcurrencyCapResponse",
},
Expand Down
Loading
Loading