Skip to content

Commit a099486

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
chore(spec): add missing descriptions to OpenAPI schemas and properties [all] (#3137)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent a12a37c commit a099486

447 files changed

Lines changed: 2395 additions & 1239 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.generator/schemas/v2/openapi.yaml

Lines changed: 1220 additions & 64 deletions
Large diffs are not rendered by default.

lib/datadog_api_client/v2/api/case_management_api.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ def create_project(body, opts = {})
552552
#
553553
# Create a project.
554554
#
555-
# @param body [ProjectCreateRequest] Project payload
555+
# @param body [ProjectCreateRequest] Project payload.
556556
# @param opts [Hash] the optional parameters
557557
# @return [Array<(ProjectResponse, Integer, Hash)>] ProjectResponse data, response status code and response headers
558558
def create_project_with_http_info(body, opts = {})
@@ -831,7 +831,7 @@ def delete_project(project_id, opts = {})
831831
#
832832
# Remove a project using the project's `id`.
833833
#
834-
# @param project_id [String] Project UUID
834+
# @param project_id [String] Project UUID.
835835
# @param opts [Hash] the optional parameters
836836
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
837837
def delete_project_with_http_info(project_id, opts = {})
@@ -1031,7 +1031,7 @@ def get_project(project_id, opts = {})
10311031
#
10321032
# Get the details of a project by `project_id`.
10331033
#
1034-
# @param project_id [String] Project UUID
1034+
# @param project_id [String] Project UUID.
10351035
# @param opts [Hash] the optional parameters
10361036
# @return [Array<(ProjectResponse, Integer, Hash)>] ProjectResponse data, response status code and response headers
10371037
def get_project_with_http_info(project_id, opts = {})
@@ -2131,8 +2131,8 @@ def update_project(project_id, body, opts = {})
21312131
#
21322132
# Update a project.
21332133
#
2134-
# @param project_id [String] Project UUID
2135-
# @param body [ProjectUpdateRequest] Project payload
2134+
# @param project_id [String] Project UUID.
2135+
# @param body [ProjectUpdateRequest] Project payload.
21362136
# @param opts [Hash] the optional parameters
21372137
# @return [Array<(ProjectResponse, Integer, Hash)>] ProjectResponse data, response status code and response headers
21382138
def update_project_with_http_info(project_id, body, opts = {})

lib/datadog_api_client/v2/models/any_value_item.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# A single item in an array of arbitrary values, which can be a string, number, object, or boolean.
2121
module AnyValueItem
2222
class << self
2323
include BaseOneOfModel

lib/datadog_api_client/v2/models/argument.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# A named argument for a custom static analysis rule.
2121
class Argument
2222
include BaseGenericModel
2323

lib/datadog_api_client/v2/models/assign_seats_user_request.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# The request body for assigning seats to users for a product code.
2121
class AssignSeatsUserRequest
2222
include BaseGenericModel
2323

24-
#
24+
# The request data object containing attributes for assigning seats to users.
2525
attr_accessor :data
2626

2727
attr_accessor :additional_properties

lib/datadog_api_client/v2/models/assign_seats_user_request_data.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# The request data object containing attributes for assigning seats to users.
2121
class AssignSeatsUserRequestData
2222
include BaseGenericModel
2323

24-
#
24+
# Attributes specifying the product and users to whom seats will be assigned.
2525
attr_reader :attributes
2626

2727
# The ID of the assign seats user request.

lib/datadog_api_client/v2/models/assign_seats_user_request_data_attributes.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# Attributes specifying the product and users to whom seats will be assigned.
2121
class AssignSeatsUserRequestDataAttributes
2222
include BaseGenericModel
2323

lib/datadog_api_client/v2/models/assign_seats_user_response.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# The response body returned after successfully assigning seats to users.
2121
class AssignSeatsUserResponse
2222
include BaseGenericModel
2323

24-
#
24+
# The response data object containing attributes of the seat assignment result.
2525
attr_accessor :data
2626

2727
attr_accessor :additional_properties

lib/datadog_api_client/v2/models/assign_seats_user_response_data.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# The response data object containing attributes of the seat assignment result.
2121
class AssignSeatsUserResponseData
2222
include BaseGenericModel
2323

24-
#
24+
# Attributes of the assign seats response, including the list of users assigned and the product code.
2525
attr_accessor :attributes
2626

2727
# The ID of the assign seats user response.

lib/datadog_api_client/v2/models/assign_seats_user_response_data_attributes.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
#
20+
# Attributes of the assign seats response, including the list of users assigned and the product code.
2121
class AssignSeatsUserResponseDataAttributes
2222
include BaseGenericModel
2323

0 commit comments

Comments
 (0)