Skip to content

Update Status Pages UpdateStatusPage documentation to reflect enabled attribute deprecation #4171

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: master
Choose a base branch
from
Open

Update Status Pages UpdateStatusPage documentation to reflect enabled attribute deprecation #4171

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
12 changes: 2 additions & 10 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25803,9 +25803,6 @@ components:
description: Base64-encoded image data included in email notifications sent to status page subscribers.
example: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF
type: string
enabled:
description: Whether the status page is enabled.
type: boolean
favicon:
description: Base64-encoded image data displayed in the browser tab.
example: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA
Expand Down Expand Up @@ -80613,10 +80610,6 @@ components:
description: The base64-encoded image data displayed in email notifications sent to status page subscribers.
example: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF
type: string
enabled:
description: Whether the status page is enabled.
example: true
type: boolean
favicon:
description: The base64-encoded image data displayed in the browser tab.
example: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA
Expand Down Expand Up @@ -201873,7 +201866,7 @@ paths:
attributes:
components: []
domain_prefix: status-page-us1
enabled: true
enabled: false
name: Status Page US1
subscriptions_enabled: true
type: public
Expand Down Expand Up @@ -202134,7 +202127,7 @@ paths:
permissions:
- status_pages_settings_read
patch:
description: "Updates an existing status page's attributes. **Note**: Publishing and unpublishing via the `enabled` property will be deprecated on this endpoint. Use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints instead."
description: "Updates an existing status page's attributes."
operationId: UpdateStatusPage
parameters:
- description: Whether to delete existing subscribers when updating a status page's type.
Expand Down Expand Up @@ -202167,7 +202160,6 @@ paths:
company_logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM
domain_prefix: status-page-us1-east
email_header_image: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF
enabled: false
favicon: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA
name: Status Page US1 East
subscriptions_enabled: false
Expand Down
5 changes: 1 addition & 4 deletions src/main/java/com/datadog/api/client/v2/api/StatusPagesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7675,10 +7675,7 @@ public CompletableFuture<StatusPage> updateStatusPageAsync(
}

