Skip to content

chore(spec): add missing descriptions [session-replay-backend] #3595

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

chore(spec): add missing descriptions [session-replay-backend] #3595

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

Large diffs are not rendered by default.

90 changes: 0 additions & 90 deletions examples/v2/observability-pipelines/ValidatePipeline_884022323.java
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineOpentelemetrySource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* The <code>opentelemetry</code> source receives telemetry data using the OpenTelemetry Protocol
* (OTLP) over gRPC and HTTP.
*
* <p><strong>Supported pipeline types:</strong> logs, metrics
* <p><strong>Supported pipeline types:</strong> logs
*/
@JsonPropertyOrder({
ObservabilityPipelineOpentelemetrySource.JSON_PROPERTY_GRPC_ADDRESS_KEY,
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/Playlist.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.util.Map;
import java.util.Objects;

/** */
/** A single RUM replay playlist resource returned by create, update, or get operations. */
@JsonPropertyOrder({Playlist.JSON_PROPERTY_DATA})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
Expand All @@ -41,7 +41,7 @@ public Playlist data(PlaylistData data) {
}

/**
* Getdata
* Data object representing a RUM replay playlist, including its identifier, type, and attributes.
*
* @return data
*/
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistArray.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import java.util.Map;
import java.util.Objects;

/** */
/** A list of RUM replay playlists returned by a list operation. */
@JsonPropertyOrder({PlaylistArray.JSON_PROPERTY_DATA})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
Expand Down Expand Up @@ -51,7 +51,7 @@ public PlaylistArray addDataItem(PlaylistData dataItem) {
}

/**
* Getdata
* Array of playlist data objects.
*
* @return data
*/
Expand Down
9 changes: 6 additions & 3 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
import java.util.Map;
import java.util.Objects;

/** */
/**
* Data object representing a RUM replay playlist, including its identifier, type, and attributes.
*/
@JsonPropertyOrder({
PlaylistData.JSON_PROPERTY_ATTRIBUTES,
PlaylistData.JSON_PROPERTY_ID,
Expand Down Expand Up @@ -52,7 +54,8 @@ public PlaylistData attributes(PlaylistDataAttributes attributes) {
}

/**
* Getattributes
* Attributes of a RUM replay playlist, including its name, description, session count, and audit
* timestamps.
*
* @return attributes
*/
Expand All @@ -73,7 +76,7 @@ public PlaylistData id(String id) {
}

/**
* Getid
* Unique identifier of the playlist.
*
* @return id
*/
Expand Down
17 changes: 10 additions & 7 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistDataAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
import java.util.Map;
import java.util.Objects;

/** */
/**
* Attributes of a RUM replay playlist, including its name, description, session count, and audit
* timestamps.
*/
@JsonPropertyOrder({
PlaylistDataAttributes.JSON_PROPERTY_CREATED_AT,
PlaylistDataAttributes.JSON_PROPERTY_CREATED_BY,
Expand Down Expand Up @@ -63,7 +66,7 @@ public PlaylistDataAttributes createdAt(OffsetDateTime createdAt) {
}

/**
* GetcreatedAt
* Timestamp when the playlist was created.
*
* @return createdAt
*/
Expand All @@ -85,7 +88,7 @@ public PlaylistDataAttributes createdBy(PlaylistDataAttributesCreatedBy createdB
}

/**
* GetcreatedBy
* Information about the user who created the playlist.
*
* @return createdBy
*/
Expand All @@ -106,7 +109,7 @@ public PlaylistDataAttributes description(String description) {
}

/**
* Getdescription
* Optional human-readable description of the playlist's purpose or contents.
*
* @return description
*/
Expand All @@ -127,7 +130,7 @@ public PlaylistDataAttributes name(String name) {
}

/**
* Getname
* Human-readable name of the playlist.
*
* @return name
*/
Expand All @@ -147,7 +150,7 @@ public PlaylistDataAttributes sessionCount(Long sessionCount) {
}

/**
* GetsessionCount
* Number of replay sessions currently in the playlist.
*
* @return sessionCount
*/
Expand All @@ -168,7 +171,7 @@ public PlaylistDataAttributes updatedAt(OffsetDateTime updatedAt) {
}

/**
* GetupdatedAt
* Timestamp when the playlist was last updated.
*
* @return updatedAt
*/
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistDataAttributesCreatedBy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.util.Map;
import java.util.Objects;

/** */
/** Information about the user who created the playlist. */
@JsonPropertyOrder({
PlaylistDataAttributesCreatedBy.JSON_PROPERTY_HANDLE,
PlaylistDataAttributesCreatedBy.JSON_PROPERTY_ICON,
Expand Down Expand Up @@ -62,7 +62,7 @@ public PlaylistDataAttributesCreatedBy handle(String handle) {
}

/**
* Gethandle
* Email handle of the user who created the playlist.
*
* @return handle
*/
Expand All @@ -82,7 +82,7 @@ public PlaylistDataAttributesCreatedBy icon(String icon) {
}

/**
* Geticon
* URL or identifier of the user's avatar icon.
*
* @return icon
*/
Expand All @@ -103,7 +103,7 @@ public PlaylistDataAttributesCreatedBy id(String id) {
}

/**
* Getid
* Unique identifier of the user who created the playlist.
*
* @return id
*/
Expand All @@ -123,7 +123,7 @@ public PlaylistDataAttributesCreatedBy name(String name) {
}

/**
* Getname
* Display name of the user who created the playlist.
*
* @return name
*/
Expand All @@ -144,7 +144,7 @@ public PlaylistDataAttributesCreatedBy uuid(String uuid) {
}

/**
* Getuuid
* UUID of the user who created the playlist.
*
* @return uuid
*/
Expand Down
5 changes: 3 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistsSession.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.util.Map;
import java.util.Objects;

/** */
/** A single RUM replay session resource as it appears within a playlist context. */
@JsonPropertyOrder({PlaylistsSession.JSON_PROPERTY_DATA})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
Expand All @@ -42,7 +42,8 @@ public PlaylistsSession data(PlaylistsSessionData data) {
}

/**
* Getdata
* Data object representing a session within a playlist, including its identifier, type, and
* attributes.
*
* @return data
*/
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistsSessionArray.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import java.util.Map;
import java.util.Objects;

/** */
/** A list of RUM replay sessions belonging to a playlist. */
@JsonPropertyOrder({PlaylistsSessionArray.JSON_PROPERTY_DATA})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
Expand Down Expand Up @@ -51,7 +51,7 @@ public PlaylistsSessionArray addDataItem(PlaylistsSessionData dataItem) {
}

/**
* Getdata
* Array of playlist session data objects.
*
* @return data
*/
Expand Down
10 changes: 7 additions & 3 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistsSessionData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@
import java.util.Map;
import java.util.Objects;

/** */
/**
* Data object representing a session within a playlist, including its identifier, type, and
* attributes.
*/
@JsonPropertyOrder({
PlaylistsSessionData.JSON_PROPERTY_ATTRIBUTES,
PlaylistsSessionData.JSON_PROPERTY_ID,
Expand Down Expand Up @@ -54,7 +57,8 @@ public PlaylistsSessionData attributes(PlaylistsSessionDataAttributes attributes
}

/**
* Getattributes
* Attributes of a session within a playlist, including the session event data and its replay
* track.
*
* @return attributes
*/
Expand All @@ -75,7 +79,7 @@ public PlaylistsSessionData id(String id) {
}

/**
* Getid
* Unique identifier of the RUM replay session.
*
* @return id
*/
Expand Down
8 changes: 5 additions & 3 deletions src/main/java/com/datadog/api/client/v2/model/PlaylistsSessionDataAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
import java.util.Map;
import java.util.Objects;

/** */
/**
* Attributes of a session within a playlist, including the session event data and its replay track.
*/
@JsonPropertyOrder({
PlaylistsSessionDataAttributes.JSON_PROPERTY_SESSION_EVENT,
PlaylistsSessionDataAttributes.JSON_PROPERTY_TRACK
Expand Down Expand Up @@ -45,7 +47,7 @@ public PlaylistsSessionDataAttributes putSessionEventItem(String key, Object ses
}

/**
* GetsessionEvent
* Raw event data associated with the replay session.
*
* @return sessionEvent
*/
Expand All @@ -66,7 +68,7 @@ public PlaylistsSessionDataAttributes track(String track) {
}

/**
* Gettrack
* Replay track identifier indicating which recording track the session belongs to.
*
* @return track
*/
Expand Down
Loading
Loading