chore(spec): add missing descriptions to OpenAPI schemas and properties [all] (#3636)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -1194,7 +1194,7 @@ public CompletableFuture<ApiResponse<Void>> createCaseServiceNowTicketWithHttpIn
    *
    * <p>See {@link #createProjectWithHttpInfo}.
    *
-   * @param body Project payload (required)
+   * @param body Project payload. (required)
    * @return ProjectResponse
    * @throws ApiException if fails to make API call
    */
@@ -1207,7 +1207,7 @@ public ProjectResponse createProject(ProjectCreateRequest body) throws ApiExcept
    *
    * <p>See {@link #createProjectWithHttpInfoAsync}.
    *
-   * @param body Project payload (required)
+   * @param body Project payload. (required)
    * @return CompletableFuture&lt;ProjectResponse&gt;
    */
   public CompletableFuture<ProjectResponse> createProjectAsync(ProjectCreateRequest body) {
@@ -1221,7 +1221,7 @@ public CompletableFuture<ProjectResponse> createProjectAsync(ProjectCreateReques
   /**
    * Create a project.
    *
-   * @param body Project payload (required)
+   * @param body Project payload. (required)
    * @return ApiResponse&lt;ProjectResponse&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -1275,7 +1275,7 @@ public ApiResponse<ProjectResponse> createProjectWithHttpInfo(ProjectCreateReque
    *
    * <p>See {@link #createProjectWithHttpInfo}.
    *
-   * @param body Project payload (required)
+   * @param body Project payload. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;ProjectResponse&gt;&gt;
    */
   public CompletableFuture<ApiResponse<ProjectResponse>> createProjectWithHttpInfoAsync(
@@ -1818,7 +1818,7 @@ public CompletableFuture<ApiResponse<CaseResponse>> deleteCaseCustomAttributeWit
    *
    * <p>See {@link #deleteProjectWithHttpInfo}.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @throws ApiException if fails to make API call
    */
   public void deleteProject(String projectId) throws ApiException {
@@ -1830,7 +1830,7 @@ public void deleteProject(String projectId) throws ApiException {
    *
    * <p>See {@link #deleteProjectWithHttpInfoAsync}.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return CompletableFuture
    */
   public CompletableFuture<Void> deleteProjectAsync(String projectId) {
@@ -1844,7 +1844,7 @@ public CompletableFuture<Void> deleteProjectAsync(String projectId) {
   /**
    * Remove a project using the project's <code>id</code>.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return ApiResponse&lt;Void&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -1897,7 +1897,7 @@ public ApiResponse<Void> deleteProjectWithHttpInfo(String projectId) throws ApiE
    *
    * <p>See {@link #deleteProjectWithHttpInfo}.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;Void&gt;&gt;
    */
   public CompletableFuture<ApiResponse<Void>> deleteProjectWithHttpInfoAsync(String projectId) {
@@ -2251,7 +2251,7 @@ public CompletableFuture<ApiResponse<CaseResponse>> getCaseWithHttpInfoAsync(Str
    *
    * <p>See {@link #getProjectWithHttpInfo}.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return ProjectResponse
    * @throws ApiException if fails to make API call
    */
@@ -2264,7 +2264,7 @@ public ProjectResponse getProject(String projectId) throws ApiException {
    *
    * <p>See {@link #getProjectWithHttpInfoAsync}.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return CompletableFuture&lt;ProjectResponse&gt;
    */
   public CompletableFuture<ProjectResponse> getProjectAsync(String projectId) {
@@ -2278,7 +2278,7 @@ public CompletableFuture<ProjectResponse> getProjectAsync(String projectId) {
   /**
    * Get the details of a project by <code>project_id</code>.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return ApiResponse&lt;ProjectResponse&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -2333,7 +2333,7 @@ public ApiResponse<ProjectResponse> getProjectWithHttpInfo(String projectId) thr
    *
    * <p>See {@link #getProjectWithHttpInfo}.
    *
-   * @param projectId Project UUID (required)
+   * @param projectId Project UUID. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;ProjectResponse&gt;&gt;
    */
   public CompletableFuture<ApiResponse<ProjectResponse>> getProjectWithHttpInfoAsync(
@@ -4738,8 +4738,8 @@ public CompletableFuture<ApiResponse<CaseResponse>> updatePriorityWithHttpInfoAs
    *
    * <p>See {@link #updateProjectWithHttpInfo}.
    *
-   * @param projectId Project UUID (required)
-   * @param body Project payload (required)
+   * @param projectId Project UUID. (required)
+   * @param body Project payload. (required)
    * @return ProjectResponse
    * @throws ApiException if fails to make API call
    */
@@ -4753,8 +4753,8 @@ public ProjectResponse updateProject(String projectId, ProjectUpdateRequest body
    *
    * <p>See {@link #updateProjectWithHttpInfoAsync}.
    *
-   * @param projectId Project UUID (required)
-   * @param body Project payload (required)
+   * @param projectId Project UUID. (required)
+   * @param body Project payload. (required)
    * @return CompletableFuture&lt;ProjectResponse&gt;
    */
   public CompletableFuture<ProjectResponse> updateProjectAsync(
@@ -4769,8 +4769,8 @@ public CompletableFuture<ProjectResponse> updateProjectAsync(
   /**
    * Update a project.
    *
-   * @param projectId Project UUID (required)
-   * @param body Project payload (required)
+   * @param projectId Project UUID. (required)
+   * @param body Project payload. (required)
    * @return ApiResponse&lt;ProjectResponse&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -4832,8 +4832,8 @@ public ApiResponse<ProjectResponse> updateProjectWithHttpInfo(
    *
    * <p>See {@link #updateProjectWithHttpInfo}.
    *
-   * @param projectId Project UUID (required)
-   * @param body Project payload (required)
+   * @param projectId Project UUID. (required)
+   * @param body Project payload. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;ProjectResponse&gt;&gt;
    */
   public CompletableFuture<ApiResponse<ProjectResponse>> updateProjectWithHttpInfoAsync(

src/main/java/com/datadog/api/client/v2/api/CaseManagementApi.java

@@ -17,7 +17,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/** A named argument for a custom static analysis rule. */
 @JsonPropertyOrder({Argument.JSON_PROPERTY_DESCRIPTION, Argument.JSON_PROPERTY_NAME})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")

src/main/java/com/datadog/api/client/v2/model/Argument.java

@@ -16,7 +16,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/** The request body for assigning seats to users for a product code. */
 @JsonPropertyOrder({AssignSeatsUserRequest.JSON_PROPERTY_DATA})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,7 +32,7 @@ public AssignSeatsUserRequest data(AssignSeatsUserRequestData data) {
   }
 
   /**
-   * Getdata
+   * The request data object containing attributes for assigning seats to users.
    *
    * @return data
    */

src/main/java/com/datadog/api/client/v2/model/AssignSeatsUserRequest.java

@@ -17,7 +17,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/** The request data object containing attributes for assigning seats to users. */
 @JsonPropertyOrder({
   AssignSeatsUserRequestData.JSON_PROPERTY_ATTRIBUTES,
   AssignSeatsUserRequestData.JSON_PROPERTY_ID,
@@ -56,7 +56,7 @@ public AssignSeatsUserRequestData attributes(AssignSeatsUserRequestDataAttribute
   }
 
   /**
-   * Getattributes
+   * Attributes specifying the product and users to whom seats will be assigned.
    *
    * @return attributes
    */

src/main/java/com/datadog/api/client/v2/model/AssignSeatsUserRequestData.java

@@ -19,7 +19,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/** Attributes specifying the product and users to whom seats will be assigned. */
 @JsonPropertyOrder({
   AssignSeatsUserRequestDataAttributes.JSON_PROPERTY_PRODUCT_CODE,
   AssignSeatsUserRequestDataAttributes.JSON_PROPERTY_USER_UUIDS

src/main/java/com/datadog/api/client/v2/model/AssignSeatsUserRequestDataAttributes.java

@@ -16,7 +16,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/** The response body returned after successfully assigning seats to users. */
 @JsonPropertyOrder({AssignSeatsUserResponse.JSON_PROPERTY_DATA})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,7 +32,7 @@ public AssignSeatsUserResponse data(AssignSeatsUserResponseData data) {
   }
 
   /**
-   * Getdata
+   * The response data object containing attributes of the seat assignment result.
    *
    * @return data
    */

src/main/java/com/datadog/api/client/v2/model/AssignSeatsUserResponse.java

@@ -16,7 +16,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/** The response data object containing attributes of the seat assignment result. */
 @JsonPropertyOrder({
   AssignSeatsUserResponseData.JSON_PROPERTY_ATTRIBUTES,
   AssignSeatsUserResponseData.JSON_PROPERTY_ID,
@@ -42,7 +42,8 @@ public AssignSeatsUserResponseData attributes(AssignSeatsUserResponseDataAttribu
   }
 
   /**
-   * Getattributes
+   * Attributes of the assign seats response, including the list of users assigned and the product
+   * code.
    *
    * @return attributes
    */

src/main/java/com/datadog/api/client/v2/model/AssignSeatsUserResponseData.java

@@ -18,7 +18,10 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** */
+/**
+ * Attributes of the assign seats response, including the list of users assigned and the product
+ * code.
+ */
 @JsonPropertyOrder({
   AssignSeatsUserResponseDataAttributes.JSON_PROPERTY_ASSIGNED_IDS,
   AssignSeatsUserResponseDataAttributes.JSON_PROPERTY_PRODUCT_CODE

src/main/java/com/datadog/api/client/v2/model/AssignSeatsUserResponseDataAttributes.java

@@ -70,7 +70,7 @@ public Attachment addIncludedItem(AttachmentIncluded includedItem) {
   }
 
   /**
-   * Getincluded
+   * A list of related objects included in the response.
    *
    * @return included
    */