/**
* Updates an existing status page's attributes. <strong>Note</strong>: Publishing and
* unpublishing via the <code>enabled</code> property will be deprecated on this endpoint. Use the
* dedicated <a href="#publish-status-page">publish</a> and <a
* href="#unpublish-status-page">unpublish</a> status page endpoints instead.
* Updates an existing status page's attributes.
*
* @param pageId The ID of the status page. (required)
* @param body (required)
Expand Down
28 changes: 0 additions & 28 deletions src/main/java/com/datadog/api/client/v2/model/CreateStatusPageRequestDataAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_COMPONENTS,
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_DOMAIN_PREFIX,
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_EMAIL_HEADER_IMAGE,
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_ENABLED,
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_FAVICON,
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_NAME,
CreateStatusPageRequestDataAttributes.JSON_PROPERTY_SLACK_APP_ICON,
Expand All @@ -50,9 +49,6 @@ public class CreateStatusPageRequestDataAttributes {
public static final String JSON_PROPERTY_EMAIL_HEADER_IMAGE = "email_header_image";
private String emailHeaderImage;

public static final String JSON_PROPERTY_ENABLED = "enabled";
private Boolean enabled;

public static final String JSON_PROPERTY_FAVICON = "favicon";
private String favicon;

Expand Down Expand Up @@ -199,27 +195,6 @@ public void setEmailHeaderImage(String emailHeaderImage) {
this.emailHeaderImage = emailHeaderImage;
}

public CreateStatusPageRequestDataAttributes enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}

/**
* Whether the status page is enabled.
*
* @return enabled
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ENABLED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getEnabled() {
return enabled;
}

public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}

public CreateStatusPageRequestDataAttributes favicon(String favicon) {
this.favicon = favicon;
return this;
Expand Down Expand Up @@ -438,7 +413,6 @@ public boolean equals(Object o) {
&& Objects.equals(this.domainPrefix, createStatusPageRequestDataAttributes.domainPrefix)
&& Objects.equals(
this.emailHeaderImage, createStatusPageRequestDataAttributes.emailHeaderImage)
&& Objects.equals(this.enabled, createStatusPageRequestDataAttributes.enabled)
&& Objects.equals(this.favicon, createStatusPageRequestDataAttributes.favicon)
&& Objects.equals(this.name, createStatusPageRequestDataAttributes.name)
&& Objects.equals(this.slackAppIcon, createStatusPageRequestDataAttributes.slackAppIcon)
Expand All @@ -461,7 +435,6 @@ public int hashCode() {
components,
domainPrefix,
emailHeaderImage,
enabled,
favicon,
name,
slackAppIcon,
Expand All @@ -480,7 +453,6 @@ public String toString() {
sb.append(" components: ").append(toIndentedString(components)).append("\n");
sb.append(" domainPrefix: ").append(toIndentedString(domainPrefix)).append("\n");
sb.append(" emailHeaderImage: ").append(toIndentedString(emailHeaderImage)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" favicon: ").append(toIndentedString(favicon)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" slackAppIcon: ").append(toIndentedString(slackAppIcon)).append("\n");
Expand Down
28 changes: 0 additions & 28 deletions src/main/java/com/datadog/api/client/v2/model/PatchStatusPageRequestDataAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_COMPANY_LOGO,
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_DOMAIN_PREFIX,
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_EMAIL_HEADER_IMAGE,
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_ENABLED,
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_FAVICON,
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_NAME,
PatchStatusPageRequestDataAttributes.JSON_PROPERTY_SLACK_APP_ICON,
Expand All @@ -43,9 +42,6 @@ public class PatchStatusPageRequestDataAttributes {
public static final String JSON_PROPERTY_EMAIL_HEADER_IMAGE = "email_header_image";
private String emailHeaderImage;

public static final String JSON_PROPERTY_ENABLED = "enabled";
private Boolean enabled;

public static final String JSON_PROPERTY_FAVICON = "favicon";
private String favicon;

Expand Down Expand Up @@ -133,27 +129,6 @@ public void setEmailHeaderImage(String emailHeaderImage) {
this.emailHeaderImage = emailHeaderImage;
}

public PatchStatusPageRequestDataAttributes enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}

/**
* Whether the status page is enabled.
*
* @return enabled
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ENABLED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getEnabled() {
return enabled;
}

public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}

public PatchStatusPageRequestDataAttributes favicon(String favicon) {
this.favicon = favicon;
return this;
Expand Down Expand Up @@ -373,7 +348,6 @@ public boolean equals(Object o) {
&& Objects.equals(this.domainPrefix, patchStatusPageRequestDataAttributes.domainPrefix)
&& Objects.equals(
this.emailHeaderImage, patchStatusPageRequestDataAttributes.emailHeaderImage)
&& Objects.equals(this.enabled, patchStatusPageRequestDataAttributes.enabled)
&& Objects.equals(this.favicon, patchStatusPageRequestDataAttributes.favicon)
&& Objects.equals(this.name, patchStatusPageRequestDataAttributes.name)
&& Objects.equals(this.slackAppIcon, patchStatusPageRequestDataAttributes.slackAppIcon)
Expand All @@ -395,7 +369,6 @@ public int hashCode() {
companyLogo,
domainPrefix,
emailHeaderImage,
enabled,
favicon,
name,
slackAppIcon,
Expand All @@ -413,7 +386,6 @@ public String toString() {
sb.append(" companyLogo: ").append(toIndentedString(companyLogo)).append("\n");
sb.append(" domainPrefix: ").append(toIndentedString(domainPrefix)).append("\n");
sb.append(" emailHeaderImage: ").append(toIndentedString(emailHeaderImage)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" favicon: ").append(toIndentedString(favicon)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" slackAppIcon: ").append(toIndentedString(slackAppIcon)).append("\n");
Expand Down
Loading