From 64f788ff7197179091d7a2cc0c2ec04056683306 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Mon, 23 Mar 2026 15:23:13 +0000 Subject: [PATCH] Regenerate client from commit 769ea16 of spec repo --- .generator/schemas/v2/openapi.yaml | 1284 ++++++++++++++++- .../v2/api/case_management_api.py | 10 +- .../v2/model/any_value_item.py | 4 +- .../v2/model/any_value_object.py | 4 +- src/datadog_api_client/v2/model/argument.py | 2 +- .../v2/model/assign_seats_user_request.py | 4 +- .../model/assign_seats_user_request_data.py | 4 +- ...sign_seats_user_request_data_attributes.py | 2 +- .../v2/model/assign_seats_user_response.py | 4 +- .../model/assign_seats_user_response_data.py | 4 +- ...ign_seats_user_response_data_attributes.py | 2 +- src/datadog_api_client/v2/model/attachment.py | 2 +- .../v2/model/attachment_array.py | 4 +- .../v2/model/auto_close_inactive_cases.py | 6 +- .../model/auto_transition_assigned_cases.py | 4 +- .../model/batch_delete_rows_request_array.py | 2 +- .../model/batch_upsert_rows_request_array.py | 2 +- .../model/batch_upsert_rows_request_data.py | 2 +- .../v2/model/budget_attributes.py | 2 +- .../v2/model/budget_validation_request.py | 4 +- .../model/budget_validation_request_data.py | 6 +- .../v2/model/budget_validation_response.py | 4 +- .../model/budget_validation_response_data.py | 6 +- ...get_validation_response_data_attributes.py | 6 +- .../budget_with_entries_data_attributes.py | 24 +- ...h_entries_data_attributes_entries_items.py | 8 +- ...ributes_entries_items_tag_filters_items.py | 6 +- .../v2/model/case_create_relationships.py | 2 +- .../v2/model/case_management_project.py | 2 +- .../v2/model/case_management_project_data.py | 2 +- .../v2/model/case_relationships.py | 2 +- .../model/create_attachment_request_data.py | 2 +- .../v2/model/create_case_request_array.py | 2 +- .../v2/model/create_component_request.py | 4 +- .../v2/model/create_component_request_data.py | 2 +- ...equest_data_attributes_components_items.py | 2 +- ...te_component_request_data_relationships.py | 2 +- ...ponent_request_data_relationships_group.py | 4 +- ...t_request_data_relationships_group_data.py | 2 +- .../v2/model/create_connection_request.py | 4 +- .../model/create_connection_request_data.py | 6 +- ...eate_connection_request_data_attributes.py | 12 +- ...on_request_data_attributes_fields_items.py | 14 +- .../v2/model/create_degradation_request.py | 4 +- .../model/create_degradation_request_data.py | 2 +- ...ta_attributes_components_affected_items.py | 4 +- .../model/create_jira_issue_request_array.py | 2 +- .../v2/model/create_maintenance_request.py | 4 +- .../model/create_maintenance_request_data.py | 2 +- ...ta_attributes_components_affected_items.py | 2 +- .../v2/model/create_status_page_request.py | 4 +- .../model/create_status_page_request_data.py | 2 +- ...equest_data_attributes_components_items.py | 2 +- ...butes_components_items_components_items.py | 2 +- .../v2/model/create_tenancy_config_data.py | 6 +- .../create_tenancy_config_data_attributes.py | 24 +- ...config_data_attributes_auth_credentials.py | 6 +- ...ancy_config_data_attributes_logs_config.py | 8 +- ...y_config_data_attributes_metrics_config.py | 8 +- ...y_config_data_attributes_regions_config.py | 8 +- .../v2/model/create_tenancy_config_request.py | 4 +- .../v2/model/custom_rule.py | 4 +- .../v2/model/custom_rule_request.py | 4 +- .../v2/model/custom_rule_request_data.py | 4 +- .../custom_rule_request_data_attributes.py | 2 +- .../v2/model/custom_rule_response.py | 4 +- .../v2/model/custom_rule_response_data.py | 4 +- .../v2/model/custom_rule_revision.py | 4 +- .../model/custom_rule_revision_attributes.py | 2 +- .../custom_rule_revision_input_attributes.py | 2 +- .../v2/model/custom_rule_revision_request.py | 4 +- .../custom_rule_revision_request_data.py | 4 +- .../v2/model/custom_rule_revision_response.py | 4 +- .../v2/model/custom_rule_revision_test.py | 2 +- .../model/custom_rule_revisions_response.py | 4 +- .../v2/model/custom_ruleset.py | 4 +- .../v2/model/custom_ruleset_attributes.py | 2 +- .../v2/model/custom_ruleset_request.py | 4 +- .../v2/model/custom_ruleset_request_data.py | 4 +- .../custom_ruleset_request_data_attributes.py | 2 +- .../v2/model/custom_ruleset_response.py | 4 +- .../v2/model/degradation.py | 4 +- .../v2/model/degradation_array.py | 4 +- .../v2/model/degradation_data.py | 2 +- ...ta_attributes_components_affected_items.py | 2 +- ...gradation_data_attributes_updates_items.py | 2 +- ...updates_items_components_affected_items.py | 2 +- .../model/degradation_data_relationships.py | 6 +- ...tion_data_relationships_created_by_user.py | 4 +- ...data_relationships_created_by_user_data.py | 2 +- ...ata_relationships_last_modified_by_user.py | 4 +- ...elationships_last_modified_by_user_data.py | 2 +- ...radation_data_relationships_status_page.py | 4 +- ...ion_data_relationships_status_page_data.py | 2 +- .../v2/model/degradation_included.py | 2 +- .../v2/model/deleted_suite_response_data.py | 6 +- .../deleted_suite_response_data_attributes.py | 2 +- .../v2/model/deleted_suites_request_delete.py | 8 +- ...eleted_suites_request_delete_attributes.py | 6 +- .../deleted_suites_request_delete_request.py | 4 +- .../v2/model/deleted_suites_request_type.py | 2 +- .../v2/model/deleted_suites_response.py | 4 +- .../v2/model/deleted_test_response_data.py | 8 +- .../deleted_test_response_data_attributes.py | 2 +- .../v2/model/deleted_tests_request_delete.py | 8 +- ...deleted_tests_request_delete_attributes.py | 6 +- .../deleted_tests_request_delete_request.py | 4 +- .../v2/model/deleted_tests_request_type.py | 2 +- .../v2/model/deleted_tests_response.py | 4 +- .../v2/model/deleted_tests_response_type.py | 2 +- .../v2/model/entity_response_array.py | 4 +- .../model/entity_response_data_attributes.py | 20 +- .../entity_response_data_relationships.py | 12 +- ...y_response_data_relationships_incidents.py | 4 +- ...data_relationships_incidents_data_items.py | 4 +- ...ity_response_data_relationships_oncalls.py | 4 +- ...e_data_relationships_oncalls_data_items.py | 4 +- ..._response_data_relationships_raw_schema.py | 4 +- ...onse_data_relationships_raw_schema_data.py | 4 +- ...nse_data_relationships_related_entities.py | 4 +- ...lationships_related_entities_data_items.py | 4 +- ...tity_response_data_relationships_schema.py | 4 +- ...response_data_relationships_schema_data.py | 4 +- .../v2/model/facet_info_request.py | 4 +- .../v2/model/facet_info_request_data.py | 6 +- .../facet_info_request_data_attributes.py | 10 +- ...cet_info_request_data_attributes_search.py | 4 +- ...nfo_request_data_attributes_term_search.py | 4 +- .../v2/model/facet_info_response.py | 4 +- .../v2/model/facet_info_response_data.py | 6 +- .../facet_info_response_data_attributes.py | 4 +- ...et_info_response_data_attributes_result.py | 6 +- ...o_response_data_attributes_result_range.py | 6 +- ...nse_data_attributes_result_values_items.py | 6 +- .../v2/model/finding_case_response_array.py | 2 +- .../finding_case_response_data_attributes.py | 2 +- .../v2/model/finding_data.py | 2 +- src/datadog_api_client/v2/model/findings.py | 2 +- .../fleet_agent_attributes_tags_items.py | 6 +- .../v2/model/fleet_agent_version.py | 2 +- .../model/fleet_agent_version_attributes.py | 2 +- .../v2/model/fleet_agents_response_data.py | 2 +- .../fleet_agents_response_data_attributes.py | 2 +- .../v2/model/get_mapping_response.py | 4 +- .../v2/model/get_mapping_response_data.py | 6 +- .../get_mapping_response_data_attributes.py | 4 +- ...sponse_data_attributes_attributes_items.py | 14 +- .../v2/model/get_multiple_rulesets_request.py | 4 +- .../get_multiple_rulesets_request_data.py | 6 +- ...ltiple_rulesets_request_data_attributes.py | 8 +- .../model/get_multiple_rulesets_response.py | 4 +- .../get_multiple_rulesets_response_data.py | 6 +- ...tiple_rulesets_response_data_attributes.py | 4 +- ...response_data_attributes_rulesets_items.py | 12 +- ...nse_data_attributes_rulesets_items_data.py | 4 +- ...a_attributes_rulesets_items_rules_items.py | 52 +- ...esets_items_rules_items_arguments_items.py | 6 +- ...ributes_rulesets_items_rules_items_data.py | 4 +- ..._rulesets_items_rules_items_tests_items.py | 8 +- .../global_incident_settings_data_request.py | 2 +- .../global_incident_settings_data_response.py | 2 +- .../model/global_incident_settings_request.py | 4 +- .../global_incident_settings_response.py | 4 +- .../global_variable_json_patch_request.py | 2 +- ...global_variable_json_patch_request_data.py | 4 +- ...able_json_patch_request_data_attributes.py | 2 +- .../hamr_org_connection_attributes_request.py | 2 +- ...hamr_org_connection_attributes_response.py | 2 +- .../model/hamr_org_connection_data_request.py | 4 +- .../hamr_org_connection_data_response.py | 4 +- .../v2/model/hamr_org_connection_request.py | 4 +- .../v2/model/hamr_org_connection_response.py | 4 +- .../v2/model/incident_handle_data_request.py | 4 +- .../v2/model/incident_handle_data_response.py | 4 +- .../incident_handle_included_item_response.py | 2 +- .../v2/model/incident_handle_relationship.py | 4 +- .../incident_handle_relationship_data.py | 2 +- .../v2/model/incident_handle_relationships.py | 10 +- .../incident_handle_relationships_request.py | 6 +- .../v2/model/incident_handle_request.py | 4 +- .../v2/model/incident_handle_response.py | 4 +- .../v2/model/incident_handles_response.py | 4 +- .../v2/model/integration_incident.py | 14 +- ...tegration_incident_field_mappings_items.py | 6 +- .../integration_incident_severity_config.py | 4 +- .../v2/model/integration_jira.py | 10 +- .../model/integration_jira_auto_creation.py | 4 +- .../v2/model/integration_jira_metadata.py | 8 +- .../v2/model/integration_jira_sync.py | 6 +- .../model/integration_jira_sync_due_date.py | 6 +- .../model/integration_jira_sync_properties.py | 18 +- ...ies_custom_fields_additional_properties.py | 4 +- .../v2/model/integration_monitor.py | 10 +- .../v2/model/integration_on_call.py | 8 +- ...ration_on_call_escalation_queries_items.py | 10 +- ...on_call_escalation_queries_items_target.py | 8 +- .../v2/model/integration_service_now.py | 12 +- .../integration_service_now_auto_creation.py | 4 +- .../integration_service_now_sync_config.py | 6 +- ..._service_now_sync_config139772721534496.py | 8 +- ...ration_service_now_sync_config_priority.py | 8 +- .../v2/model/issue_case_relationships.py | 2 +- .../v2/model/list_connections_response.py | 4 +- .../model/list_connections_response_data.py | 6 +- ...st_connections_response_data_attributes.py | 4 +- ...ponse_data_attributes_connections_items.py | 20 +- ..._data_attributes_connections_items_join.py | 6 +- .../list_deployment_rule_response_data.py | 2 +- ...ployment_rules_response_data_attributes.py | 4 +- .../list_notification_channels_response.py | 2 +- ...ist_on_call_notification_rules_response.py | 2 +- .../v2/model/maintenance.py | 4 +- .../v2/model/maintenance_array.py | 4 +- .../v2/model/maintenance_data.py | 2 +- ...ta_attributes_components_affected_items.py | 2 +- ...intenance_data_attributes_updates_items.py | 2 +- ...updates_items_components_affected_items.py | 2 +- .../model/maintenance_data_relationships.py | 6 +- ...ance_data_relationships_created_by_user.py | 4 +- ...data_relationships_created_by_user_data.py | 2 +- ...ata_relationships_last_modified_by_user.py | 4 +- ...elationships_last_modified_by_user_data.py | 2 +- ...ntenance_data_relationships_status_page.py | 4 +- ...nce_data_relationships_status_page_data.py | 2 +- .../v2/model/pagination_meta_page.py | 2 +- .../v2/model/pagination_meta_page_type.py | 2 +- .../v2/model/patch_component_request.py | 4 +- .../v2/model/patch_component_request_data.py | 2 +- .../v2/model/patch_degradation_request.py | 4 +- .../model/patch_degradation_request_data.py | 2 +- ...ta_attributes_components_affected_items.py | 4 +- .../v2/model/patch_maintenance_request.py | 4 +- .../model/patch_maintenance_request_data.py | 2 +- ...ta_attributes_components_affected_items.py | 2 +- .../v2/model/patch_status_page_request.py | 4 +- .../model/patch_status_page_request_data.py | 2 +- src/datadog_api_client/v2/model/playlist.py | 4 +- .../v2/model/playlist_array.py | 4 +- .../v2/model/playlist_data.py | 6 +- .../v2/model/playlist_data_attributes.py | 14 +- .../playlist_data_attributes_created_by.py | 12 +- .../v2/model/playlists_session.py | 4 +- .../v2/model/playlists_session_array.py | 4 +- .../v2/model/playlists_session_data.py | 6 +- .../playlists_session_data_attributes.py | 6 +- .../v2/model/postmortem_attachment_request.py | 2 +- .../postmortem_template_attributes_request.py | 2 +- ...postmortem_template_attributes_response.py | 2 +- .../model/postmortem_template_data_request.py | 4 +- .../postmortem_template_data_response.py | 4 +- .../v2/model/postmortem_template_request.py | 4 +- .../v2/model/postmortem_template_response.py | 4 +- .../v2/model/postmortem_templates_response.py | 4 +- .../v2/model/preview_entity_response_data.py | 8 +- .../v2/model/product_analytics_interval.py | 8 +- .../model/product_analytics_response_meta.py | 4 +- .../product_analytics_response_meta_status.py | 2 +- .../model/product_analytics_scalar_column.py | 2 +- .../product_analytics_scalar_column_meta.py | 4 +- ...ct_analytics_scalar_response_attributes.py | 4 +- .../product_analytics_scalar_response_data.py | 6 +- .../product_analytics_scalar_response_type.py | 2 +- .../v2/model/product_analytics_serie.py | 6 +- .../product_analytics_timeseries_response.py | 2 +- ...nalytics_timeseries_response_attributes.py | 6 +- ...duct_analytics_timeseries_response_data.py | 8 +- ...duct_analytics_timeseries_response_type.py | 2 +- .../v2/model/product_analytics_unit.py | 12 +- src/datadog_api_client/v2/model/project.py | 10 +- .../v2/model/project_attributes.py | 14 +- .../v2/model/project_columns_config.py | 4 +- .../project_columns_config_columns_items.py | 8 +- ...oject_columns_config_columns_items_sort.py | 6 +- .../v2/model/project_create.py | 6 +- .../v2/model/project_create_attributes.py | 10 +- .../v2/model/project_create_request.py | 4 +- .../v2/model/project_notification_settings.py | 20 +- .../v2/model/project_relationship.py | 4 +- .../v2/model/project_relationship_data.py | 6 +- .../v2/model/project_relationships.py | 2 +- .../v2/model/project_resource_type.py | 2 +- .../v2/model/project_response.py | 4 +- .../v2/model/project_settings.py | 18 +- .../v2/model/project_update.py | 6 +- .../v2/model/project_update_attributes.py | 12 +- .../v2/model/project_update_request.py | 4 +- .../v2/model/projects_response.py | 4 +- .../v2/model/query_account_request.py | 4 +- .../v2/model/query_account_request_data.py | 6 +- .../query_account_request_data_attributes.py | 12 +- ...ry_account_request_data_attributes_sort.py | 6 +- .../query_event_filtered_users_request.py | 4 +- ...query_event_filtered_users_request_data.py | 6 +- ..._filtered_users_request_data_attributes.py | 12 +- ...ers_request_data_attributes_event_query.py | 6 +- ..._data_attributes_event_query_time_frame.py | 6 +- .../v2/model/query_response.py | 4 +- .../v2/model/query_response_data.py | 6 +- .../model/query_response_data_attributes.py | 6 +- .../v2/model/query_users_request.py | 4 +- .../v2/model/query_users_request_data.py | 6 +- .../query_users_request_data_attributes.py | 12 +- ...uery_users_request_data_attributes_sort.py | 6 +- .../v2/model/recommendation_attributes.py | 2 +- .../resolve_vulnerable_symbols_request.py | 4 +- ...resolve_vulnerable_symbols_request_data.py | 8 +- ...nerable_symbols_request_data_attributes.py | 4 +- ...ve_vulnerable_symbols_request_data_type.py | 2 +- .../resolve_vulnerable_symbols_response.py | 4 +- ...esolve_vulnerable_symbols_response_data.py | 8 +- ...erable_symbols_response_data_attributes.py | 4 +- ...e_vulnerable_symbols_response_data_type.py | 2 +- ...lve_vulnerable_symbols_response_results.py | 6 +- ...ols_response_results_vulnerable_symbols.py | 6 +- ...onse_results_vulnerable_symbols_symbols.py | 8 +- .../revert_custom_rule_revision_request.py | 4 +- ...evert_custom_rule_revision_request_data.py | 4 +- ...m_rule_revision_request_data_attributes.py | 2 +- .../v2/model/sca_request.py | 4 +- .../v2/model/sca_request_data.py | 8 +- .../v2/model/sca_request_data_attributes.py | 20 +- .../sca_request_data_attributes_commit.py | 16 +- ...uest_data_attributes_dependencies_items.py | 24 +- ...utes_dependencies_items_locations_items.py | 10 +- ...ies_items_locations_items_file_position.py | 8 +- ...ndencies_items_locations_items_position.py | 6 +- ...items_reachable_symbol_properties_items.py | 6 +- ...sca_request_data_attributes_files_items.py | 6 +- ...request_data_attributes_relations_items.py | 6 +- .../sca_request_data_attributes_repository.py | 4 +- ...t_data_attributes_vulnerabilities_items.py | 8 +- ...tes_vulnerabilities_items_affects_items.py | 4 +- .../v2/model/sca_request_data_type.py | 2 +- .../v2/model/seat_user_data.py | 4 +- .../v2/model/seat_user_data_array.py | 4 +- .../v2/model/seat_user_data_attributes.py | 2 +- .../v2/model/seat_user_meta.py | 2 +- .../v2/model/secret_rule_array.py | 4 +- .../v2/model/secret_rule_data.py | 6 +- .../v2/model/secret_rule_data_attributes.py | 20 +- ...t_rule_data_attributes_match_validation.py | 18 +- ...lidation_invalid_http_status_code_items.py | 6 +- ...validation_valid_http_status_code_items.py | 6 +- .../security_entity_risk_scores_response.py | 2 +- .../v2/model/service_list.py | 4 +- .../v2/model/service_list_data.py | 6 +- .../v2/model/service_list_data_attributes.py | 6 +- ...ice_list_data_attributes_metadata_items.py | 6 +- .../v2/model/session_id_array.py | 4 +- .../v2/model/session_id_data.py | 4 +- src/datadog_api_client/v2/model/snapshot.py | 4 +- .../v2/model/snapshot_array.py | 4 +- .../v2/model/snapshot_create_request.py | 4 +- .../v2/model/snapshot_create_request_data.py | 4 +- ...snapshot_create_request_data_attributes.py | 20 +- .../v2/model/snapshot_data.py | 6 +- .../v2/model/snapshot_data_attributes.py | 32 +- .../v2/model/snapshot_update_request.py | 4 +- .../v2/model/snapshot_update_request_data.py | 6 +- ...snapshot_update_request_data_attributes.py | 12 +- .../v2/model/status_page.py | 4 +- .../v2/model/status_page_array.py | 4 +- .../v2/model/status_page_array_included.py | 2 +- ...as_included_attributes_components_items.py | 4 +- ...butes_components_items_components_items.py | 2 +- .../status_page_as_included_relationships.py | 4 +- ..._included_relationships_created_by_user.py | 4 +- ...uded_relationships_created_by_user_data.py | 2 +- ...ded_relationships_last_modified_by_user.py | 4 +- ...elationships_last_modified_by_user_data.py | 2 +- .../v2/model/status_page_data.py | 2 +- ...s_page_data_attributes_components_items.py | 2 +- ...butes_components_items_components_items.py | 2 +- .../model/status_page_data_relationships.py | 4 +- ...page_data_relationships_created_by_user.py | 4 +- ...data_relationships_created_by_user_data.py | 2 +- ...ata_relationships_last_modified_by_user.py | 4 +- ...elationships_last_modified_by_user_data.py | 2 +- .../v2/model/status_pages_component.py | 4 +- .../v2/model/status_pages_component_array.py | 4 +- .../status_pages_component_array_included.py | 2 +- .../v2/model/status_pages_component_data.py | 2 +- ...ponent_data_attributes_components_items.py | 8 +- ...atus_pages_component_data_relationships.py | 8 +- ...nent_data_relationships_created_by_user.py | 4 +- ...data_relationships_created_by_user_data.py | 2 +- ...ages_component_data_relationships_group.py | 4 +- ...component_data_relationships_group_data.py | 2 +- ...ata_relationships_last_modified_by_user.py | 4 +- ...elationships_last_modified_by_user_data.py | 2 +- ...omponent_data_relationships_status_page.py | 4 +- ...ent_data_relationships_status_page_data.py | 2 +- ...onent_group_attributes_components_items.py | 2 +- ...ent_group_relationships_created_by_user.py | 2 +- ...roup_relationships_created_by_user_data.py | 2 +- ...ges_component_group_relationships_group.py | 2 +- ...omponent_group_relationships_group_data.py | 4 +- ...oup_relationships_last_modified_by_user.py | 2 +- ...elationships_last_modified_by_user_data.py | 2 +- ...mponent_group_relationships_status_page.py | 2 +- ...nt_group_relationships_status_page_data.py | 2 +- .../v2/model/suite_create_edit.py | 2 +- .../v2/model/suite_create_edit_request.py | 4 +- .../v2/model/suite_search_response_type.py | 2 +- .../v2/model/sync_property.py | 4 +- .../v2/model/sync_property_with_mapping.py | 8 +- .../v2/model/synthetics_network_test_edit.py | 2 +- .../synthetics_network_test_edit_request.py | 2 +- .../v2/model/synthetics_suite.py | 2 +- .../synthetics_suite_search_response_data.py | 4 +- ...s_suite_search_response_data_attributes.py | 4 +- .../v2/model/synthetics_suite_test.py | 2 +- .../v2/model/table_row_resource_identifier.py | 2 +- .../v2/model/tenancy_config.py | 4 +- .../v2/model/tenancy_config_data.py | 6 +- .../model/tenancy_config_data_attributes.py | 28 +- ...ancy_config_data_attributes_logs_config.py | 8 +- ...y_config_data_attributes_metrics_config.py | 8 +- ...y_config_data_attributes_regions_config.py | 8 +- .../v2/model/tenancy_config_list.py | 4 +- .../v2/model/tenancy_products_data.py | 6 +- .../model/tenancy_products_data_attributes.py | 4 +- ...products_data_attributes_products_items.py | 6 +- .../v2/model/tenancy_products_list.py | 4 +- .../v2/model/timeseries_response_series.py | 2 +- .../v2/model/unassign_seats_user_request.py | 4 +- .../model/unassign_seats_user_request_data.py | 4 +- ...sign_seats_user_request_data_attributes.py | 2 +- .../v2/model/update_connection_request.py | 4 +- .../model/update_connection_request_data.py | 6 +- ...date_connection_request_data_attributes.py | 8 +- ..._data_attributes_fields_to_update_items.py | 12 +- .../v2/model/update_tenancy_config_data.py | 6 +- .../update_tenancy_config_data_attributes.py | 18 +- ...config_data_attributes_auth_credentials.py | 6 +- ...ancy_config_data_attributes_logs_config.py | 8 +- ...y_config_data_attributes_metrics_config.py | 8 +- ...y_config_data_attributes_regions_config.py | 8 +- .../v2/model/update_tenancy_config_request.py | 4 +- .../model/viewership_history_session_array.py | 4 +- .../model/viewership_history_session_data.py | 6 +- ...wership_history_session_data_attributes.py | 10 +- src/datadog_api_client/v2/model/watch.py | 4 +- src/datadog_api_client/v2/model/watch_data.py | 6 +- .../v2/model/watch_data_attributes.py | 10 +- .../v2/model/watcher_array.py | 4 +- .../v2/model/watcher_data.py | 6 +- .../v2/model/watcher_data_attributes.py | 12 +- 448 files changed, 2400 insertions(+), 1240 deletions(-) diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 1fe1b58cae..c50c12d2fa 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -951,7 +951,7 @@ components: schema: type: string ProjectIDPathParameter: - description: Project UUID + description: Project UUID. example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" in: path name: project_id @@ -2374,6 +2374,7 @@ components: - "amplify:ListBackendEnvironments" - "amplify:ListBranches" items: + description: An AWS IAM permission required for the Datadog integration. example: "account:GetContactInformation" type: string type: array @@ -2429,6 +2430,7 @@ components: lambdas: description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`. items: + description: The ARN of a Datadog Lambda Log Forwarder function. example: "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" type: string type: array @@ -2442,6 +2444,7 @@ components: services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint. items: + description: An AWS service ID for which automatic log collection is enabled. example: s3 type: string type: array @@ -2501,6 +2504,7 @@ components: example: - "s3" items: + description: The name of an AWS service that can send logs to Datadog. example: "s3" type: string type: array @@ -2582,6 +2586,7 @@ components: - "AWS/ElasticMapReduce" - "AWS/Usage" items: + description: An AWS CloudWatch namespace to exclude from metrics collection. example: "AWS/SQS" type: string type: array @@ -2596,6 +2601,7 @@ components: example: - "AWS/EC2" items: + description: An AWS CloudWatch namespace to include in metrics collection. example: "AWS/EC2" type: string type: array @@ -2641,6 +2647,7 @@ components: example: - "AWS/ApiGateway" items: + description: An AWS CloudWatch namespace name. example: "AWS/ApiGateway" type: string type: array @@ -2738,6 +2745,7 @@ components: example: - "us-east-1" items: + description: An AWS region to include in metrics collection. example: "us-east-1" type: string type: array @@ -2774,6 +2782,7 @@ components: description: The AWS account IDs to be excluded from your billing dataset. This field is used when `include_new_accounts` is `true`. example: ["123456789123", "123456789143"] items: + description: An AWS account ID to exclude from the billing dataset. type: string type: array include_new_accounts: @@ -2785,6 +2794,7 @@ components: description: The AWS account IDs to be included in your billing dataset. This field is used when `include_new_accounts` is `false`. example: ["123456789123", "123456789143"] items: + description: An AWS account ID to include in the billing dataset. type: string type: array type: object @@ -3040,6 +3050,7 @@ components: tags: description: The tags of the connection group. items: + description: A tag for the connection group. type: string type: array type: object @@ -3458,24 +3469,30 @@ components: - $ref: "#/components/schemas/AnyValueBoolean" type: object AnyValueArray: + description: An array of arbitrary values. items: $ref: "#/components/schemas/AnyValueItem" type: array AnyValueBoolean: + description: A scalar boolean value. type: boolean AnyValueItem: + description: A single item in an array of arbitrary values, which can be a string, number, object, or boolean. oneOf: - $ref: "#/components/schemas/AnyValueString" - $ref: "#/components/schemas/AnyValueNumber" - $ref: "#/components/schemas/AnyValueObject" - $ref: "#/components/schemas/AnyValueBoolean" AnyValueNumber: + description: A scalar numeric value. format: double type: number AnyValueObject: additionalProperties: {} + description: An arbitrary object value with additional properties. type: object AnyValueString: + description: A scalar string value. type: string ApiID: description: API identifier. @@ -3888,6 +3905,7 @@ components: key_path: description: Specific path for the input. items: + description: A path segment for the input key. type: string type: array required: @@ -4020,6 +4038,7 @@ components: List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator. items: + description: A value to match against in the condition. type: string type: array options: @@ -4501,6 +4520,7 @@ components: parameters: description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character. items: + description: A parameter name matched by the exclusion filter in the HTTP query string or request body. example: "list.search.query" type: string type: array @@ -4650,6 +4670,7 @@ components: example: - "" items: + description: A cloud provider name. type: string type: array rejected: @@ -4689,6 +4710,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -4712,6 +4734,7 @@ components: allocated_by_tag_keys: description: The `strategy` `allocated_by_tag_keys`. items: + description: A tag key used to group cost allocations. type: string type: array based_on_costs: @@ -4731,6 +4754,7 @@ components: evaluate_grouped_by_tag_keys: description: The `strategy` `evaluate_grouped_by_tag_keys`. items: + description: A tag key used to group cost evaluation. type: string type: array granularity: @@ -4760,6 +4784,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -4816,6 +4841,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -4840,6 +4866,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5095,6 +5122,7 @@ components: example: - "" items: + description: A cloud provider name. type: string type: array rejected: @@ -5151,6 +5179,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5174,6 +5203,7 @@ components: allocated_by_tag_keys: description: The `strategy` `allocated_by_tag_keys`. items: + description: A tag key used to group cost allocations. type: string type: array based_on_costs: @@ -5193,6 +5223,7 @@ components: evaluate_grouped_by_tag_keys: description: The `strategy` `evaluate_grouped_by_tag_keys`. items: + description: A tag key used to group cost evaluation. type: string type: array granularity: @@ -5222,6 +5253,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5278,6 +5310,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5302,6 +5335,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5319,6 +5353,7 @@ components: x-enum-varnames: - ARBITRARY_RULE Argument: + description: A named argument for a custom static analysis rule. properties: description: description: Base64-encoded argument description @@ -5429,6 +5464,7 @@ components: example: - staging items: + description: An environment where the asset is deployed. example: staging type: string type: array @@ -5445,6 +5481,7 @@ components: example: - compute items: + description: A team that owns the asset. example: compute type: string type: array @@ -5535,12 +5572,14 @@ components: type: string type: object AssignSeatsUserRequest: + description: The request body for assigning seats to users for a product code. properties: data: $ref: "#/components/schemas/AssignSeatsUserRequestData" description: The data for the assign seats user request. type: object AssignSeatsUserRequestData: + description: The request data object containing attributes for assigning seats to users. properties: attributes: $ref: "#/components/schemas/AssignSeatsUserRequestDataAttributes" @@ -5556,6 +5595,7 @@ components: - attributes type: object AssignSeatsUserRequestDataAttributes: + description: Attributes specifying the product and users to whom seats will be assigned. properties: product_code: description: The product code for which to assign seats. @@ -5566,6 +5606,7 @@ components: example: - "" items: + description: A user UUID identifying a user to assign a seat to. type: string type: array required: @@ -5573,12 +5614,14 @@ components: - user_uuids type: object AssignSeatsUserResponse: + description: The response body returned after successfully assigning seats to users. properties: data: $ref: "#/components/schemas/AssignSeatsUserResponseData" description: The data for the assign seats user response. type: object AssignSeatsUserResponseData: + description: The response data object containing attributes of the seat assignment result. properties: attributes: $ref: "#/components/schemas/AssignSeatsUserResponseDataAttributes" @@ -5590,10 +5633,12 @@ components: $ref: "#/components/schemas/SeatAssignmentsDataType" type: object AssignSeatsUserResponseDataAttributes: + description: Attributes of the assign seats response, including the list of users assigned and the product code. properties: assigned_ids: description: The list of user IDs to which the seats were assigned. items: + description: A user UUID identifying a user to whom a seat was assigned. type: string type: array product_code: @@ -5677,6 +5722,7 @@ components: data: $ref: "#/components/schemas/AttachmentData" included: + description: A list of related objects included in the response. items: $ref: "#/components/schemas/AttachmentIncluded" type: array @@ -5685,10 +5731,12 @@ components: description: A list of incident attachments. properties: data: + description: An array of attachment data objects. items: $ref: "#/components/schemas/AttachmentData" type: array included: + description: A list of related objects included in the response. items: $ref: "#/components/schemas/AttachmentIncluded" type: array @@ -6243,21 +6291,21 @@ components: x-enum-varnames: - AUTHN_MAPPINGS AutoCloseInactiveCases: - description: Auto-close inactive cases settings + description: Auto-close inactive cases settings. properties: enabled: - description: Whether auto-close is enabled + description: Whether auto-close is enabled. type: boolean max_inactive_time_in_secs: - description: Maximum inactive time in seconds before auto-closing + description: Maximum inactive time in seconds before auto-closing. format: int64 type: integer type: object AutoTransitionAssignedCases: - description: Auto-transition assigned cases settings + description: Auto-transition assigned cases settings. properties: auto_transition_assigned_cases_on_self_assigned: - description: Whether to auto-transition cases when self-assigned + description: Whether to auto-transition cases when self-assigned. type: boolean type: object AwsAccountId: @@ -6302,6 +6350,7 @@ components: error_messages: description: The error messages for the AWS CUR config. items: + description: An error message string. type: string nullable: true type: array @@ -6520,6 +6569,7 @@ components: error_messages: description: The `attributes` `error_messages`. items: + description: An error message string. type: string nullable: true type: array @@ -6549,6 +6599,7 @@ components: excluded_accounts: description: The `account_filters` `excluded_accounts`. items: + description: An AWS account ID to exclude. type: string type: array include_new_accounts: @@ -6558,6 +6609,7 @@ components: included_accounts: description: The `account_filters` `included_accounts`. items: + description: An AWS account ID to include. type: string type: array type: object @@ -6977,6 +7029,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["processor-id"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -7073,6 +7126,7 @@ components: error_messages: description: The error messages for the Azure config. items: + description: An error message string. type: string nullable: true type: array @@ -7276,6 +7330,7 @@ components: description: The request body for deleting multiple rows from a reference table. properties: data: + description: List of row resources to delete from the reference table. items: $ref: "#/components/schemas/TableRowResourceIdentifier" maxItems: 200 @@ -7365,6 +7420,7 @@ components: description: The request body for creating or updating multiple rows into a reference table. properties: data: + description: List of row resources to create or update in the reference table. items: $ref: "#/components/schemas/BatchUpsertRowsRequestData" maxItems: 200 @@ -7378,6 +7434,7 @@ components: attributes: $ref: "#/components/schemas/BatchUpsertRowsRequestDataAttributes" id: + description: The primary key value that uniquely identifies the row to create or update. example: "primary_key_value" type: string type: @@ -7480,6 +7537,7 @@ components: - "apm_host_top99p" - "apm_host_sum" items: + description: A billing dimension key. example: apm_host_top99p type: string type: array @@ -7604,6 +7662,7 @@ components: format: int64 type: integer entries: + description: The list of monthly budget entries. items: $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems" type: array @@ -7641,6 +7700,7 @@ components: type: string type: object BudgetValidationRequest: + description: The request object for validating a budget configuration before creating or updating it. example: data: attributes: @@ -7672,10 +7732,12 @@ components: $ref: "#/components/schemas/BudgetValidationRequestData" type: object BudgetValidationRequestData: + description: The data object for a budget validation request, containing the resource type, ID, and budget attributes to validate. properties: attributes: $ref: "#/components/schemas/BudgetWithEntriesDataAttributes" id: + description: The unique identifier of the budget to validate. type: string type: $ref: "#/components/schemas/BudgetWithEntriesDataType" @@ -7683,6 +7745,7 @@ components: - type type: object BudgetValidationResponse: + description: The response object for a budget validation request, containing the validation result data. example: data: attributes: @@ -7695,10 +7758,12 @@ components: $ref: "#/components/schemas/BudgetValidationResponseData" type: object BudgetValidationResponseData: + description: The data object for a budget validation response, containing the resource type, ID, and validation attributes. properties: attributes: $ref: "#/components/schemas/BudgetValidationResponseDataAttributes" id: + description: The unique identifier of the budget being validated. type: string type: $ref: "#/components/schemas/BudgetValidationResponseDataType" @@ -7706,12 +7771,16 @@ components: - type type: object BudgetValidationResponseDataAttributes: + description: The attributes of a budget validation response, including any validation errors and the validity status. properties: errors: + description: A list of validation error messages for the budget. items: + description: A validation error message. type: string type: array valid: + description: Whether the budget configuration is valid. type: boolean type: object BudgetValidationResponseDataType: @@ -7744,56 +7813,75 @@ components: type: string type: object BudgetWithEntriesDataAttributes: + description: The attributes of a budget including all its monthly entries. properties: created_at: + description: The timestamp when the budget was created. format: int64 type: integer created_by: + description: The ID of the user that created the budget. type: string end_month: + description: The month when the budget ends, in YYYYMM format. format: int64 type: integer entries: + description: The list of monthly budget entries. items: $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems" type: array metrics_query: + description: The cost query used to track spending against the budget. type: string name: + description: The name of the budget. type: string org_id: + description: The ID of the organization the budget belongs to. format: int64 type: integer start_month: + description: The month when the budget starts, in YYYYMM format. format: int64 type: integer total_amount: + description: The total budget amount across all entries. format: double type: number updated_at: + description: The timestamp when the budget was last updated. format: int64 type: integer updated_by: + description: The ID of the user that last updated the budget. type: string type: object BudgetWithEntriesDataAttributesEntriesItems: + description: A single monthly budget entry defining the allocated amount and optional tag filters for a specific month. properties: amount: + description: The budgeted amount for this entry. format: double type: number month: + description: The month this budget entry applies to, in YYYYMM format. format: int64 type: integer tag_filters: + description: The list of tag filters that scope this budget entry to specific resources. items: $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems" type: array type: object BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems: + description: A tag filter used to scope a budget entry to specific resource tags. properties: tag_key: + description: The tag key to filter on. type: string tag_value: + description: The tag value to filter on. type: string type: object BudgetWithEntriesDataType: @@ -7830,6 +7918,7 @@ components: item_keys: description: List of primary keys identifying items to delete from datastore. Up to 100 items can be deleted in a single request. items: + description: A primary key identifying a datastore item to delete. type: string maxItems: 100 type: array @@ -8290,6 +8379,7 @@ components: - ubuntu-18.04 - n2.large items: + description: A label used to select or identify the node. type: string type: array name: @@ -9575,6 +9665,7 @@ components: - data type: object CaseManagementProjectData: + description: Data object representing a case management project. properties: id: description: Unique identifier of the case management project. @@ -9804,6 +9895,7 @@ components: CaseObjectAttributes: additionalProperties: items: + description: An attribute value. type: string type: array description: The definition of `CaseObjectAttributes` object. @@ -10540,6 +10632,7 @@ components: example: - "team-handle-1" items: + description: A team handle to request decisions from. type: string type: array start_date: @@ -10807,6 +10900,7 @@ components: ChangeRequestObjectAttributes: additionalProperties: items: + description: An attribute value. type: string type: array description: Custom attributes of the change request as key-value pairs. @@ -11262,6 +11356,7 @@ components: - gcp_iam_service_account - gcp_iam_policy items: + description: A cloud resource type identifier. type: string type: array required: @@ -11292,6 +11387,7 @@ components: defaultGroupByFields: description: The default group by fields. items: + description: A field name used for default grouping. type: string nullable: true type: array @@ -11302,6 +11398,7 @@ components: userGroupByFields: description: Fields to use to group findings by when sending signals. items: + description: A field name to group findings by. type: string nullable: true type: array @@ -11462,12 +11559,15 @@ components: hostTags: description: "The host tags defining where this policy is deployed" items: + description: "A host tag used to identify where this policy is deployed." type: string type: array hostTagsLists: description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: + description: "A list of host tags linked with AND logic." items: + description: "A host tag used to filter the deployment scope." type: string type: array type: array @@ -11533,12 +11633,15 @@ components: hostTags: description: "The host tags defining where this policy is deployed" items: + description: "A host tag used to identify where this policy is deployed." type: string type: array hostTagsLists: description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: + description: "A list of host tags linked with AND logic." items: + description: "A host tag used to filter the deployment scope." type: string type: array type: array @@ -11612,12 +11715,15 @@ components: hostTags: description: "The host tags defining where this policy is deployed" items: + description: "A host tag used to identify where this policy is deployed." type: string type: array hostTagsLists: description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: + description: "A list of host tags linked with AND logic." items: + description: "A host tag used to filter the deployment scope." type: string type: array type: array @@ -11770,6 +11876,7 @@ components: blocking: description: "The blocking policies that the rule belongs to" items: + description: "The ID of a blocking policy that this rule belongs to." type: string type: array category: @@ -11798,6 +11905,7 @@ components: disabled: description: "The disabled policies that the rule belongs to" items: + description: "The ID of a disabled policy that this rule belongs to." type: string type: array enabled: @@ -11811,11 +11919,13 @@ components: filters: description: "The platforms the Agent rule is supported on" items: + description: "A platform filter that the Agent rule is supported on." type: string type: array monitoring: description: "The monitoring policies that the rule belongs to" items: + description: "The ID of a monitoring policy that this rule belongs to." type: string type: array name: @@ -11825,6 +11935,7 @@ components: product_tags: description: "The list of product tags associated with the rule" items: + description: "A product tag associated with the rule." type: string type: array silent: @@ -11864,6 +11975,7 @@ components: blocking: description: "The blocking policies that the rule belongs to." items: + description: "The ID of a blocking policy that this rule belongs to." type: string type: array description: @@ -11873,6 +11985,7 @@ components: disabled: description: "The disabled policies that the rule belongs to." items: + description: "The ID of a disabled policy that this rule belongs to." type: string type: array enabled: @@ -11886,11 +11999,13 @@ components: filters: description: "The platforms the Agent rule is supported on." items: + description: "A platform filter that the Agent rule is supported on." type: string type: array monitoring: description: "The monitoring policies that the rule belongs to." items: + description: "The ID of a monitoring policy that this rule belongs to." type: string type: array name: @@ -11904,6 +12019,7 @@ components: product_tags: description: "The list of product tags associated with the rule." items: + description: "A product tag associated with the rule." type: string type: array silent: @@ -11994,6 +12110,7 @@ components: blocking: description: "The blocking policies that the rule belongs to" items: + description: "The ID of a blocking policy that this rule belongs to." type: string type: array description: @@ -12003,6 +12120,7 @@ components: disabled: description: "The disabled policies that the rule belongs to" items: + description: "The ID of a disabled policy that this rule belongs to." type: string type: array enabled: @@ -12016,6 +12134,7 @@ components: monitoring: description: "The monitoring policies that the rule belongs to" items: + description: "The ID of a monitoring policy that this rule belongs to." type: string type: array policy_id: @@ -12025,6 +12144,7 @@ components: product_tags: description: "The list of product tags associated with the rule" items: + description: "A product tag associated with the rule." type: string type: array silent: @@ -12134,12 +12254,14 @@ components: description: An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`. example: ["web", "dns", "lb", "worker"] items: + description: A Cloudflare resource type (for example, `web`, `dns`, `lb`, `worker`). type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. example: ["zone_id_1", "zone_id_2"] items: + description: A Cloudflare zone ID to restrict pulling metrics for. type: string type: array required: @@ -12178,12 +12300,14 @@ components: description: An allowlist of resources, such as `web`, `dns`, `lb` (load balancer), `worker`, that restricts pulling metrics from those resources. example: ["web", "dns", "lb", "worker"] items: + description: A Cloudflare resource type (for example, `web`, `dns`, `lb`, `worker`). type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. example: ["zone_id_1", "zone_id_2"] items: + description: A Cloudflare zone ID to restrict pulling metrics for. type: string type: array required: @@ -12240,12 +12364,14 @@ components: description: An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`. example: ["web", "dns", "lb", "worker"] items: + description: A Cloudflare resource type (for example, `web`, `dns`, `lb`, `worker`). type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. example: ["zone_id_1", "zone_id_2"] items: + description: A Cloudflare zone ID to restrict pulling metrics for. type: string type: array required: @@ -12796,6 +12922,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12835,6 +12962,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12864,6 +12992,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12919,6 +13048,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12971,6 +13101,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -13020,6 +13151,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -13144,6 +13276,7 @@ components: example: - "" items: + description: A tag string in `key:value` format. type: string type: array required: @@ -13228,6 +13361,7 @@ components: image_tags: description: List of image tags associated with the container image. items: + description: An image tag associated with the container. type: string nullable: true type: array @@ -13243,6 +13377,7 @@ components: tags: description: List of tags associated with the container. items: + description: A tag associated with the container. type: string type: array type: object @@ -13723,6 +13858,7 @@ components: example: - "" items: + description: A job result ID. type: string type: array notifications: @@ -13730,6 +13866,7 @@ components: example: - "" items: + description: A notification recipient handle. type: string type: array signalMessage: @@ -14207,6 +14344,7 @@ components: attributes: $ref: "#/components/schemas/CreateAttachmentRequestDataAttributes" id: + description: The unique identifier of the attachment. type: string type: $ref: "#/components/schemas/IncidentAttachmentType" @@ -14237,6 +14375,7 @@ components: description: List of requests to create cases for security findings. properties: data: + description: Array of case creation request data objects. items: $ref: "#/components/schemas/CreateCaseRequestData" type: array @@ -14289,6 +14428,7 @@ components: - project type: object CreateComponentRequest: + description: Request object for creating a component. example: data: attributes: @@ -14304,6 +14444,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestData" type: object CreateComponentRequestData: + description: The data object for creating a component. properties: attributes: $ref: "#/components/schemas/CreateComponentRequestDataAttributes" @@ -14349,6 +14490,7 @@ components: - type type: object CreateComponentRequestDataAttributesComponentsItems: + description: A component to be created within a group. properties: name: description: The name of the grouped component. @@ -14384,6 +14526,7 @@ components: description: The group to create the component within. type: object CreateComponentRequestDataRelationshipsGroup: + description: The group to create the component within. properties: data: $ref: "#/components/schemas/CreateComponentRequestDataRelationshipsGroupData" @@ -14391,6 +14534,7 @@ components: - data type: object CreateComponentRequestDataRelationshipsGroupData: + description: The data object identifying the group to create the component within. nullable: true properties: id: @@ -14405,6 +14549,7 @@ components: - id type: object CreateConnectionRequest: + description: Request body for creating a new data source connection for an entity. example: data: attributes: @@ -14429,10 +14574,12 @@ components: $ref: "#/components/schemas/CreateConnectionRequestData" type: object CreateConnectionRequestData: + description: The data object containing the resource type and attributes for creating a new connection. properties: attributes: $ref: "#/components/schemas/CreateConnectionRequestDataAttributes" id: + description: Unique identifier for the new connection resource. type: string type: $ref: "#/components/schemas/UpdateConnectionRequestDataType" @@ -14440,22 +14587,28 @@ components: - type type: object CreateConnectionRequestDataAttributes: + description: Attributes defining the data source connection, including join configuration and custom fields. properties: fields: + description: List of custom attribute fields to import from the data source. items: $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array join_attribute: + description: The attribute in the data source used to join records with the entity. example: "" type: string join_type: + description: The type of join key used to link the data source to the entity (for example, email or user_id). example: "" type: string metadata: additionalProperties: type: string + description: Additional key-value metadata associated with the connection. type: object type: + description: The type of data source connection (for example, ref_table). example: "" type: string required: @@ -14464,22 +14617,30 @@ components: - type type: object CreateConnectionRequestDataAttributesFieldsItems: + description: Definition of a custom attribute field to import from a data source connection. properties: description: + description: Human-readable explanation of what the field represents. type: string display_name: + description: The human-readable label for the field shown in the UI. type: string groups: + description: List of group labels used to categorize the field. items: + description: A group label name for categorizing the field. type: string type: array id: + description: The unique identifier for the field within the connection. example: "" type: string source_name: + description: The name of the column or attribute in the source data system that maps to this field. example: "" type: string type: + description: The data type of the field (for example, string or number). example: "" type: string required: @@ -14570,6 +14731,7 @@ components: $ref: "#/components/schemas/DataDeletionResponseMeta" type: object CreateDegradationRequest: + description: Request object for creating a degradation. example: data: attributes: @@ -14585,6 +14747,7 @@ components: $ref: "#/components/schemas/CreateDegradationRequestData" type: object CreateDegradationRequestData: + description: The data object for creating a degradation. properties: attributes: $ref: "#/components/schemas/CreateDegradationRequestDataAttributes" @@ -14623,6 +14786,7 @@ components: - title type: object CreateDegradationRequestDataAttributesComponentsAffectedItems: + description: A component affected by a degradation. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -14630,6 +14794,7 @@ components: format: uuid type: string name: + description: The name of the component. readOnly: true type: string status: @@ -14898,6 +15063,7 @@ components: description: List of requests to create Jira issues for security findings. properties: data: + description: Array of Jira issue creation request data objects. items: $ref: "#/components/schemas/CreateJiraIssueRequestData" type: array @@ -14955,6 +15121,7 @@ components: - project type: object CreateMaintenanceRequest: + description: Request object for creating a maintenance. example: data: attributes: @@ -14973,6 +15140,7 @@ components: $ref: "#/components/schemas/CreateMaintenanceRequestData" type: object CreateMaintenanceRequestData: + description: The data object for creating a maintenance. properties: attributes: $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributes" @@ -15016,6 +15184,7 @@ components: - title type: object CreateMaintenanceRequestDataAttributesComponentsAffectedItems: + description: A component affected by a maintenance. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -15430,6 +15599,7 @@ components: example: - "" items: + description: A source key for the reference table lookup. type: string type: array table_name: @@ -15466,6 +15636,7 @@ components: x-enum-varnames: - CREATE_RULESET CreateStatusPageRequest: + description: Request object for creating a status page. example: data: attributes: @@ -15501,6 +15672,7 @@ components: $ref: "#/components/schemas/CreateStatusPageRequestData" type: object CreateStatusPageRequestData: + description: The data object for creating a status page. properties: attributes: $ref: "#/components/schemas/CreateStatusPageRequestDataAttributes" @@ -15577,6 +15749,7 @@ components: - visualization_type type: object CreateStatusPageRequestDataAttributesComponentsItems: + description: A component to be created on a status page. properties: components: description: If creating a component of type `group`, the components to create within the group. @@ -15601,6 +15774,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems: + description: A grouped component to be created within a status page component group. properties: id: description: The ID of the grouped component. @@ -15680,6 +15854,7 @@ components: - "tag_1" - "tag_2" items: + description: A tag associated with the reference table. type: string type: array required: @@ -15823,6 +15998,7 @@ components: example: - "field_1" items: + description: A field name used as a primary key. type: string type: array required: @@ -15852,10 +16028,12 @@ components: x-enum-varnames: - REFERENCE_TABLE CreateTenancyConfigData: + description: The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes. properties: attributes: $ref: "#/components/schemas/CreateTenancyConfigDataAttributes" id: + description: The OCID of the OCI tenancy to configure. example: "" type: string type: @@ -15865,20 +16043,26 @@ components: - id type: object CreateTenancyConfigDataAttributes: + description: Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options. properties: auth_credentials: $ref: "#/components/schemas/CreateTenancyConfigDataAttributesAuthCredentials" config_version: + description: Version number of the integration the tenancy is integrated with format: int64 nullable: true type: integer cost_collection_enabled: + description: Whether cost data collection from OCI is enabled for the tenancy. type: boolean dd_compartment_id: + description: The OCID of the OCI compartment used by the Datadog integration stack. type: string dd_stack_id: + description: The OCID of the OCI Resource Manager stack used by the Datadog integration. type: string home_region: + description: The home region of the OCI tenancy (for example, us-ashburn-1). example: "" type: string logs_config: @@ -15888,8 +16072,10 @@ components: regions_config: $ref: "#/components/schemas/CreateTenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: + description: Whether resource collection from OCI is enabled for the tenancy. type: boolean user_ocid: + description: The OCID of the OCI user used by the Datadog integration for authentication. example: "" type: string required: @@ -15898,57 +16084,80 @@ components: - user_ocid type: object CreateTenancyConfigDataAttributesAuthCredentials: + description: OCI API signing key credentials used to authenticate the Datadog integration with the OCI tenancy. properties: fingerprint: + description: The fingerprint of the OCI API signing key used for authentication. type: string private_key: + description: The PEM-encoded private key corresponding to the OCI API signing key fingerprint. example: "" type: string required: - private_key type: object CreateTenancyConfigDataAttributesLogsConfig: + description: Log collection configuration for an OCI tenancy, controlling which compartments and services have log collection enabled. properties: compartment_tag_filters: + description: List of compartment tag filters to scope log collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether log collection is enabled for the tenancy. type: boolean enabled_services: + description: List of OCI service names for which log collection is enabled. items: + description: An OCI service name for which log collection is enabled (for example, compute). type: string type: array type: object CreateTenancyConfigDataAttributesMetricsConfig: + description: Metrics collection configuration for an OCI tenancy, controlling which compartments and services are included or excluded. properties: compartment_tag_filters: + description: List of compartment tag filters to scope metrics collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether metrics collection is enabled for the tenancy. type: boolean excluded_services: + description: List of OCI service names to exclude from metrics collection. items: + description: An OCI service name to exclude from metrics collection (for example, compute). type: string type: array type: object CreateTenancyConfigDataAttributesRegionsConfig: + description: Region configuration for an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. properties: available: + description: List of OCI regions available for data collection in the tenancy. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array disabled: + description: List of OCI regions explicitly disabled for data collection. items: + description: An OCI region identifier (for example, us-phoenix-1). type: string type: array enabled: + description: List of OCI regions enabled for data collection. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array type: object CreateTenancyConfigRequest: + description: Request body for creating a new OCI tenancy integration configuration. example: data: attributes: @@ -16050,6 +16259,7 @@ components: - "field_1" - "field_2" items: + description: A column header name from the CSV file. type: string type: array part_count: @@ -16109,6 +16319,7 @@ components: part_urls: description: The pre-signed URLs for uploading parts. These URLs expire after 5 minutes. items: + description: A pre-signed URL for uploading a single file part. type: string type: array type: object @@ -16269,6 +16480,7 @@ components: cluster_name: description: List of cluster names associated with the Agent. items: + description: A cluster name associated with the Agent. type: string type: array datadog_agent: @@ -16280,6 +16492,7 @@ components: envs: description: List of environments associated with the Agent. items: + description: An environment name associated with the Agent. type: string nullable: true type: array @@ -17562,6 +17775,7 @@ components: example: - '["def-000-abc"]' items: + description: A rule ID associated with the control. type: string type: array required: @@ -17689,6 +17903,7 @@ components: - name type: object CustomRule: + description: A custom static analysis rule within a ruleset. properties: created_at: description: Creation timestamp @@ -17721,11 +17936,13 @@ components: x-enum-varnames: - CUSTOM_RULE CustomRuleRequest: + description: Request body for creating or updating a custom rule. properties: data: $ref: "#/components/schemas/CustomRuleRequestData" type: object CustomRuleRequestData: + description: Data object for a custom rule create or update request. properties: attributes: $ref: "#/components/schemas/CustomRuleRequestDataAttributes" @@ -17736,12 +17953,14 @@ components: $ref: "#/components/schemas/CustomRuleDataType" type: object CustomRuleRequestDataAttributes: + description: Attributes for creating or updating a custom rule. properties: name: description: Rule name type: string type: object CustomRuleResponse: + description: Response containing a single custom rule. properties: data: $ref: "#/components/schemas/CustomRuleResponseData" @@ -17749,6 +17968,7 @@ components: - data type: object CustomRuleResponseData: + description: Data object returned in a custom rule response, including its ID, type, and attributes. properties: attributes: $ref: "#/components/schemas/CustomRule" @@ -17764,6 +17984,7 @@ components: - attributes type: object CustomRuleRevision: + description: A specific revision of a custom static analysis rule. properties: attributes: $ref: "#/components/schemas/CustomRuleRevisionAttributes" @@ -17779,6 +18000,7 @@ components: - attributes type: object CustomRuleRevisionAttributes: + description: Attributes of a custom rule revision, including code, metadata, and test cases. properties: arguments: description: Rule arguments @@ -17853,6 +18075,7 @@ components: - security - custom items: + description: A tag attached to the rule. type: string type: array tests: @@ -17914,6 +18137,7 @@ components: x-enum-varnames: - CUSTOM_RULE_REVISION CustomRuleRevisionInputAttributes: + description: Input attributes for creating or updating a custom rule revision. properties: arguments: description: Rule arguments @@ -17975,6 +18199,7 @@ components: - security - custom items: + description: A tag attached to the rule. type: string type: array tests: @@ -18006,11 +18231,13 @@ components: - is_testing type: object CustomRuleRevisionRequest: + description: Request body for creating a new custom rule revision. properties: data: $ref: "#/components/schemas/CustomRuleRevisionRequestData" type: object CustomRuleRevisionRequestData: + description: Data object for a custom rule revision create request. properties: attributes: $ref: "#/components/schemas/CustomRuleRevisionInputAttributes" @@ -18021,6 +18248,7 @@ components: $ref: "#/components/schemas/CustomRuleRevisionDataType" type: object CustomRuleRevisionResponse: + description: Response containing a single custom rule revision. properties: data: $ref: "#/components/schemas/CustomRuleRevision" @@ -18028,6 +18256,7 @@ components: - data type: object CustomRuleRevisionTest: + description: A test case associated with a custom rule revision, used to validate rule behavior. properties: annotation_count: description: Expected violation count @@ -18048,13 +18277,16 @@ components: - annotation_count type: object CustomRuleRevisionsResponse: + description: Response containing a paginated list of custom rule revisions. properties: data: + description: List of custom rule revisions. items: $ref: "#/components/schemas/CustomRuleRevision" type: array type: object CustomRuleset: + description: A custom static analysis ruleset containing a set of user-defined rules. properties: attributes: $ref: "#/components/schemas/CustomRulesetAttributes" @@ -18070,6 +18302,7 @@ components: - attributes type: object CustomRulesetAttributes: + description: Attributes of a custom ruleset, including its name, description, and rules. properties: created_at: description: Creation timestamp @@ -18114,11 +18347,13 @@ components: x-enum-varnames: - CUSTOM_RULESET CustomRulesetRequest: + description: Request body for creating or updating a custom ruleset. properties: data: $ref: "#/components/schemas/CustomRulesetRequestData" type: object CustomRulesetRequestData: + description: Data object for a custom ruleset create or update request. properties: attributes: $ref: "#/components/schemas/CustomRulesetRequestDataAttributes" @@ -18129,6 +18364,7 @@ components: $ref: "#/components/schemas/CustomRulesetDataType" type: object CustomRulesetRequestDataAttributes: + description: Attributes for creating or updating a custom ruleset. properties: description: description: Base64-encoded full description @@ -18147,6 +18383,7 @@ components: type: string type: object CustomRulesetResponse: + description: Response containing a single custom ruleset. properties: data: $ref: "#/components/schemas/CustomRuleset" @@ -18484,6 +18721,7 @@ components: description: Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided. example: [shopist] items: + description: A service name impacted by the incident. type: string type: array severity: @@ -18658,6 +18896,7 @@ components: description: Service names impacted by the incident. example: ["shopist"] items: + description: A service name impacted by the incident. type: string type: array severity: @@ -19051,6 +19290,7 @@ components: example: - "" items: + description: A source key for the mapping rule. type: string type: array required: @@ -19421,6 +19661,7 @@ components: example: - "role:94172442-be03-11e9-a77a-3b7612558ac1" items: + description: An access principal identifier formatted as `principal_type:id`. example: "role:94172442-be03-11e9-a77a-3b7612558ac1" type: string type: array @@ -19456,6 +19697,7 @@ components: example: - "role:86245fce-0a4e-11f0-92bd-da7ad0900002" items: + description: An access principal identifier formatted as `principal_type:id`. example: "role:86245fce-0a4e-11f0-92bd-da7ad0900002" type: string type: array @@ -19693,6 +19935,7 @@ components: format: int64 type: integer Degradation: + description: Response object for a single degradation. properties: data: $ref: "#/components/schemas/DegradationData" @@ -19703,8 +19946,10 @@ components: type: array type: object DegradationArray: + description: Response object for a list of degradations. properties: data: + description: A list of degradation data objects. items: $ref: "#/components/schemas/DegradationData" type: array @@ -19719,6 +19964,7 @@ components: - data type: object DegradationData: + description: The data object for a degradation. properties: attributes: $ref: "#/components/schemas/DegradationDataAttributes" @@ -19766,6 +20012,7 @@ components: type: array type: object DegradationDataAttributesComponentsAffectedItems: + description: A component affected by a degradation. properties: id: description: The ID of the component. @@ -19810,6 +20057,7 @@ components: x-enum-varnames: - INCIDENT DegradationDataAttributesUpdatesItems: + description: A status update recorded during a degradation. properties: components_affected: description: The components affected at the time of the update. @@ -19842,6 +20090,7 @@ components: $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" type: object DegradationDataAttributesUpdatesItemsComponentsAffectedItems: + description: A component affected at the time of a degradation update. properties: id: description: Identifier of the component affected at the time of the update. @@ -19873,6 +20122,7 @@ components: description: The status page the degradation belongs to. type: object DegradationDataRelationshipsCreatedByUser: + description: The Datadog user who created the degradation. properties: data: $ref: "#/components/schemas/DegradationDataRelationshipsCreatedByUserData" @@ -19880,6 +20130,7 @@ components: - data type: object DegradationDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the degradation. properties: id: description: The ID of the Datadog user who created the degradation. @@ -19892,6 +20143,7 @@ components: - id type: object DegradationDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the degradation. properties: data: $ref: "#/components/schemas/DegradationDataRelationshipsLastModifiedByUserData" @@ -19899,6 +20151,7 @@ components: - data type: object DegradationDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the degradation. properties: id: description: The ID of the Datadog user who last modified the degradation. @@ -19911,6 +20164,7 @@ components: - id type: object DegradationDataRelationshipsStatusPage: + description: The status page the degradation belongs to. properties: data: $ref: "#/components/schemas/DegradationDataRelationshipsStatusPageData" @@ -19918,6 +20172,7 @@ components: - data type: object DegradationDataRelationshipsStatusPageData: + description: The data object identifying the status page the degradation belongs to. properties: id: description: The ID of the status page. @@ -19931,6 +20186,7 @@ components: - id type: object DegradationIncluded: + description: An included resource related to a degradation or maintenance. oneOf: - $ref: "#/components/schemas/StatusPagesUser" - $ref: "#/components/schemas/StatusPageAsIncluded" @@ -20076,15 +20332,18 @@ components: - data type: object DeletedSuiteResponseData: + description: Data object for a deleted Synthetic test suite. properties: attributes: $ref: "#/components/schemas/DeletedSuiteResponseDataAttributes" id: + description: The public ID of the deleted Synthetic test suite. type: string type: $ref: "#/components/schemas/SyntheticsSuiteTypes" type: object DeletedSuiteResponseDataAttributes: + description: Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID. properties: deleted_at: description: Deletion timestamp of the Synthetic suite ID. @@ -20094,10 +20353,12 @@ components: type: string type: object DeletedSuitesRequestDelete: + description: Data object for a bulk delete Synthetic test suites request. properties: attributes: $ref: "#/components/schemas/DeletedSuitesRequestDeleteAttributes" id: + description: An optional identifier for the delete request. type: string type: $ref: "#/components/schemas/DeletedSuitesRequestType" @@ -20105,19 +20366,24 @@ components: - attributes type: object DeletedSuitesRequestDeleteAttributes: + description: Attributes for a bulk delete Synthetic test suites request. properties: force_delete_dependencies: + description: Whether to force deletion of suites that have dependent resources. type: boolean public_ids: + description: List of public IDs of the Synthetic test suites to delete. example: - "" items: + description: The public ID of a Synthetic test suite to delete. type: string type: array required: - public_ids type: object DeletedSuitesRequestDeleteRequest: + description: Request body for bulk deleting Synthetic test suites. properties: data: $ref: "#/components/schemas/DeletedSuitesRequestDelete" @@ -20126,6 +20392,7 @@ components: type: object DeletedSuitesRequestType: default: delete_suites_request + description: Type for the bulk delete Synthetic suites request, `delete_suites_request`. enum: - delete_suites_request example: delete_suites_request @@ -20133,22 +20400,27 @@ components: x-enum-varnames: - DELETE_SUITES_REQUEST DeletedSuitesResponse: + description: Response containing the list of deleted Synthetic test suites. properties: data: + description: List of deleted Synthetic suite data objects. items: $ref: "#/components/schemas/DeletedSuiteResponseData" type: array type: object DeletedTestResponseData: + description: Data object for a deleted Synthetic test. properties: attributes: $ref: "#/components/schemas/DeletedTestResponseDataAttributes" id: + description: The public ID of the deleted Synthetic test. type: string type: $ref: "#/components/schemas/DeletedTestsResponseType" type: object DeletedTestResponseDataAttributes: + description: Attributes of a deleted Synthetic test, including deletion timestamp and public ID. properties: deleted_at: description: Deletion timestamp of the Synthetic test ID. @@ -20158,10 +20430,12 @@ components: type: string type: object DeletedTestsRequestDelete: + description: Data object for a bulk delete Synthetic tests request. properties: attributes: $ref: "#/components/schemas/DeletedTestsRequestDeleteAttributes" id: + description: An optional identifier for the delete request. type: string type: $ref: "#/components/schemas/DeletedTestsRequestType" @@ -20169,19 +20443,24 @@ components: - attributes type: object DeletedTestsRequestDeleteAttributes: + description: Attributes for a bulk delete Synthetic tests request. properties: force_delete_dependencies: + description: Whether to force deletion of tests that have dependent resources. type: boolean public_ids: + description: List of public IDs of the Synthetic tests to delete. example: - "" items: + description: The public ID of a Synthetic test to delete. type: string type: array required: - public_ids type: object DeletedTestsRequestDeleteRequest: + description: Request body for bulk deleting Synthetic tests. properties: data: $ref: "#/components/schemas/DeletedTestsRequestDelete" @@ -20190,6 +20469,7 @@ components: type: object DeletedTestsRequestType: default: delete_tests_request + description: Type for the bulk delete Synthetic tests request, `delete_tests_request`. enum: - delete_tests_request example: delete_tests_request @@ -20197,14 +20477,17 @@ components: x-enum-varnames: - DELETE_TESTS_REQUEST DeletedTestsResponse: + description: Response containing the list of deleted Synthetic tests. properties: data: + description: List of deleted Synthetic test data objects. items: $ref: "#/components/schemas/DeletedTestResponseData" type: array type: object DeletedTestsResponseType: default: delete_tests + description: Type for the bulk delete Synthetic tests response, `delete_tests`. enum: - delete_tests example: delete_tests @@ -20674,6 +20957,7 @@ components: description: Resources to exclude from faulty deployment detection. example: ["resource1", "resource2"] items: + description: A resource name to exclude from faulty deployment detection. type: string type: array type: object @@ -20951,6 +21235,7 @@ components: description: The list of device tags example: ["device_ip:1.2.3.4", "device_id:example:1.2.3.4"] items: + description: A tag string in `key:value` format. type: string type: array vendor: @@ -21056,6 +21341,7 @@ components: domains: description: The list of domains in the email domain allowlist. items: + description: An email domain in the allowlist. type: string type: array enabled: @@ -21096,6 +21382,7 @@ components: domains: description: The list of domains in the email domain allowlist. items: + description: An email domain in the allowlist. type: string type: array enabled: @@ -21692,6 +21979,7 @@ components: tags: description: The tags. items: + description: A tag string in the format key:value. type: string type: array type: object @@ -21754,8 +22042,10 @@ components: $ref: "#/components/schemas/EntityToSchema" type: object EntityResponseArray: + description: Response object containing an array of entity data items. properties: data: + description: Array of entity response data items. items: $ref: "#/components/schemas/PreviewEntityResponseData" type: array @@ -21768,30 +22058,42 @@ components: $ref: "#/components/schemas/EntityData" type: array EntityResponseDataAttributes: + description: Entity response attributes containing core entity metadata fields. properties: apiVersion: + description: The API version of the entity schema. type: string description: + description: A short description of the entity. type: string displayName: + description: The user-friendly display name of the entity. type: string kind: + description: The kind of the entity (e.g. service, datastore, queue). type: string name: + description: The unique name of the entity within its kind and namespace. type: string namespace: + description: The namespace the entity belongs to. type: string owner: + description: The owner of the entity, usually a team. type: string properties: additionalProperties: {} + description: Additional custom properties for the entity. type: object tags: + description: A set of custom tags assigned to the entity. items: + description: A tag string in the format key:value. type: string type: array type: object EntityResponseDataRelationships: + description: Entity relationships including incidents, oncalls, schemas, and related entities. properties: incidents: $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidents" @@ -21805,15 +22107,19 @@ components: $ref: "#/components/schemas/EntityResponseDataRelationshipsSchema" type: object EntityResponseDataRelationshipsIncidents: + description: Incidents relationship containing a list of incident resources associated with this entity. properties: data: + description: List of incident relationship data items. items: $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems" type: array type: object EntityResponseDataRelationshipsIncidentsDataItems: + description: Incident relationship data item containing the incident resource identifier and type. properties: id: + description: Incident resource unique identifier. example: "" type: string type: @@ -21832,15 +22138,19 @@ components: x-enum-varnames: - INCIDENT EntityResponseDataRelationshipsOncalls: + description: Oncalls relationship containing a list of oncall resources associated with this entity. properties: data: + description: List of oncall relationship data items. items: $ref: "#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems" type: array type: object EntityResponseDataRelationshipsOncallsDataItems: + description: Oncall relationship data item containing the oncall resource identifier and type. properties: id: + description: Oncall resource unique identifier. example: "" type: string type: @@ -21859,6 +22169,7 @@ components: x-enum-varnames: - ONCALL EntityResponseDataRelationshipsRawSchema: + description: Raw schema relationship linking an entity to its raw schema resource. properties: data: $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchemaData" @@ -21866,8 +22177,10 @@ components: - data type: object EntityResponseDataRelationshipsRawSchemaData: + description: Raw schema relationship data containing the raw schema resource identifier and type. properties: id: + description: Raw schema unique identifier. example: "" type: string type: @@ -21886,15 +22199,19 @@ components: x-enum-varnames: - RAWSCHEMA EntityResponseDataRelationshipsRelatedEntities: + description: Related entities relationship containing a list of entity references related to this entity. properties: data: + description: List of related entity relationship data items. items: $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems" type: array type: object EntityResponseDataRelationshipsRelatedEntitiesDataItems: + description: Related entity relationship data item containing the related entity resource identifier and type. properties: id: + description: Related entity unique identifier. example: "" type: string type: @@ -21913,6 +22230,7 @@ components: x-enum-varnames: - RELATEDENTITY EntityResponseDataRelationshipsSchema: + description: Schema relationship linking an entity to its associated schema resource. properties: data: $ref: "#/components/schemas/EntityResponseDataRelationshipsSchemaData" @@ -21920,8 +22238,10 @@ components: - data type: object EntityResponseDataRelationshipsSchemaData: + description: Schema relationship data containing the schema resource identifier and type. properties: id: + description: Entity schema unique identifier. example: "" type: string type: @@ -22240,6 +22560,7 @@ components: implementedBy: description: Services which implemented the API. items: + description: A service entity reference string. type: string type: array interface: @@ -22299,6 +22620,7 @@ components: paths: description: The paths (glob) to the source code of the service. items: + description: A glob pattern path to source code files. type: string type: array repositoryURL: @@ -22380,6 +22702,7 @@ components: tags: description: A list of APM entity tags that associates the APM Stats data with the entity. items: + description: An APM tag string in the format key:value. type: string type: array type: object @@ -22390,6 +22713,7 @@ components: fingerprints: description: A list of CI Fingerprints that associate CI Pipelines with the entity. items: + description: A CI pipeline fingerprint string. type: string type: array type: object @@ -22444,6 +22768,7 @@ components: componentOf: description: A list of components the datastore is a part of items: + description: A component entity reference string. type: string type: array lifecycle: @@ -22525,6 +22850,7 @@ components: description: A set of custom tags. example: [this:tag, that:tag] items: + description: A tag string in the format key:value. type: string type: array required: @@ -22639,6 +22965,7 @@ components: componentOf: description: A list of components the queue is a part of items: + description: A component entity reference string. type: string type: array lifecycle: @@ -22708,16 +23035,19 @@ components: componentOf: description: A list of components the service is a part of items: + description: A component entity reference string. type: string type: array dependsOn: description: A list of components the service depends on. items: + description: A component entity reference string. type: string type: array languages: description: The service's programming language. items: + description: A programming language name. type: string type: array lifecycle: @@ -22785,6 +23115,7 @@ components: components: description: A list of components belongs to the system. items: + description: A component entity reference string. type: string type: array lifecycle: @@ -24212,6 +24543,7 @@ components: type: string type: object FacetInfoRequest: + description: Request body for retrieving facet value information for a specified attribute with optional filtering. example: data: attributes: @@ -24228,10 +24560,12 @@ components: $ref: "#/components/schemas/FacetInfoRequestData" type: object FacetInfoRequestData: + description: The data object containing the resource type and attributes for the facet info request. properties: attributes: $ref: "#/components/schemas/FacetInfoRequestDataAttributes" id: + description: Unique identifier for the facet info request resource. type: string type: $ref: "#/components/schemas/FacetInfoRequestDataType" @@ -24239,11 +24573,14 @@ components: - type type: object FacetInfoRequestDataAttributes: + description: Attributes for the facet info request, specifying which facet to query and optional filters to apply. properties: facet_id: + description: The identifier of the facet attribute to retrieve value information for. example: "" type: string limit: + description: Maximum number of facet values to return in the response. example: 0 format: int64 type: integer @@ -24256,13 +24593,17 @@ components: - limit type: object FacetInfoRequestDataAttributesSearch: + description: Query-based search configuration for filtering the audience context when retrieving facet values. properties: query: + description: The filter expression used to scope the audience from which facet values are retrieved. type: string type: object FacetInfoRequestDataAttributesTermSearch: + description: Term-level search configuration for filtering facet values by an exact or partial term match. properties: value: + description: The term string to match against facet values. type: string type: object FacetInfoRequestDataType: @@ -24275,6 +24616,7 @@ components: x-enum-varnames: - USERS_FACET_INFO_REQUEST FacetInfoResponse: + description: Response containing facet information for an attribute, including its distinct values and occurrence counts. example: data: attributes: @@ -24297,10 +24639,12 @@ components: $ref: "#/components/schemas/FacetInfoResponseData" type: object FacetInfoResponseData: + description: The data object containing the resource type and attributes for the facet info response. properties: attributes: $ref: "#/components/schemas/FacetInfoResponseDataAttributes" id: + description: Unique identifier for the facet info response resource. type: string type: $ref: "#/components/schemas/FacetInfoResponseDataType" @@ -24308,32 +24652,41 @@ components: - type type: object FacetInfoResponseDataAttributes: + description: Attributes of the facet info response, containing the facet result data. properties: result: $ref: "#/components/schemas/FacetInfoResponseDataAttributesResult" type: object FacetInfoResponseDataAttributesResult: + description: The facet query result containing discrete value counts or a numeric range for the requested facet. properties: range: $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultRange" values: + description: List of discrete facet values with their occurrence counts. items: $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems" type: array type: object FacetInfoResponseDataAttributesResultRange: + description: The numeric range of a facet attribute, representing the minimum and maximum observed values. properties: max: + description: The maximum observed value for the numeric facet attribute. type: object min: + description: The minimum observed value for the numeric facet attribute. type: object type: object FacetInfoResponseDataAttributesResultValuesItems: + description: A single facet value with its occurrence count in the dataset. properties: count: + description: The number of records that have this facet value. format: int64 type: integer value: + description: The facet value (for example, a browser name or country code). type: string type: object FacetInfoResponseDataType: @@ -24548,6 +24901,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Fastly service. type: string type: array required: @@ -24562,6 +24916,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Fastly service. type: string type: array type: object @@ -24821,6 +25176,7 @@ components: example: - "@application.id:ABCD" items: + description: A tag-based filter expression using Datadog tag query syntax. example: "@application.id:ABCD" type: string type: array @@ -24884,6 +25240,7 @@ components: description: List of case responses. properties: data: + description: Array of case response data objects. items: $ref: "#/components/schemas/FindingCaseResponseData" type: array @@ -24920,8 +25277,10 @@ components: attributes: additionalProperties: items: + description: A custom attribute value string. type: string type: array + description: Custom attributes associated with the case as key-value pairs where values are string arrays. type: object closed_at: description: Timestamp of when the case was closed. @@ -25001,6 +25360,7 @@ components: description: Project in which the case was created. type: object FindingData: + description: Data object representing a security finding. properties: id: description: Unique identifier of the security finding. @@ -25200,6 +25560,7 @@ components: description: A list of security findings. properties: data: + description: Array of security finding data objects. items: $ref: "#/components/schemas/FindingData" type: array @@ -25230,12 +25591,14 @@ components: description: The name of the test's code owners as inferred from the repository configuration. example: ["@foo", "@bar"] items: + description: A code owner of the test as inferred from the repository configuration. type: string type: array envs: description: List of environments where this test has been flaky. example: prod items: + description: An environment name where this test has been flaky. type: string type: array first_flaked_branch: @@ -25311,6 +25674,7 @@ components: A test service is a group of tests associated with a project or repository. It contains all the individual tests for your code, optionally organized into test suites, which are like folders for your tests. example: ["foo", "bar"] items: + description: A test service name where this test has been flaky. type: string type: array suite: @@ -25577,11 +25941,13 @@ components: enabled_products: description: Datadog products enabled on the agent. items: + description: A Datadog product enabled on the agent. type: string type: array envs: description: Environments the agent is reporting from. items: + description: An environment name the agent is reporting from. type: string type: array first_seen_at: @@ -25595,6 +25961,7 @@ components: ip_addresses: description: IP addresses of the agent. items: + description: An IP address of the agent. type: string type: array is_single_step_instrumentation_enabled: @@ -25614,6 +25981,7 @@ components: otel_collector_versions: description: List of OpenTelemetry collector versions (if applicable). items: + description: An OpenTelemetry collector version string. type: string type: array pod_name: @@ -25630,6 +25998,7 @@ components: services: description: Services running on the agent. items: + description: A service name running on the agent. type: string type: array tags: @@ -25642,10 +26011,13 @@ components: type: string type: object FleetAgentAttributesTagsItems: + description: A key-value pair representing a tag associated with a Datadog Agent. properties: key: + description: The tag key. type: string value: + description: The tag value. type: string type: object FleetAgentInfo: @@ -25708,11 +26080,13 @@ components: enabled_products: description: Datadog products enabled on the agent. items: + description: A Datadog product enabled on the agent. type: string type: array env: description: Environments the agent is reporting from. items: + description: An environment name the agent is reporting from. type: string type: array first_seen_at: @@ -25726,6 +26100,7 @@ components: hostname_aliases: description: Alternative hostname list for the agent. items: + description: An alternative hostname alias for the agent. type: string type: array install_method_installer_version: @@ -25739,6 +26114,7 @@ components: ip_addresses: description: IP addresses of the agent. items: + description: An IP address of the agent. type: string type: array is_single_step_instrumentation_enabled: @@ -25762,6 +26138,7 @@ components: otel_collector_versions: description: List of OpenTelemetry collector versions (if applicable). items: + description: An OpenTelemetry collector version string. type: string type: array otel_collectors: @@ -25779,6 +26156,7 @@ components: region: description: Regions where the agent is running. items: + description: A region where the agent is running. type: string type: array remote_agent_management: @@ -25792,11 +26170,13 @@ components: services: description: Services running on the agent. items: + description: A service name running on the agent. type: string type: array tags: description: Tags associated with the agent. items: + description: A tag string assigned to the agent. type: string type: array team: @@ -25836,6 +26216,7 @@ components: - type type: object FleetAgentVersionAttributes: + description: Attributes of an available Datadog Agent version. properties: version: description: The Agent version string. @@ -25891,6 +26272,7 @@ components: - attributes type: object FleetAgentsResponseDataAttributes: + description: Attributes of the fleet agents response containing the list of agents. properties: agents: description: Array of agents matching the query criteria. @@ -26266,6 +26648,7 @@ components: error_messages: description: Error messages if the integration has issues. items: + description: An error message describing an issue with the integration. type: string type: array init_config: @@ -26501,6 +26884,7 @@ components: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun". example: ["Mon", "Wed", "Fri"] items: + description: A day of the week (for example, "Mon", "Tue"). type: string type: array maintenance_window_duration: @@ -27207,6 +27591,7 @@ components: error_messages: description: The error messages for the Google Cloud Usage Cost config. items: + description: An error message string. type: string nullable: true type: array @@ -27542,6 +27927,7 @@ components: error_messages: description: The `attributes` `error_messages`. items: + description: An error message string. type: string nullable: true type: array @@ -27818,6 +28204,7 @@ components: description: A list of tags associated with the device. example: ["device_ip:1.2.3.4", "device_id:example:1.2.3.4"] items: + description: A tag string in `key:value` format. type: string type: array vendor: @@ -27891,6 +28278,7 @@ components: - CASE - TEAM_OWNERS GetMappingResponse: + description: Response containing the entity attribute mapping configuration including all available attributes and their properties. example: data: attributes: @@ -27931,10 +28319,12 @@ components: $ref: "#/components/schemas/GetMappingResponseData" type: object GetMappingResponseData: + description: The data object containing the resource type and attributes for the get mapping response. properties: attributes: $ref: "#/components/schemas/GetMappingResponseDataAttributes" id: + description: Unique identifier for the get mapping response resource. type: string type: $ref: "#/components/schemas/GetMappingResponseDataType" @@ -27942,27 +28332,37 @@ components: - type type: object GetMappingResponseDataAttributes: + description: Attributes of the get mapping response, containing the list of configured entity attributes. properties: attributes: + description: The list of entity attributes and their mapping configurations. items: $ref: "#/components/schemas/GetMappingResponseDataAttributesAttributesItems" type: array type: object GetMappingResponseDataAttributesAttributesItems: + description: Details of a single entity attribute including its mapping configuration and metadata. properties: attribute: + description: The attribute identifier as used in the entity data model. type: string description: + description: Human-readable explanation of what the attribute represents. type: string display_name: + description: The human-readable label for the attribute shown in the UI. type: string groups: + description: List of group labels used to categorize the attribute. items: + description: A group label name for categorizing the attribute. type: string type: array is_custom: + description: Whether this attribute is a custom user-defined attribute rather than a built-in one. type: boolean type: + description: The data type of the attribute (for example, string or number). type: string type: object GetMappingResponseDataType: @@ -27975,15 +28375,18 @@ components: x-enum-varnames: - GET_MAPPINGS_RESPONSE GetMultipleRulesetsRequest: + description: The request payload for retrieving rules for multiple rulesets in a single batch call. properties: data: $ref: "#/components/schemas/GetMultipleRulesetsRequestData" type: object GetMultipleRulesetsRequestData: + description: The primary data object in the get-multiple-rulesets request, containing request attributes and resource type. properties: attributes: $ref: "#/components/schemas/GetMultipleRulesetsRequestDataAttributes" id: + description: An optional identifier for the get-multiple-rulesets request resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsRequestDataType" @@ -27991,13 +28394,18 @@ components: - type type: object GetMultipleRulesetsRequestDataAttributes: + description: The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include. properties: include_testing_rules: + description: When true, rules that are available in testing mode are included in the response. type: boolean include_tests: + description: When true, test cases associated with each rule are included in the response. type: boolean rulesets: + description: The list of ruleset names to retrieve. items: + description: The name of a ruleset to include in the batch request. type: string type: array type: object @@ -28011,15 +28419,18 @@ components: x-enum-varnames: - GET_MULTIPLE_RULESETS_REQUEST GetMultipleRulesetsResponse: + description: The response payload for the get-multiple-rulesets endpoint, containing the requested rulesets and their rules. properties: data: $ref: "#/components/schemas/GetMultipleRulesetsResponseData" type: object GetMultipleRulesetsResponseData: + description: The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type. properties: attributes: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributes" id: + description: The unique identifier of the get-multiple-rulesets response resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataType" @@ -28027,32 +28438,41 @@ components: - type type: object GetMultipleRulesetsResponseDataAttributes: + description: The attributes of the get-multiple-rulesets response, containing the list of requested rulesets. properties: rulesets: + description: The list of rulesets returned in response to the batch request. items: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItems" type: array type: object GetMultipleRulesetsResponseDataAttributesRulesetsItems: + description: A ruleset returned in the response, containing its metadata and associated rules. properties: data: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData" description: + description: A detailed description of the ruleset's purpose and the types of issues it targets. type: string name: + description: The unique name of the ruleset. type: string rules: + description: The list of static analysis rules included in this ruleset. items: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems" type: array short_description: + description: A brief summary of the ruleset, suitable for display in listings. type: string required: - data type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsData: + description: The resource identifier and type for a ruleset. properties: id: + description: The unique identifier of the ruleset resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType" @@ -28069,76 +28489,106 @@ components: x-enum-varnames: - RULESETS GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems: + description: A static analysis rule within a ruleset, including its definition, metadata, and associated test cases. properties: arguments: + description: The list of configurable arguments accepted by this rule. items: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems" type: array category: + description: The category classifying the type of issue this rule detects (e.g., security, style, performance). type: string checksum: + description: A checksum of the rule definition used to detect changes. type: string code: + description: The rule implementation code used by the static analysis engine. type: string created_at: + description: The date and time when the rule was created. format: date-time type: string created_by: + description: The identifier of the user or system that created the rule. type: string cve: + description: The CVE identifier associated with the vulnerability this rule detects, if applicable. type: string cwe: + description: The CWE identifier associated with the weakness category this rule detects, if applicable. type: string data: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData" description: + description: A detailed explanation of what the rule detects and why it matters. type: string documentation_url: + description: A URL pointing to additional documentation for this rule. type: string entity_checked: + description: The code entity type (e.g., function, class, variable) that this rule inspects. type: string is_published: + description: Indicates whether the rule is publicly published and available to all users. type: boolean is_testing: + description: Indicates whether the rule is in testing mode and not yet promoted to production. type: boolean language: + description: The programming language this rule applies to. type: string last_updated_at: + description: The date and time when the rule was last modified. format: date-time type: string last_updated_by: + description: The identifier of the user or system that last updated the rule. type: string name: + description: The unique name identifying this rule within its ruleset. type: string regex: + description: A regular expression pattern used by the rule for pattern-based detection. type: string severity: + description: The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE). type: string short_description: + description: A brief summary of what the rule detects, suitable for display in listings. type: string should_use_ai_fix: + description: Indicates whether an AI-generated fix suggestion should be offered for findings from this rule. type: boolean tests: + description: The list of test cases used to validate the rule's behavior. items: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems" type: array tree_sitter_query: + description: The Tree-sitter query expression used by the rule to match code patterns in the AST. type: string type: + description: The rule type indicating the detection mechanism used (e.g., tree_sitter, regex). type: string required: - data type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems: + description: An argument parameter for a static analysis rule, with a name and description. properties: description: + description: A human-readable explanation of the argument's purpose and accepted values. type: string name: + description: The name of the rule argument. type: string type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData: + description: The resource identifier and type for a static analysis rule. properties: id: + description: The unique identifier of the rule resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType" @@ -28155,15 +28605,19 @@ components: x-enum-varnames: - RULES GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems: + description: A test case associated with a static analysis rule, containing the source code and expected annotation count. properties: annotation_count: + description: The expected number of annotations (findings) the rule should produce when run against the test code. format: int64 maximum: 65535 minimum: 0 type: integer code: + description: The source code snippet used as input for the rule test. type: string filename: + description: The filename associated with the test code snippet. type: string type: object GetMultipleRulesetsResponseDataType: @@ -28407,6 +28861,7 @@ components: - analytics_dashboard_id type: object GlobalIncidentSettingsDataRequest: + description: Data object in the global incident settings request. properties: attributes: $ref: "#/components/schemas/GlobalIncidentSettingsAttributesRequest" @@ -28416,6 +28871,7 @@ components: - type type: object GlobalIncidentSettingsDataResponse: + description: Data object in the global incident settings response. properties: attributes: $ref: "#/components/schemas/GlobalIncidentSettingsAttributesResponse" @@ -28431,6 +28887,7 @@ components: - attributes type: object GlobalIncidentSettingsRequest: + description: Request payload for updating global incident settings. properties: data: $ref: "#/components/schemas/GlobalIncidentSettingsDataRequest" @@ -28438,6 +28895,7 @@ components: - data type: object GlobalIncidentSettingsResponse: + description: Response payload containing global incident settings. properties: data: $ref: "#/components/schemas/GlobalIncidentSettingsDataResponse" @@ -28472,6 +28930,7 @@ components: - data type: object GlobalVariableJsonPatchRequestData: + description: Data object for a JSON Patch request on a Synthetic global variable. properties: attributes: $ref: "#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes" @@ -28479,6 +28938,7 @@ components: $ref: "#/components/schemas/GlobalVariableJsonPatchType" type: object GlobalVariableJsonPatchRequestDataAttributes: + description: Attributes for a JSON Patch request on a Synthetic global variable. properties: json_patch: description: JSON Patch operations following RFC 6902. @@ -29125,6 +29585,7 @@ components: - value type: object HamrOrgConnectionAttributesRequest: + description: Attributes for a HAMR organization connection request. properties: hamr_status: $ref: "#/components/schemas/HamrOrgConnectionStatus" @@ -29159,6 +29620,7 @@ components: - modified_by type: object HamrOrgConnectionAttributesResponse: + description: Attributes of a HAMR organization connection response. properties: hamr_status: $ref: "#/components/schemas/HamrOrgConnectionStatus" @@ -29198,6 +29660,7 @@ components: - modified_by type: object HamrOrgConnectionDataRequest: + description: Data object for a HAMR organization connection request. properties: attributes: $ref: "#/components/schemas/HamrOrgConnectionAttributesRequest" @@ -29213,6 +29676,7 @@ components: - attributes type: object HamrOrgConnectionDataResponse: + description: Data object for a HAMR organization connection response. properties: attributes: $ref: "#/components/schemas/HamrOrgConnectionAttributesResponse" @@ -29228,6 +29692,7 @@ components: - attributes type: object HamrOrgConnectionRequest: + description: Request payload for creating or updating a HAMR organization connection. properties: data: $ref: "#/components/schemas/HamrOrgConnectionDataRequest" @@ -29235,6 +29700,7 @@ components: - data type: object HamrOrgConnectionResponse: + description: Response payload for a HAMR organization connection. properties: data: $ref: "#/components/schemas/HamrOrgConnectionDataResponse" @@ -29627,6 +30093,7 @@ components: type: array type: object IncidentHandleAttributesFieldsSeverity: + description: Severity level associated with an incident handle. example: SEV-1 type: string IncidentHandleAttributesRequest: @@ -29667,6 +30134,7 @@ components: - modified_at type: object IncidentHandleDataRequest: + description: Data object representing an incident handle in a create or update request. properties: attributes: $ref: "#/components/schemas/IncidentHandleAttributesRequest" @@ -29683,6 +30151,7 @@ components: - attributes type: object IncidentHandleDataResponse: + description: Data object representing an incident handle in a response. properties: attributes: $ref: "#/components/schemas/IncidentHandleAttributesResponse" @@ -29700,6 +30169,7 @@ components: - attributes type: object IncidentHandleIncludedItemResponse: + description: A single included resource item in an incident handle response, which can be a user or an incident type. oneOf: - $ref: "#/components/schemas/IncidentUserData" - $ref: "#/components/schemas/IncidentTypeObject" @@ -29709,6 +30179,7 @@ components: $ref: "#/components/schemas/IncidentHandleIncludedItemResponse" type: array IncidentHandleRelationship: + description: A single relationship object for an incident handle, wrapping the related resource data. properties: data: $ref: "#/components/schemas/IncidentHandleRelationshipData" @@ -29716,6 +30187,7 @@ components: - data type: object IncidentHandleRelationshipData: + description: Relationship data for an incident handle, containing the ID and type of the related resource. properties: id: description: The ID of the related resource @@ -29730,6 +30202,7 @@ components: - type type: object IncidentHandleRelationships: + description: Relationships associated with an incident handle response, including linked users and incident type. nullable: true properties: commander_user: @@ -29746,6 +30219,7 @@ components: - last_modified_by_user type: object IncidentHandleRelationshipsRequest: + description: Relationships to associate with an incident handle in a create or update request. nullable: true properties: commander_user: @@ -29756,6 +30230,7 @@ components: - incident_type type: object IncidentHandleRequest: + description: Request payload for creating or updating a global incident handle. properties: data: $ref: "#/components/schemas/IncidentHandleDataRequest" @@ -29763,6 +30238,7 @@ components: - data type: object IncidentHandleResponse: + description: Response payload for a single incident handle, including the handle data and related resources. properties: data: $ref: "#/components/schemas/IncidentHandleDataResponse" @@ -29780,6 +30256,7 @@ components: x-enum-varnames: - INCIDENTS_HANDLES IncidentHandlesResponse: + description: Response payload for a list of global incident handles, including handle data and related resources. properties: data: $ref: "#/components/schemas/IncidentHandlesResponseData" @@ -29789,6 +30266,7 @@ components: - data type: object IncidentHandlesResponseData: + description: Array of incident handle data objects returned in a list response. items: $ref: "#/components/schemas/IncidentHandleDataResponse" type: array @@ -30565,6 +31043,7 @@ components: description: The value(s) to compare against. Multiple values are `ORed` together. example: ["SEV-1", "SEV-2"] items: + description: A value to compare against the incident field. type: string type: array required: @@ -32451,6 +32930,7 @@ components: - "Category::Kubernetes" - "Category::Log Collection" items: + description: A category associated with the integration. type: string type: array description: @@ -32472,48 +32952,54 @@ components: - installed type: object IntegrationIncident: - description: Incident integration settings + description: Incident integration settings. properties: auto_escalation_query: - description: Query for auto-escalation + description: Query for auto-escalation. type: string default_incident_commander: - description: Default incident commander + description: Default incident commander. type: string enabled: - description: Whether incident integration is enabled + description: Whether incident integration is enabled. type: boolean field_mappings: + description: List of mappings between incident fields and case fields. items: $ref: "#/components/schemas/IntegrationIncidentFieldMappingsItems" type: array incident_type: - description: Incident type + description: Incident type. type: string severity_config: $ref: "#/components/schemas/IntegrationIncidentSeverityConfig" type: object IntegrationIncidentFieldMappingsItems: + description: Mapping between an incident user-defined field and a case field. properties: case_field: + description: The case field to map the incident field value to. type: string incident_user_defined_field_id: + description: The identifier of the incident user-defined field to map from. type: string type: object IntegrationIncidentSeverityConfig: + description: Severity configuration for mapping incident priorities to case priorities. properties: priority_mapping: additionalProperties: type: string + description: Mapping of incident severity values to case priority values. type: object type: object IntegrationJira: - description: Jira integration settings + description: Jira integration settings. properties: auto_creation: $ref: "#/components/schemas/IntegrationJiraAutoCreation" enabled: - description: Whether Jira integration is enabled + description: Whether Jira integration is enabled. type: boolean metadata: $ref: "#/components/schemas/IntegrationJiraMetadata" @@ -32521,34 +33007,46 @@ components: $ref: "#/components/schemas/IntegrationJiraSync" type: object IntegrationJiraAutoCreation: + description: Auto-creation settings for Jira issues from cases. properties: enabled: + description: Whether automatic Jira issue creation is enabled. type: boolean type: object IntegrationJiraMetadata: + description: Metadata for connecting a case management project to a Jira project. properties: account_id: + description: The Jira account identifier. type: string issue_type_id: + description: The Jira issue type identifier to use when creating issues. type: string project_id: + description: The Jira project identifier to associate with this case project. type: string type: object IntegrationJiraSync: + description: Synchronization configuration for Jira integration. properties: enabled: + description: Whether Jira field synchronization is enabled. type: boolean properties: $ref: "#/components/schemas/IntegrationJiraSyncProperties" type: object IntegrationJiraSyncDueDate: + description: Due date synchronization configuration for Jira integration. properties: jira_field_id: + description: The Jira field identifier used to store the due date. type: string sync_type: + description: The type of synchronization to apply for the due date field. type: string type: object IntegrationJiraSyncProperties: + description: Field synchronization properties for Jira integration. properties: assignee: $ref: "#/components/schemas/SyncProperty" @@ -32557,6 +33055,7 @@ components: custom_fields: additionalProperties: $ref: "#/components/schemas/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties" + description: Map of custom field identifiers to their sync configurations. type: object description: $ref: "#/components/schemas/SyncProperty" @@ -32570,8 +33069,10 @@ components: $ref: "#/components/schemas/SyncProperty" type: object IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties: + description: Synchronization configuration for a Jira custom field. properties: sync_type: + description: The type of synchronization to apply for this custom field. type: string value: $ref: "#/components/schemas/AnyValue" @@ -32585,85 +33086,99 @@ components: type: string type: object IntegrationMonitor: - description: Monitor integration settings + description: Monitor integration settings. properties: auto_resolve_enabled: - description: Whether auto-resolve is enabled + description: Whether auto-resolve is enabled. type: boolean case_type_id: - description: Case type ID for monitor integration + description: Case type ID for monitor integration. type: string enabled: - description: Whether monitor integration is enabled + description: Whether monitor integration is enabled. type: boolean handle: - description: Monitor handle + description: Monitor handle. type: string type: object IntegrationOnCall: - description: On-Call integration settings + description: On-Call integration settings. properties: auto_assign_on_call: - description: Whether to auto-assign on-call + description: Whether to auto-assign on-call. type: boolean enabled: - description: Whether On-Call integration is enabled + description: Whether On-Call integration is enabled. type: boolean escalation_queries: + description: List of escalation queries for routing cases to on-call responders. items: $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItems" type: array type: object IntegrationOnCallEscalationQueriesItems: + description: An On-Call escalation query entry used to route cases to on-call responders. properties: enabled: + description: Whether this escalation query is enabled. type: boolean id: + description: Unique identifier of the escalation query. type: string query: + description: The query used to match cases for escalation. type: string target: $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItemsTarget" type: object IntegrationOnCallEscalationQueriesItemsTarget: + description: The target recipient for an On-Call escalation query. properties: dynamic_team_paging: + description: Whether to use dynamic team paging for escalation. type: boolean team_id: + description: The identifier of the team to escalate to. type: string user_id: + description: The identifier of the user to escalate to. type: string type: object IntegrationServiceNow: - description: ServiceNow integration settings + description: ServiceNow integration settings. properties: assignment_group: - description: Assignment group + description: Assignment group. type: string auto_creation: $ref: "#/components/schemas/IntegrationServiceNowAutoCreation" enabled: - description: Whether ServiceNow integration is enabled + description: Whether ServiceNow integration is enabled. type: boolean instance_name: - description: ServiceNow instance name + description: ServiceNow instance name. type: string sync_config: $ref: "#/components/schemas/IntegrationServiceNowSyncConfig" type: object IntegrationServiceNowAutoCreation: + description: Auto-creation settings for ServiceNow incidents from cases. properties: enabled: + description: Whether automatic ServiceNow incident creation is enabled. type: boolean type: object IntegrationServiceNowSyncConfig: + description: Synchronization configuration for ServiceNow integration. properties: enabled: + description: Whether ServiceNow synchronization is enabled. type: boolean properties: $ref: "#/components/schemas/IntegrationServiceNowSyncConfig139772721534496" type: object IntegrationServiceNowSyncConfig139772721534496: + description: Field-level synchronization properties for ServiceNow integration. properties: comments: $ref: "#/components/schemas/SyncProperty" @@ -32673,16 +33188,20 @@ components: $ref: "#/components/schemas/SyncPropertyWithMapping" type: object IntegrationServiceNowSyncConfigPriority: + description: Priority synchronization configuration for ServiceNow integration. properties: impact_mapping: additionalProperties: type: string + description: Mapping of case priority values to ServiceNow impact values. type: object sync_type: + description: The type of synchronization to apply for priority. type: string urgency_mapping: additionalProperties: type: string + description: Mapping of case priority values to ServiceNow urgency values. type: object type: object IntegrationType: @@ -32714,6 +33233,7 @@ components: description: The interface IP addresses example: ["1.1.1.1", "1.1.1.2"] items: + description: An IP address assigned to the interface. type: string type: array mac_address: @@ -34114,6 +34634,7 @@ components: tags: description: Tags for generated signals. items: + description: A tag string in `key:value` format. type: string type: array thirdPartyCases: @@ -34160,6 +34681,7 @@ components: example: - "@sns-cloudtrail-results" items: + description: A notification recipient handle (for example, `@user` or `@channel`). type: string type: array to: @@ -34622,6 +35144,7 @@ components: example: - "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" items: + description: A record ID to delete. type: string type: array required: @@ -34654,6 +35177,7 @@ components: example: - "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" items: + description: A dataset ID to delete. type: string type: array required: @@ -34686,6 +35210,7 @@ components: example: - "3fd6b5e0-8910-4b1c-a7d0-5b84de329012" items: + description: An experiment ID to delete. type: string type: array required: @@ -34718,6 +35243,7 @@ components: example: - "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" items: + description: A project ID to delete. type: string type: array required: @@ -34939,6 +35465,7 @@ components: tags: description: List of tags associated with the metric. items: + description: A tag string in `key:value` format. type: string type: array timestamp_ms: @@ -35011,6 +35538,7 @@ components: tags: description: List of tags associated with the span. items: + description: A tag string in `key:value` format. type: string type: array trace_id: @@ -35537,6 +36065,7 @@ components: additional_names: description: Related library or package names (such as child packages or affected binary paths). items: + description: A related library or package name affected by the vulnerability. example: linux-tools-common type: string type: array @@ -35774,6 +36303,7 @@ components: - data type: object ListConnectionsResponse: + description: Response containing the list of all data source connections configured for an entity. example: data: attributes: @@ -35811,10 +36341,12 @@ components: $ref: "#/components/schemas/ListConnectionsResponseData" type: object ListConnectionsResponseData: + description: The data object containing the resource type and attributes for the list connections response. properties: attributes: $ref: "#/components/schemas/ListConnectionsResponseDataAttributes" id: + description: Unique identifier for the list connections response resource. type: string type: $ref: "#/components/schemas/ListConnectionsResponseDataType" @@ -35822,44 +36354,58 @@ components: - type type: object ListConnectionsResponseDataAttributes: + description: Attributes of the list connections response, containing the collection of data source connections. properties: connections: + description: The list of data source connections configured for the entity. items: $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems" type: array type: object ListConnectionsResponseDataAttributesConnectionsItems: + description: Details of a single data source connection, including its fields, join configuration, and audit metadata. properties: created_at: + description: Timestamp indicating when the connection was created. format: date-time type: string created_by: + description: Identifier of the user who created the connection. type: string fields: + description: List of custom attribute fields imported from the data source. items: $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array id: + description: Unique identifier of the connection. type: string join: $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin" metadata: additionalProperties: type: string + description: Additional key-value metadata associated with the connection. type: object type: + description: The type of data source connection (for example, ref_table). type: string updated_at: + description: Timestamp indicating when the connection was last updated. format: date-time type: string updated_by: + description: Identifier of the user who last updated the connection. type: string type: object ListConnectionsResponseDataAttributesConnectionsItemsJoin: + description: The join configuration describing how the data source is linked to the entity. properties: attribute: + description: The entity attribute used as the join key to link records from the data source. type: string type: + description: The type of join key used (for example, email or user_id). type: string type: object ListConnectionsResponseDataType: @@ -35896,8 +36442,10 @@ components: x-enum-varnames: - LIST_DEPLOYMENT_RULES ListDeploymentRulesResponseDataAttributes: + description: Attributes of the response for listing deployment rules. properties: rules: + description: The list of deployment rules. items: $ref: "#/components/schemas/DeploymentRuleResponseDataAttributes" type: array @@ -36093,6 +36641,7 @@ components: description: Response type for listing notification channels for a user properties: data: + description: Array of notification channel data objects. items: $ref: "#/components/schemas/NotificationChannelData" type: array @@ -36101,6 +36650,7 @@ components: description: Response type for listing notification rules for a user properties: data: + description: Array of notification rule data objects. items: $ref: "#/components/schemas/OnCallNotificationRuleData" type: array @@ -36254,6 +36804,7 @@ components: description: The list of tags example: ["tag:test", "tag:testbis"] items: + description: A tag string in `key:value` format. type: string type: array type: object @@ -37435,6 +37986,7 @@ components: - redirect_url type: object Maintenance: + description: Response object for a single maintenance. properties: data: $ref: "#/components/schemas/MaintenanceData" @@ -37445,8 +37997,10 @@ components: type: array type: object MaintenanceArray: + description: Response object for a list of maintenances. properties: data: + description: A list of maintenance data objects. items: $ref: "#/components/schemas/MaintenanceData" type: array @@ -37461,6 +38015,7 @@ components: - data type: object MaintenanceData: + description: The data object for a maintenance. properties: attributes: $ref: "#/components/schemas/MaintenanceDataAttributes" @@ -37521,6 +38076,7 @@ components: type: array type: object MaintenanceDataAttributesComponentsAffectedItems: + description: A component affected by a maintenance. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -37549,6 +38105,7 @@ components: - IN_PROGRESS - COMPLETED MaintenanceDataAttributesUpdatesItems: + description: An update made to a maintenance. properties: components_affected: description: The components affected at the time of the update. @@ -37586,6 +38143,7 @@ components: type: string type: object MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems: + description: A component affected at the time of a maintenance update. properties: id: description: Identifier of the component affected at the time of the update. @@ -37617,6 +38175,7 @@ components: description: The status page the maintenance belongs to. type: object MaintenanceDataRelationshipsCreatedByUser: + description: The Datadog user who created the maintenance. properties: data: $ref: "#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData" @@ -37624,6 +38183,7 @@ components: - data type: object MaintenanceDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the maintenance. properties: id: description: The ID of the Datadog user who created the maintenance. @@ -37637,6 +38197,7 @@ components: - id type: object MaintenanceDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the maintenance. properties: data: $ref: "#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData" @@ -37644,6 +38205,7 @@ components: - data type: object MaintenanceDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the maintenance. properties: id: description: The ID of the Datadog user who last modified the maintenance. @@ -37657,6 +38219,7 @@ components: - id type: object MaintenanceDataRelationshipsStatusPage: + description: The status page the maintenance belongs to. properties: data: $ref: "#/components/schemas/MaintenanceDataRelationshipsStatusPageData" @@ -37664,6 +38227,7 @@ components: - data type: object MaintenanceDataRelationshipsStatusPageData: + description: The data object identifying the status page associated with a maintenance. properties: id: description: The ID of the status page. @@ -39001,6 +39565,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array table: @@ -39555,6 +40120,7 @@ components: description: Valid values for the tag. example: ["prod", "staging"] items: + description: A valid tag value for the monitor configuration policy. maxLength: 255 type: string type: array @@ -39575,6 +40141,7 @@ components: description: Valid values for the tag. example: ["prod", "staging"] items: + description: A valid tag value for the monitor configuration policy. maxLength: 255 type: string type: array @@ -39756,6 +40323,7 @@ components: A list of tag key:value pairs (e.g. `team:product`). All tags must match (AND semantics). example: [team:product, host:abc] items: + description: A tag key:value pair to match against monitor notifications. maxLength: 255 type: string maxItems: 20 @@ -40145,6 +40713,7 @@ components: description: Available values for the variable. example: ["value1", "value2"] items: + description: An available value for the template variable. minLength: 1 type: string uniqueItems: true @@ -40153,6 +40722,7 @@ components: description: Default values of the template variable. example: ["defaultValue"] items: + description: A default value for the template variable. minLength: 0 type: string uniqueItems: true @@ -40852,6 +41422,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -40924,6 +41495,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["datadog-agent-source"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array key_prefix: @@ -41228,6 +41800,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array region: @@ -41321,6 +41894,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -41446,6 +42020,7 @@ components: description: A list of IDs for components whose output is used as the input for this processor group. example: ["datadog-agent-source"] items: + description: The ID of a component whose output is used as input. type: string type: array processors: @@ -41530,6 +42105,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array tls: @@ -41744,6 +42320,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array routes: @@ -41804,6 +42381,7 @@ components: description: A list of component IDs whose output is used as the input for this component. example: ["metric-tags-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -41849,6 +42427,7 @@ components: description: A list of tag keys. example: ["env", "service", "version"] items: + description: A Datadog tag key to include or exclude. type: string type: array mode: @@ -41924,6 +42503,7 @@ components: description: A list of log field paths to check for duplicates. example: ["log.message", "log.error"] items: + description: A log field path to evaluate for duplicate values. type: string type: array id: @@ -42024,6 +42604,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -42263,6 +42844,7 @@ components: columns: description: List of column names to include from the reference table. If not provided, all columns are included. items: + description: The name of a column to include from the reference table. type: string type: array key_field: @@ -42457,6 +43039,7 @@ components: description: Optional fields used to group the metric series. example: ["service", "env"] items: + description: A log field name used to group the metric series. type: string type: array include: @@ -42554,6 +43137,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["parse-json-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array log_type: @@ -42613,6 +43197,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["datadog-agent-source"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array key_prefix: @@ -42700,6 +43285,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array project: @@ -42807,6 +43393,7 @@ components: description: A list of component IDs whose output is used as the input for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array password_key: @@ -43031,6 +43618,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array key_field: @@ -43191,6 +43779,7 @@ components: description: A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified. example: ["topic1", "topic2"] items: + description: A Kafka topic name to subscribe to. type: string type: array type: @@ -43338,6 +43927,7 @@ components: description: A list of tag keys to include or exclude. example: ["env", "service", "version"] items: + description: A metric tag key to include or exclude based on the action. type: string type: array mode: @@ -43396,6 +43986,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["parse-json-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array license_key_key: @@ -43595,6 +44186,7 @@ components: example: - container items: + description: The name of an OCSF profile to apply to the event. type: string type: array version: @@ -43661,6 +44253,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -43992,6 +44585,7 @@ components: partition_fields: description: A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values. items: + description: The name of a log field used to partition quota enforcement. type: string type: array too_many_buckets_action: @@ -44086,6 +44680,7 @@ components: description: A list of fields used to group log events for merging. example: ["log.user.id", "log.device.id"] items: + description: A log field path used to group events for aggregation. type: string type: array id: @@ -44180,6 +44775,7 @@ components: description: A list of field names to be removed from each log event. example: ["field1", "field2"] items: + description: The name of a field to remove from the log event. type: string type: array id: @@ -44293,6 +44889,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array keepalive: @@ -44369,6 +44966,7 @@ components: description: Optional list of fields to group events by. Each group is sampled independently. example: ["service", "host"] items: + description: A log field name used to group events for independent sampling. type: string minItems: 1 type: array @@ -44561,6 +45159,7 @@ components: description: A list of keywords to match near the sensitive pattern. example: ["ssn", "card", "account"] items: + description: A keyword string that reinforces detection when found near the sensitive pattern. type: string type: array proximity: @@ -44626,6 +45225,7 @@ components: description: Tags assigned to this rule for filtering and classification. example: ["pii", "ccn"] items: + description: A tag string used to classify and filter this sensitive data rule. type: string type: array required: @@ -44694,6 +45294,7 @@ components: example: - "" items: + description: A log field path to include or exclude from sensitive data scanning. type: string type: array required: [fields] @@ -44722,6 +45323,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array region: @@ -44786,6 +45388,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array mode: @@ -45133,6 +45736,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array sourcetype: @@ -45274,6 +45878,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -45367,6 +45972,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array keepalive: @@ -45451,6 +46057,7 @@ components: description: Optional list of fields used to group events before the threshold has been reached. example: ["log.user.id"] items: + description: A log field name used to group events for independent throttling. type: string type: array id: @@ -46866,6 +47473,7 @@ components: type: object PaginationMetaPageType: default: offset_limit + description: The pagination type used for offset-based pagination. enum: - offset_limit example: offset_limit @@ -47033,6 +47641,7 @@ components: type: string type: object PatchComponentRequest: + description: Request object for updating a component. example: data: attributes: @@ -47045,6 +47654,7 @@ components: $ref: "#/components/schemas/PatchComponentRequestData" type: object PatchComponentRequestData: + description: The data object for updating a component. properties: attributes: $ref: "#/components/schemas/PatchComponentRequestDataAttributes" @@ -47074,6 +47684,7 @@ components: type: integer type: object PatchDegradationRequest: + description: Request object for updating a degradation. example: data: attributes: @@ -47089,6 +47700,7 @@ components: $ref: "#/components/schemas/PatchDegradationRequestData" type: object PatchDegradationRequestData: + description: The data object for updating a degradation. properties: attributes: $ref: "#/components/schemas/PatchDegradationRequestDataAttributes" @@ -47128,6 +47740,7 @@ components: type: string type: object PatchDegradationRequestDataAttributesComponentsAffectedItems: + description: A component affected by a degradation. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -47135,6 +47748,7 @@ components: format: uuid type: string name: + description: The name of the component. readOnly: true type: string status: @@ -47174,6 +47788,7 @@ components: - data type: object PatchMaintenanceRequest: + description: Request object for updating a maintenance. example: data: attributes: @@ -47189,6 +47804,7 @@ components: $ref: "#/components/schemas/PatchMaintenanceRequestData" type: object PatchMaintenanceRequestData: + description: The data object for updating a maintenance. properties: attributes: $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributes" @@ -47237,6 +47853,7 @@ components: type: string type: object PatchMaintenanceRequestDataAttributesComponentsAffectedItems: + description: A component affected by a maintenance. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -47311,6 +47928,7 @@ components: $ref: "#/components/schemas/Version" type: object PatchStatusPageRequest: + description: Request object for updating a status page. example: data: attributes: @@ -47330,6 +47948,7 @@ components: $ref: "#/components/schemas/PatchStatusPageRequestData" type: object PatchStatusPageRequestData: + description: The data object for updating a status page. properties: attributes: $ref: "#/components/schemas/PatchStatusPageRequestDataAttributes" @@ -47439,6 +48058,7 @@ components: - "tag_1" - "tag_2" items: + description: A tag associated with the reference table. type: string type: array type: object @@ -47560,6 +48180,7 @@ components: example: - "field_1" items: + description: A field name used as a primary key. type: string type: array required: @@ -47651,6 +48272,7 @@ components: x-enum-varnames: - PERMISSIONS Playlist: + description: A single RUM replay playlist resource returned by create, update, or get operations. properties: data: $ref: "#/components/schemas/PlaylistData" @@ -47658,8 +48280,10 @@ components: - data type: object PlaylistArray: + description: A list of RUM replay playlists returned by a list operation. properties: data: + description: Array of playlist data objects. items: $ref: "#/components/schemas/PlaylistData" type: array @@ -47667,10 +48291,12 @@ components: - data type: object PlaylistData: + description: Data object representing a RUM replay playlist, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/PlaylistDataAttributes" id: + description: Unique identifier of the playlist. type: string type: $ref: "#/components/schemas/PlaylistDataType" @@ -47678,39 +48304,51 @@ components: - type type: object PlaylistDataAttributes: + description: Attributes of a RUM replay playlist, including its name, description, session count, and audit timestamps. properties: created_at: + description: Timestamp when the playlist was created. format: date-time type: string created_by: $ref: "#/components/schemas/PlaylistDataAttributesCreatedBy" description: + description: Optional human-readable description of the playlist's purpose or contents. type: string name: + description: Human-readable name of the playlist. example: My Playlist type: string session_count: + description: Number of replay sessions in the playlist. format: int64 type: integer updated_at: + description: Timestamp when the playlist was last updated. format: date-time type: string required: - name type: object PlaylistDataAttributesCreatedBy: + description: Information about the user who created the playlist. properties: handle: + description: Email handle of the user who created the playlist. example: john.doe@example.com type: string icon: + description: URL or identifier of the user's avatar icon. type: string id: + description: Unique identifier of the user who created the playlist. example: 00000000-0000-0000-0000-000000000001 type: string name: + description: Display name of the user who created the playlist. type: string uuid: + description: UUID of the user who created the playlist. example: 00000000-0000-0000-0000-000000000001 type: string required: @@ -47728,6 +48366,7 @@ components: x-enum-varnames: - RUM_REPLAY_PLAYLIST PlaylistsSession: + description: A single RUM replay session resource as it appears within a playlist context. properties: data: $ref: "#/components/schemas/PlaylistsSessionData" @@ -47735,8 +48374,10 @@ components: - data type: object PlaylistsSessionArray: + description: A list of RUM replay sessions belonging to a playlist. properties: data: + description: Array of playlist session data objects. items: $ref: "#/components/schemas/PlaylistsSessionData" type: array @@ -47744,10 +48385,12 @@ components: - data type: object PlaylistsSessionData: + description: Data object representing a session within a playlist, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/PlaylistsSessionDataAttributes" id: + description: Unique identifier of the RUM replay session. type: string type: $ref: "#/components/schemas/ViewershipHistorySessionDataType" @@ -47755,14 +48398,18 @@ components: - type type: object PlaylistsSessionDataAttributes: + description: Attributes of a session within a playlist, including the session event data and its replay track. properties: session_event: additionalProperties: {} + description: Raw event data associated with the replay session. type: object track: + description: Replay track identifier indicating which recording track the session belongs to. type: string type: object PostmortemAttachmentRequest: + description: Request body for creating a postmortem attachment. properties: data: $ref: "#/components/schemas/PostmortemAttachmentRequestData" @@ -47840,6 +48487,7 @@ components: x-enum-varnames: - MARKDOWN PostmortemTemplateAttributesRequest: + description: Attributes for creating or updating a postmortem template. properties: name: description: The name of the template @@ -47849,6 +48497,7 @@ components: - name type: object PostmortemTemplateAttributesResponse: + description: Attributes of a postmortem template returned in a response. properties: createdAt: description: When the template was created @@ -47870,6 +48519,7 @@ components: - modifiedAt type: object PostmortemTemplateDataRequest: + description: Data object for creating or updating a postmortem template. properties: attributes: $ref: "#/components/schemas/PostmortemTemplateAttributesRequest" @@ -47880,6 +48530,7 @@ components: - attributes type: object PostmortemTemplateDataResponse: + description: Data object for a postmortem template returned in a response. properties: attributes: $ref: "#/components/schemas/PostmortemTemplateAttributesResponse" @@ -47895,6 +48546,7 @@ components: - attributes type: object PostmortemTemplateRequest: + description: Request body for creating or updating a postmortem template. properties: data: $ref: "#/components/schemas/PostmortemTemplateDataRequest" @@ -47902,6 +48554,7 @@ components: - data type: object PostmortemTemplateResponse: + description: Response containing a single postmortem template. properties: data: $ref: "#/components/schemas/PostmortemTemplateDataResponse" @@ -47917,8 +48570,10 @@ components: x-enum-varnames: - POSTMORTEM_TEMPLATE PostmortemTemplatesResponse: + description: Response containing a list of postmortem templates. properties: data: + description: An array of postmortem template data objects. items: $ref: "#/components/schemas/PostmortemTemplateDataResponse" type: array @@ -47949,6 +48604,7 @@ components: description: List of tags to identify this powerpack. example: ["tag:foo1"] items: + description: A tag to identify this powerpack. maxLength: 80 type: string maxItems: 8 @@ -48214,10 +48870,12 @@ components: type: string type: object PreviewEntityResponseData: + description: Entity data returned in a preview response, including attributes, relationships, and type. properties: attributes: $ref: "#/components/schemas/EntityResponseDataAttributes" id: + description: Entity unique identifier. type: string relationships: $ref: "#/components/schemas/EntityResponseDataRelationships" @@ -48327,6 +48985,7 @@ components: indexes: description: Restrict the query to specific indexes. Max 1 entry. items: + description: Index name to restrict the query to. type: string maxItems: 1 type: array @@ -48575,17 +49234,22 @@ components: description: An interval definition in a timeseries response. properties: milliseconds: + description: The duration of each time bucket in milliseconds. format: int64 type: integer start_time: + description: The start of this interval as an epoch timestamp in milliseconds. format: int64 type: integer times: + description: Epoch timestamps (in milliseconds) for each bucket in this interval. items: + description: Epoch timestamp in milliseconds for a time bucket boundary. format: int64 type: integer type: array type: + description: The interval type (e.g., fixed or auto-computed bucket size). type: string type: object ProductAnalyticsOccurrenceFilter: @@ -48641,11 +49305,13 @@ components: description: Metadata for a Product Analytics query response. properties: request_id: + description: Unique identifier for the request, used for multi-step query continuation. type: string status: $ref: "#/components/schemas/ProductAnalyticsResponseMetaStatus" type: object ProductAnalyticsResponseMetaStatus: + description: The execution status of a Product Analytics query. enum: - done - running @@ -48667,12 +49333,15 @@ components: $ref: "#/components/schemas/ProductAnalyticsScalarColumnType" values: description: Column values. - items: {} + items: + description: A single cell value within the column (string for group-by columns, number for metric columns). type: array type: object ProductAnalyticsScalarColumnMeta: + description: Metadata associated with a scalar response column, including optional unit information. properties: unit: + description: Unit definitions for the column values, if applicable. items: $ref: "#/components/schemas/ProductAnalyticsUnit" nullable: true @@ -48696,8 +49365,10 @@ components: $ref: "#/components/schemas/ProductAnalyticsResponseMeta" type: object ProductAnalyticsScalarResponseAttributes: + description: Attributes of a scalar analytics response, containing the result columns. properties: columns: + description: The list of result columns, each containing values and metadata. items: $ref: "#/components/schemas/ProductAnalyticsScalarColumn" type: array @@ -48708,11 +49379,13 @@ components: attributes: $ref: "#/components/schemas/ProductAnalyticsScalarResponseAttributes" id: + description: Unique identifier for this response data object. type: string type: $ref: "#/components/schemas/ProductAnalyticsScalarResponseType" type: object ProductAnalyticsScalarResponseType: + description: The resource type identifier for a scalar analytics response. enum: - scalar_response type: string @@ -48722,13 +49395,17 @@ components: description: A series in a timeseries response. properties: group_tags: + description: The group-by tag values that identify this series. items: + description: A tag value for a group-by facet. type: string type: array query_index: + description: The index of the query that produced this series. format: int64 type: integer unit: + description: Unit definitions for the series values. items: $ref: "#/components/schemas/ProductAnalyticsUnit" type: array @@ -48848,25 +49525,31 @@ components: $ref: "#/components/schemas/ProductAnalyticsResponseMeta" type: object ProductAnalyticsTimeseriesResponseAttributes: + description: Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions. properties: intervals: + description: Interval definitions describing the time buckets used in the response. items: $ref: "#/components/schemas/ProductAnalyticsInterval" type: array series: + description: The list of series, each corresponding to a query or group-by combination. items: $ref: "#/components/schemas/ProductAnalyticsSerie" type: array times: description: Timestamps for each data point (epoch milliseconds). items: + description: Epoch timestamp in milliseconds. format: int64 type: integer type: array values: description: Values for each series at each time point. items: + description: Array of numeric values for a single series across all time points. items: + description: Numeric value at a time point, or null if no data is available. format: double nullable: true type: number @@ -48874,15 +49557,18 @@ components: type: array type: object ProductAnalyticsTimeseriesResponseData: + description: Data object for a timeseries analytics response. properties: attributes: $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes" id: + description: Unique identifier for this response data object. type: string type: $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseType" type: object ProductAnalyticsTimeseriesResponseType: + description: The resource type identifier for a timeseries analytics response. enum: - timeseries_response type: string @@ -48892,29 +49578,35 @@ components: description: A unit definition for metric values. properties: family: + description: The unit family (e.g., time, bytes). example: time type: string id: + description: Numeric identifier for the unit. format: int64 type: integer name: + description: The full name of the unit (e.g., nanosecond). example: nanosecond type: string plural: + description: Plural form of the unit name (e.g., nanoseconds). type: string scale_factor: + description: Conversion factor relative to the base unit of the family. format: double type: number short_name: + description: Abbreviated unit name (e.g., ns). type: string type: object Project: - description: A Project + description: A Project. properties: attributes: $ref: "#/components/schemas/ProjectAttributes" id: - description: The Project's identifier + description: The Project's identifier. example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string relationships: @@ -48927,56 +49619,64 @@ components: - attributes type: object ProjectAttributes: - description: Project attributes + description: Project attributes. properties: columns_config: $ref: "#/components/schemas/ProjectColumnsConfig" enabled_custom_case_types: - description: List of enabled custom case type IDs + description: List of enabled custom case type IDs. items: + description: A custom case type identifier. type: string type: array key: - description: The project's key + description: The project's key. example: CASEM type: string name: - description: Project's name + description: Project's name. example: "Security Investigation" type: string restricted: - description: Whether the project is restricted + description: Whether the project is restricted. type: boolean settings: $ref: "#/components/schemas/ProjectSettings" type: object ProjectColumnsConfig: - description: Project columns configuration + description: Project columns configuration. properties: columns: + description: List of column configurations for the project board view. items: $ref: "#/components/schemas/ProjectColumnsConfigColumnsItems" type: array type: object ProjectColumnsConfigColumnsItems: + description: Configuration for a single column in a project board view. properties: sort: $ref: "#/components/schemas/ProjectColumnsConfigColumnsItemsSort" sort_field: + description: The field used to sort items in this column. type: string type: + description: The type of column. type: string type: object ProjectColumnsConfigColumnsItemsSort: + description: Sort configuration for a project board column. properties: ascending: + description: Whether to sort in ascending order. type: boolean priority: + description: The sort priority order for this column. format: int64 type: integer type: object ProjectCreate: - description: Project create + description: Project create. properties: attributes: $ref: "#/components/schemas/ProjectCreateAttributes" @@ -48987,30 +49687,31 @@ components: - type type: object ProjectCreateAttributes: - description: Project creation attributes + description: Project creation attributes. properties: enabled_custom_case_types: - description: List of enabled custom case type IDs + description: List of enabled custom case type IDs. items: + description: A custom case type identifier. type: string type: array key: - description: Project's key. Cannot be "CASE" + description: Project's key. Cannot be "CASE". example: "SEC" type: string name: - description: Project name + description: Project name. example: "Security Investigation" type: string team_uuid: - description: Team UUID to associate with the project + description: Team UUID to associate with the project. type: string required: - name - key type: object ProjectCreateRequest: - description: Project create request + description: Project create request. properties: data: $ref: "#/components/schemas/ProjectCreate" @@ -49018,33 +49719,41 @@ components: - data type: object ProjectNotificationSettings: - description: Project notification settings + description: Project notification settings. properties: destinations: - description: Notification destinations (1=email, 2=slack, 3=in-app) + description: Notification destinations (1=email, 2=slack, 3=in-app). items: + description: Notification channel identifier (1=email, 2=slack, 3=in-app). type: integer type: array enabled: - description: Whether notifications are enabled + description: Whether notifications are enabled. type: boolean notify_on_case_assignment: + description: Whether to send a notification when a case is assigned. type: boolean notify_on_case_closed: + description: Whether to send a notification when a case is closed. type: boolean notify_on_case_comment: + description: Whether to send a notification when a comment is added to a case. type: boolean notify_on_case_comment_mention: + description: Whether to send a notification when a user is mentioned in a case comment. type: boolean notify_on_case_priority_change: + description: Whether to send a notification when a case's priority changes. type: boolean notify_on_case_status_change: + description: Whether to send a notification when a case's status changes. type: boolean notify_on_case_unassignment: + description: Whether to send a notification when a case is unassigned. type: boolean type: object ProjectRelationship: - description: Relationship to project + description: Relationship to project. properties: data: $ref: "#/components/schemas/ProjectRelationshipData" @@ -49052,10 +49761,10 @@ components: - data type: object ProjectRelationshipData: - description: Relationship to project object + description: Relationship to project object. properties: id: - description: A unique identifier that represents the project + description: A unique identifier that represents the project. example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" type: string type: @@ -49065,7 +49774,7 @@ components: - type type: object ProjectRelationships: - description: Project relationships + description: Project relationships. properties: member_team: $ref: "#/components/schemas/RelationshipToTeamLinks" @@ -49074,7 +49783,7 @@ components: type: object ProjectResourceType: default: project - description: Project resource type + description: Project resource type. enum: - project example: project @@ -49082,13 +49791,13 @@ components: x-enum-varnames: - PROJECT ProjectResponse: - description: Project response + description: Project response. properties: data: $ref: "#/components/schemas/Project" type: object ProjectSettings: - description: Project settings + description: Project settings. properties: auto_close_inactive_cases: $ref: "#/components/schemas/AutoCloseInactiveCases" @@ -49108,7 +49817,7 @@ components: $ref: "#/components/schemas/ProjectNotificationSettings" type: object ProjectUpdate: - description: Project update + description: Project update. properties: attributes: $ref: "#/components/schemas/ProjectUpdateAttributes" @@ -49118,26 +49827,27 @@ components: - type type: object ProjectUpdateAttributes: - description: Project update attributes + description: Project update attributes. properties: columns_config: $ref: "#/components/schemas/ProjectColumnsConfig" enabled_custom_case_types: - description: List of enabled custom case type IDs + description: List of enabled custom case type IDs. items: + description: A custom case type identifier. type: string type: array name: - description: Project name + description: Project name. type: string settings: $ref: "#/components/schemas/ProjectSettings" team_uuid: - description: Team UUID to associate with the project + description: Team UUID to associate with the project. type: string type: object ProjectUpdateRequest: - description: Project update request + description: Project update request. properties: data: $ref: "#/components/schemas/ProjectUpdate" @@ -49206,10 +49916,10 @@ components: x-enum-varnames: - PROJECt_COST ProjectsResponse: - description: Response with projects + description: Response with projects. properties: data: - description: Projects response data + description: Projects response data. items: $ref: "#/components/schemas/Project" type: array @@ -49258,6 +49968,7 @@ components: - $ref: "#/components/schemas/DataTransform" - $ref: "#/components/schemas/StateVariable" QueryAccountRequest: + description: Request body for querying accounts with optional filtering, column selection, and sorting. example: data: attributes: @@ -49283,10 +49994,12 @@ components: $ref: "#/components/schemas/QueryAccountRequestData" type: object QueryAccountRequestData: + description: The data object containing the resource type and attributes for querying accounts. properties: attributes: $ref: "#/components/schemas/QueryAccountRequestDataAttributes" id: + description: Unique identifier for the query account request resource. type: string type: $ref: "#/components/schemas/QueryAccountRequestDataType" @@ -49294,26 +50007,35 @@ components: - type type: object QueryAccountRequestDataAttributes: + description: Attributes for filtering and shaping the account query results. properties: limit: + description: Maximum number of account records to return in the response. format: int64 type: integer query: + description: Filter expression using account attribute conditions to narrow results. type: string select_columns: + description: List of account attribute column names to include in the response. items: + description: Name of an account attribute column to include in the response. type: string type: array sort: $ref: "#/components/schemas/QueryAccountRequestDataAttributesSort" wildcard_search_term: + description: Free-text term used for wildcard search across account attribute values. type: string type: object QueryAccountRequestDataAttributesSort: + description: Sorting configuration specifying the field and direction for ordering query results. properties: field: + description: The attribute field name to sort results by. type: string order: + description: The sort direction, either ascending or descending. type: string type: object QueryAccountRequestDataType: @@ -49326,6 +50048,7 @@ components: x-enum-varnames: - QUERY_ACCOUNT_REQUEST QueryEventFilteredUsersRequest: + description: Request body for querying users filtered by user properties combined with event platform activity. example: data: attributes: @@ -49353,10 +50076,12 @@ components: $ref: "#/components/schemas/QueryEventFilteredUsersRequestData" type: object QueryEventFilteredUsersRequestData: + description: The data object containing the resource type and attributes for querying event-filtered users. properties: attributes: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributes" id: + description: Unique identifier for the query event filtered users request resource. type: string type: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataType" @@ -49364,34 +50089,45 @@ components: - type type: object QueryEventFilteredUsersRequestDataAttributes: + description: Attributes for filtering users by both user properties and event platform activity. properties: event_query: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery" include_row_count: + description: Whether to include the total count of matching users in the response. type: boolean limit: + description: Maximum number of user records to return in the response. format: int64 type: integer query: + description: Filter expression using user attribute conditions to narrow results. type: string select_columns: + description: List of user attribute column names to include in the response. items: + description: Name of a user attribute column to include in the response. type: string type: array type: object QueryEventFilteredUsersRequestDataAttributesEventQuery: + description: Event platform query used to filter users based on their event activity within a specified time window. properties: query: + description: The event platform query expression for filtering users by their event activity. type: string time_frame: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame" type: object QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame: + description: The time window defining the start and end of the event query period as Unix timestamps. properties: end: + description: End of the time frame as a Unix timestamp in seconds. format: int64 type: integer start: + description: Start of the time frame as a Unix timestamp in seconds. format: int64 type: integer type: object @@ -49417,6 +50153,7 @@ components: - formula type: object QueryResponse: + description: Response containing the query results with matched records and total count. example: data: attributes: @@ -49462,10 +50199,12 @@ components: $ref: "#/components/schemas/QueryResponseData" type: object QueryResponseData: + description: The data object containing the resource type and attributes of the query response. properties: attributes: $ref: "#/components/schemas/QueryResponseDataAttributes" id: + description: Unique identifier for the query response resource. type: string type: $ref: "#/components/schemas/QueryResponseDataType" @@ -49473,12 +50212,16 @@ components: - type type: object QueryResponseDataAttributes: + description: Attributes of the query response, containing the matched records and total count. properties: hits: + description: The list of matching records returned by the query, each as a map of attribute names to values. items: additionalProperties: {} + description: A single matched record represented as a map of attribute names to their values. type: array total: + description: Total number of records matching the query, regardless of the limit applied. format: int64 type: integer type: object @@ -49502,6 +50245,7 @@ components: - ASC - DESC QueryUsersRequest: + description: Request body for querying users with optional filtering, column selection, and sorting. example: data: attributes: @@ -49527,10 +50271,12 @@ components: $ref: "#/components/schemas/QueryUsersRequestData" type: object QueryUsersRequestData: + description: The data object containing the resource type and attributes for querying users. properties: attributes: $ref: "#/components/schemas/QueryUsersRequestDataAttributes" id: + description: Unique identifier for the query users request resource. type: string type: $ref: "#/components/schemas/QueryUsersRequestDataType" @@ -49538,26 +50284,35 @@ components: - type type: object QueryUsersRequestDataAttributes: + description: Attributes for filtering and shaping the user query results. properties: limit: + description: Maximum number of user records to return in the response. format: int64 type: integer query: + description: Filter expression using user attribute conditions to narrow results. type: string select_columns: + description: List of user attribute column names to include in the response. items: + description: Name of a user attribute column to include in the response. type: string type: array sort: $ref: "#/components/schemas/QueryUsersRequestDataAttributesSort" wildcard_search_term: + description: Free-text term used for wildcard search across user attribute values. type: string type: object QueryUsersRequestDataAttributesSort: + description: Sorting configuration specifying the field and direction for ordering user query results. properties: field: + description: The user attribute field name to sort results by. type: string order: + description: The sort direction, either ascending or descending. type: string type: object QueryUsersRequestDataType: @@ -50383,6 +51138,7 @@ components: description: Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components. properties: confidence_level: + description: The confidence level of the recommendation, expressed as a value between 0.0 (low confidence) and 1.0 (high confidence). format: double type: number driver: @@ -51270,15 +52026,18 @@ components: x-enum-varnames: - RULESET ResolveVulnerableSymbolsRequest: + description: The top-level request object for resolving vulnerable symbols in a set of packages. properties: data: $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestData" type: object ResolveVulnerableSymbolsRequestData: + description: The data object in a request to resolve vulnerable symbols, containing the package PURLs and request type. properties: attributes: $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataAttributes" id: + description: An optional identifier for this request data object. type: string type: $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataType" @@ -51286,14 +52045,18 @@ components: - type type: object ResolveVulnerableSymbolsRequestDataAttributes: + description: The attributes of a request to resolve vulnerable symbols, containing the list of package PURLs to check. properties: purls: + description: The list of Package URLs (PURLs) for which to resolve vulnerable symbols. items: + description: A Package URL (PURL) identifying a specific package and version. type: string type: array type: object ResolveVulnerableSymbolsRequestDataType: default: resolve-vulnerable-symbols-request + description: The type identifier for requests to resolve vulnerable symbols. enum: - resolve-vulnerable-symbols-request example: resolve-vulnerable-symbols-request @@ -51301,15 +52064,18 @@ components: x-enum-varnames: - RESOLVE_VULNERABLE_SYMBOLS_REQUEST ResolveVulnerableSymbolsResponse: + description: The top-level response object returned when resolving vulnerable symbols for a set of packages. properties: data: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseData" type: object ResolveVulnerableSymbolsResponseData: + description: The data object in a response for resolving vulnerable symbols, containing the result attributes and response type. properties: attributes: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataAttributes" id: + description: The unique identifier for this response data object. type: string type: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataType" @@ -51317,14 +52083,17 @@ components: - type type: object ResolveVulnerableSymbolsResponseDataAttributes: + description: The attributes of a response containing resolved vulnerable symbols, organized by package. properties: results: + description: The list of resolved vulnerable symbol results, one entry per queried package. items: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResults" type: array type: object ResolveVulnerableSymbolsResponseDataType: default: resolve-vulnerable-symbols-response + description: The type identifier for responses containing resolved vulnerable symbols. enum: - resolve-vulnerable-symbols-response example: resolve-vulnerable-symbols-response @@ -51332,30 +52101,40 @@ components: x-enum-varnames: - RESOLVE_VULNERABLE_SYMBOLS_RESPONSE ResolveVulnerableSymbolsResponseResults: + description: The result of resolving vulnerable symbols for a specific package, identified by its PURL. properties: purl: + description: The Package URL (PURL) uniquely identifying the package for which vulnerable symbols are resolved. type: string vulnerable_symbols: + description: The list of vulnerable symbol groups found in this package, organized by advisory. items: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols" type: array type: object ResolveVulnerableSymbolsResponseResultsVulnerableSymbols: + description: A collection of vulnerable symbols associated with a specific security advisory. properties: advisory_id: + description: The identifier of the security advisory that describes the vulnerability. type: string symbols: + description: The list of symbols that are vulnerable according to this advisory. items: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols" type: array type: object ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols: + description: A symbol identified as vulnerable within a dependency, including its name, type, and value. properties: name: + description: The name of the vulnerable symbol. type: string type: + description: The type classification of the vulnerable symbol (e.g., function, class, variable). type: string value: + description: The value or identifier associated with the vulnerable symbol. type: string type: object ResourceFilterAttributes: @@ -52015,11 +52794,13 @@ components: x-enum-varnames: - REVERT_CUSTOM_RULE_REVISION_REQUEST RevertCustomRuleRevisionRequest: + description: Request body for reverting a custom rule to a previous revision. properties: data: $ref: "#/components/schemas/RevertCustomRuleRevisionRequestData" type: object RevertCustomRuleRevisionRequestData: + description: Data object for a request to revert a custom rule to a previous revision. properties: attributes: $ref: "#/components/schemas/RevertCustomRuleRevisionRequestDataAttributes" @@ -52030,6 +52811,7 @@ components: $ref: "#/components/schemas/RevertCustomRuleRevisionDataType" type: object RevertCustomRuleRevisionRequestDataAttributes: + description: Attributes specifying the current and target revision IDs for a revert operation. properties: currentRevision: description: Current revision ID @@ -52076,6 +52858,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array user_count: @@ -52108,6 +52891,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array required: @@ -52144,6 +52928,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array required: @@ -52273,6 +53058,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array user_count: @@ -53029,6 +53815,7 @@ components: example: - "" items: + description: A source key for the reference table lookup. type: string type: array table_name: @@ -53710,6 +54497,7 @@ components: dependsOn: description: The components that are dependencies of the ref component. items: + description: A package URL (purl) identifying a dependency of the component. example: pkg:golang/google.golang.org/grpc@1.68.1 type: string required: @@ -53941,15 +54729,18 @@ components: type: string type: object ScaRequest: + description: The top-level request object for submitting a Software Composition Analysis (SCA) scan result. properties: data: $ref: "#/components/schemas/ScaRequestData" type: object ScaRequestData: + description: The data object in an SCA request, containing the dependency graph attributes and request type. properties: attributes: $ref: "#/components/schemas/ScaRequestDataAttributes" id: + description: An optional identifier for this SCA request data object. type: string type: $ref: "#/components/schemas/ScaRequestDataType" @@ -53957,85 +54748,115 @@ components: - type type: object ScaRequestDataAttributes: + description: The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context. properties: commit: $ref: "#/components/schemas/ScaRequestDataAttributesCommit" dependencies: + description: The list of dependencies discovered in the repository. items: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItems" type: array env: + description: The environment context in which the SCA scan was performed (e.g., production, staging). type: string files: + description: The list of dependency manifest files found in the repository. items: $ref: "#/components/schemas/ScaRequestDataAttributesFilesItems" type: array relations: + description: The dependency relations describing the inter-component dependency graph. items: $ref: "#/components/schemas/ScaRequestDataAttributesRelationsItems" type: array repository: $ref: "#/components/schemas/ScaRequestDataAttributesRepository" service: + description: The name of the service or application being analyzed. type: string tags: additionalProperties: type: string + description: A map of key-value tags providing additional metadata for the SCA scan. type: object vulnerabilities: + description: The list of vulnerabilities identified in the dependency graph. items: $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems" type: array type: object ScaRequestDataAttributesCommit: + description: Metadata about the commit associated with the SCA scan, including author, committer, and branch information. properties: author_date: + description: The date when the commit was authored. type: string author_email: + description: The email address of the commit author. type: string author_name: + description: The full name of the commit author. type: string branch: + description: The branch name on which the commit was made. type: string committer_email: + description: The email address of the person who committed the change. type: string committer_name: + description: The full name of the person who committed the change. type: string sha: + description: The SHA hash uniquely identifying the commit. type: string type: object ScaRequestDataAttributesDependenciesItems: + description: A dependency found in the repository, including its identity, location, and reachability metadata. properties: exclusions: + description: A list of patterns or identifiers that should be excluded from analysis for this dependency. items: + description: An exclusion pattern or identifier. type: string type: array group: + description: The group or organization namespace of the dependency (e.g., Maven group ID). type: string is_dev: + description: Indicates whether this is a development-only dependency not used in production. type: boolean is_direct: + description: Indicates whether this is a direct dependency (as opposed to a transitive one). type: boolean language: + description: The programming language ecosystem of this dependency (e.g., java, python, javascript). type: string locations: + description: The list of source file locations where this dependency is declared. items: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems" type: array name: + description: The name of the dependency package. type: string package_manager: + description: The package manager responsible for this dependency (e.g., maven, pip, npm). type: string purl: + description: The Package URL (PURL) uniquely identifying this dependency. type: string reachable_symbol_properties: + description: Properties describing symbols from this dependency that are reachable in the application code. items: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems" type: array version: + description: The version of the dependency. type: string type: object ScaRequestDataAttributesDependenciesItemsLocationsItems: + description: The source code location where a dependency is declared, including block, name, namespace, and version positions within the file. properties: block: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" @@ -54047,71 +54868,95 @@ components: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" type: object ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition: + description: A range within a file defined by a start and end position, along with the file name. properties: end: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition" file_name: + description: The name or path of the file containing this location. type: string start: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition" type: object ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition: + description: A specific position (line and column) within a source file. properties: col: + description: The column number of the position within the line. format: int32 maximum: 2147483647 type: integer line: + description: The line number of the position within the file. format: int32 maximum: 2147483647 type: integer type: object ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems: + description: A key-value property describing a reachable symbol within a dependency. properties: name: + description: The name of the reachable symbol property. type: string value: + description: The value of the reachable symbol property. type: string type: object ScaRequestDataAttributesFilesItems: + description: A file entry in the repository associated with a dependency manifest. properties: name: + description: The name or path of the file within the repository. type: string purl: + description: The Package URL (PURL) associated with the dependency declared in this file. type: string type: object ScaRequestDataAttributesRelationsItems: + description: A dependency relation describing which other components a given component depends on. properties: depends_on: + description: The list of BOM references that this component directly depends on. items: + description: A BOM reference of a dependency. type: string type: array ref: + description: The BOM reference of the component that has dependencies. type: string type: object ScaRequestDataAttributesRepository: + description: Information about the source code repository being analyzed. properties: url: + description: The URL of the repository. type: string type: object ScaRequestDataAttributesVulnerabilitiesItems: + description: A vulnerability entry from the Software Bill of Materials (SBOM), describing a known security issue and the components it affects. properties: affects: + description: The list of components affected by this vulnerability. items: $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems" type: array bom_ref: + description: The unique BOM reference identifier for this vulnerability entry. type: string id: + description: The vulnerability identifier (e.g., CVE ID or similar). type: string type: object ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems: + description: A reference to a component affected by a vulnerability. properties: ref: + description: The BOM reference identifying the affected component. type: string type: object ScaRequestDataType: default: scarequests + description: The type identifier for SCA dependency analysis requests. enum: - scarequests example: scarequests @@ -54311,6 +55156,7 @@ components: example: - production items: + description: An origin identifier for the last successful scan of the asset. example: production type: string type: array @@ -54959,6 +55805,7 @@ components: x-enum-varnames: - SEAT_ASSIGNMENTS SeatUserData: + description: A seat user resource object containing its ID, type, and associated attributes. properties: attributes: $ref: "#/components/schemas/SeatUserDataAttributes" @@ -54972,6 +55819,7 @@ components: $ref: "#/components/schemas/SeatUserDataType" type: object SeatUserDataArray: + description: A paginated list of seat user resources with associated pagination metadata. properties: data: description: The list of seat users. @@ -54983,6 +55831,7 @@ components: description: The metadata of the seat users. type: object SeatUserDataAttributes: + description: Attributes of a user assigned to a seat, including their email, name, and assignment timestamp. properties: assigned_at: description: The date and time the seat was assigned. @@ -55011,6 +55860,7 @@ components: x-enum-varnames: - SEAT_USERS SeatUserMeta: + description: Pagination metadata for the seat users list response. properties: cursor: description: The cursor for the seat users. @@ -55024,8 +55874,10 @@ components: type: string type: object SecretRuleArray: + description: A collection of secret detection rules returned by the list endpoint. properties: data: + description: The list of secret detection rules. items: $ref: "#/components/schemas/SecretRuleData" type: array @@ -55033,10 +55885,12 @@ components: - data type: object SecretRuleData: + description: The data object representing a secret detection rule, including its attributes and resource type. properties: attributes: $ref: "#/components/schemas/SecretRuleDataAttributes" id: + description: The unique identifier of the secret rule resource. type: string type: $ref: "#/components/schemas/SecretRuleDataType" @@ -55044,81 +55898,108 @@ components: - type type: object SecretRuleDataAttributes: + description: The attributes of a secret detection rule, including its pattern, priority, and validation configuration. properties: default_included_keywords: + description: A list of keywords that are included by default when scanning for secrets matching this rule. items: + description: A keyword used to narrow down secret detection to relevant contexts. type: string type: array description: + description: A detailed explanation of what type of secret this rule detects. type: string license: + description: The license under which this secret rule is distributed. type: string match_validation: $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidation" name: + description: The unique name of the secret detection rule. type: string pattern: + description: The regular expression pattern used to identify potential secrets in source code or configuration. type: string priority: + description: The priority level of this rule, used to rank findings when multiple rules match. type: string sds_id: + description: The identifier of the corresponding Sensitive Data Scanner rule, if one exists. type: string validators: + description: A list of validator identifiers used to further confirm a detected secret is genuine. items: + description: A validator identifier applied to refine secret detection accuracy. type: string type: array type: object SecretRuleDataAttributesMatchValidation: + description: Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response. properties: endpoint: + description: The URL endpoint to call when validating a detected secret. type: string hosts: + description: The list of hostnames to include when performing secret match validation. items: + description: A hostname used during match validation. type: string type: array http_method: + description: The HTTP method (e.g., GET, POST) to use when making the validation request. type: string invalid_http_status_code: + description: The HTTP status code ranges that indicate the detected secret is invalid or inactive. items: $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems" type: array request_headers: additionalProperties: type: string + description: A map of HTTP header names to values to include in the validation request. type: object timeout_seconds: + description: The maximum number of seconds to wait for a response during validation before timing out. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: + description: The type of match validation to perform (e.g., http). type: string valid_http_status_code: + description: The HTTP status code ranges that indicate the detected secret is valid and active. items: $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems" type: array type: object SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems: + description: An HTTP status code range that indicates an invalid (unsuccessful) secret match during validation. properties: end: + description: The inclusive upper bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer start: + description: The inclusive lower bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: object SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems: + description: An HTTP status code range that indicates a valid (successful) secret match during validation. properties: end: + description: The inclusive upper bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer start: + description: The inclusive lower bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 @@ -55179,18 +56060,21 @@ components: description: Environment tags associated with the entity example: ["production", "us-east-1"] items: + description: An environment tag associated with the entity. type: string type: array mitreTactics: description: MITRE ATT&CK tactics detected example: ["Credential Access", "Privilege Escalation"] items: + description: Detected MITRE ATT&CK tactic type: string type: array mitreTechniques: description: MITRE ATT&CK techniques detected example: ["T1078", "T1098"] items: + description: Detected MITRE ATT&CK technique type: string type: array projectID: @@ -55201,12 +56085,14 @@ components: description: Services associated with the entity example: ["api-gateway", "lambda"] items: + description: A service name associated with the entity. type: string type: array sources: description: Data sources that detected this entity example: ["cloudtrail", "cloud-security-posture-management"] items: + description: A data source identifier. type: string type: array subscriptionID: @@ -55255,12 +56141,14 @@ components: description: Cloud providers associated with the entity example: ["aws"] items: + description: A cloud provider name. type: string type: array entityRoles: description: Roles associated with the entity example: ["Admin", "Developer"] items: + description: A role assigned to the entity. type: string type: array entityType: @@ -55368,6 +56256,7 @@ components: description: Response containing a list of entity risk scores properties: data: + description: Array of entity risk score objects. items: $ref: "#/components/schemas/SecurityEntityRiskScore" type: array @@ -55612,6 +56501,7 @@ components: - "team:platform" - "env:prod" items: + description: A tag associated with the security finding. type: string type: array timestamp: @@ -55923,6 +56813,7 @@ components: - team:database - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array update_author_id: @@ -55967,6 +56858,7 @@ components: - team:database - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array required: @@ -56055,6 +56947,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array version: @@ -56234,6 +57127,7 @@ components: - def-000-u7q - def-000-7dd items: + description: A rule ID to include in the bulk export. type: string minItems: 1 type: array @@ -56805,6 +57699,7 @@ components: results: description: "Assert results are returned in the same order as the rule query payloads.\nFor each payload, it returns True if the result matched the expected result,\nFalse otherwise." items: + description: Whether the rule query result matched the expected result. type: boolean type: array type: object @@ -58118,6 +59013,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array update_date: @@ -58176,6 +59072,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array required: @@ -58293,6 +59190,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array version: @@ -58840,6 +59738,7 @@ components: The number of keywords in the list must be less than or equal to 30. example: ["email", "address", "login"] items: + description: A keyword to match within the defined proximity of the detected pattern. type: string type: array use_recommended_keywords: @@ -58941,6 +59840,7 @@ components: description: Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array. example: ["admin.name"] items: + description: An attribute path to exclude from the scan. type: string type: array included_keyword_configuration: @@ -58957,6 +59857,7 @@ components: If both are missing the whole event is scanned. example: ["admin"] items: + description: An attribute path to include in the scan. type: string type: array pattern: @@ -58973,6 +59874,7 @@ components: tags: description: List of tags. items: + description: A tag associated with the rule. type: string type: array text_replacement: @@ -59130,6 +60032,7 @@ components: included_keywords: description: List of included keywords. items: + description: A keyword used to increase match precision for the standard pattern. type: string type: array name: @@ -59148,6 +60051,7 @@ components: tags: description: List of tags. items: + description: A tag associated with the standard pattern. type: string type: array type: object @@ -59197,18 +60101,21 @@ components: description: List of strings to use for suppression of matches ending with these strings. example: ["@example.com", "another.example.com"] items: + description: A string suffix; matches ending with this value are suppressed. type: string type: array exact_match: description: List of strings to use for suppression of matches exactly matching these strings. example: ["admin@example.com", "user@example.com"] items: + description: A string value; matches exactly equal to this value are suppressed. type: string type: array starts_with: description: List of strings to use for suppression of matches starting with these strings. example: ["admin", "user"] items: + description: A string prefix; matches starting with this value are suppressed. type: string type: array type: object @@ -59425,6 +60332,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array required: @@ -59581,6 +60489,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array team: @@ -59658,6 +60567,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array team: @@ -59844,6 +60754,7 @@ components: description: A set of CI fingerprints. example: ["j88xdEy0J5lc", "eZ7LMljCk8vo"] items: + description: A CI pipeline fingerprint string. type: string type: array contacts: @@ -59870,6 +60781,7 @@ components: description: "The service's programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`." example: ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"] items: + description: A programming language identifier. type: string type: array lifecycle: @@ -59887,6 +60799,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array team: @@ -60183,15 +61096,18 @@ components: type: array type: object ServiceList: + description: The response body for the service list endpoint. properties: data: $ref: "#/components/schemas/ServiceListData" type: object ServiceListData: + description: A single data item in the service list response. properties: attributes: $ref: "#/components/schemas/ServiceListDataAttributes" id: + description: The unique identifier of the service. type: string type: $ref: "#/components/schemas/ServiceListDataType" @@ -60199,21 +61115,28 @@ components: - type type: object ServiceListDataAttributes: + description: Attributes of a service list entry, containing metadata and a list of service names. properties: metadata: + description: A list of metadata items associated with the service. items: $ref: "#/components/schemas/ServiceListDataAttributesMetadataItems" type: array services: + description: A list of service names. items: + description: A single service name. type: string type: array type: object ServiceListDataAttributesMetadataItems: + description: An object containing metadata flags for a service, indicating whether it is traced by APM or monitored through Universal Service Monitoring. properties: isTraced: + description: Indicates whether the service is traced by APM. type: boolean isUsm: + description: Indicates whether the service uses Universal Service Monitoring. type: boolean type: object ServiceListDataType: @@ -60819,8 +61742,10 @@ components: - data type: object SessionIdArray: + description: A collection of session identifiers used for bulk add or remove operations on a playlist. properties: data: + description: Array of session identifier data objects. items: $ref: "#/components/schemas/SessionIdData" type: array @@ -60828,8 +61753,10 @@ components: - data type: object SessionIdData: + description: A session identifier data object used for bulk playlist operations. properties: id: + description: Unique identifier of the RUM replay session. example: 00000000-0000-0000-0000-000000000001 type: string type: @@ -61025,6 +61952,7 @@ components: additionalProperties: description: The values for each group by. items: + description: A group-by value. type: string type: array description: The key, value pairs for each group by. @@ -61324,13 +62252,16 @@ components: x-enum-varnames: - SLO_STATUS Snapshot: + description: A single heatmap snapshot resource returned by create or update operations. properties: data: $ref: "#/components/schemas/SnapshotData" type: object SnapshotArray: + description: A list of heatmap snapshots returned by a list operation. properties: data: + description: Array of heatmap snapshot data objects. items: $ref: "#/components/schemas/SnapshotData" type: array @@ -61338,6 +62269,7 @@ components: - data type: object SnapshotCreateRequest: + description: Request body for creating a heatmap snapshot. properties: data: $ref: "#/components/schemas/SnapshotCreateRequestData" @@ -61345,6 +62277,7 @@ components: - data type: object SnapshotCreateRequestData: + description: Data object for a heatmap snapshot creation request, containing the resource type and attributes. properties: attributes: $ref: "#/components/schemas/SnapshotCreateRequestDataAttributes" @@ -61354,31 +62287,41 @@ components: - type type: object SnapshotCreateRequestDataAttributes: + description: Attributes for creating a heatmap snapshot, including the view, session, event, and device context. properties: application_id: + description: Unique identifier of the RUM application. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string device_type: + description: Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). example: desktop type: string event_id: + description: Unique identifier of the RUM event associated with the snapshot. example: 11111111-2222-3333-4444-555555555555 type: string is_device_type_selected_by_user: + description: Indicates whether the device type was explicitly selected by the user rather than auto-detected. example: false type: boolean session_id: + description: Unique identifier of the RUM session associated with the snapshot. type: string snapshot_name: + description: Human-readable name for the snapshot. example: My Snapshot type: string start: + description: Offset in milliseconds from the start of the session at which the snapshot was captured. example: 0 format: int64 type: integer view_id: + description: Unique identifier of the RUM view associated with the snapshot. type: string view_name: + description: URL path or name of the view where the snapshot was captured. example: /home type: string required: @@ -61391,10 +62334,12 @@ components: - is_device_type_selected_by_user type: object SnapshotData: + description: Data object representing a heatmap snapshot, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/SnapshotDataAttributes" id: + description: Unique identifier of the heatmap snapshot. readOnly: true type: string type: @@ -61403,50 +62348,67 @@ components: - type type: object SnapshotDataAttributes: + description: Attributes of a heatmap snapshot, including view context, device information, and audit metadata. properties: application_id: + description: Unique identifier of the RUM application. type: string created_at: + description: Timestamp when the snapshot was created. format: date-time readOnly: true type: string created_by: + description: Display name of the user who created the snapshot. readOnly: true type: string created_by_handle: + description: Email handle of the user who created the snapshot. readOnly: true type: string created_by_user_id: + description: Numeric identifier of the user who created the snapshot. format: int64 readOnly: true type: integer device_type: + description: Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). type: string event_id: + description: Unique identifier of the RUM event associated with the snapshot. type: string is_device_type_selected_by_user: + description: Indicates whether the device type was explicitly selected by the user rather than auto-detected. type: boolean modified_at: + description: Timestamp when the snapshot was last modified. format: date-time readOnly: true type: string org_id: + description: Numeric identifier of the organization that owns the snapshot. format: int64 readOnly: true type: integer session_id: + description: Unique identifier of the RUM session associated with the snapshot. type: string snapshot_name: + description: Human-readable name for the snapshot. type: string start: + description: Offset in milliseconds from the start of the session at which the snapshot was captured. format: int64 type: integer view_id: + description: Unique identifier of the RUM view associated with the snapshot. type: string view_name: + description: URL path or name of the view where the snapshot was captured. type: string type: object SnapshotUpdateRequest: + description: Request body for updating a heatmap snapshot. properties: data: $ref: "#/components/schemas/SnapshotUpdateRequestData" @@ -61454,10 +62416,12 @@ components: - data type: object SnapshotUpdateRequestData: + description: Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/SnapshotUpdateRequestDataAttributes" id: + description: Unique identifier of the heatmap snapshot to update. example: 00000000-0000-0000-0000-000000000001 type: string type: @@ -61466,20 +62430,26 @@ components: - type type: object SnapshotUpdateRequestDataAttributes: + description: Attributes for updating a heatmap snapshot, including event, session, and view context. properties: event_id: + description: Unique identifier of the RUM event associated with the snapshot. example: 11111111-2222-3333-4444-555555555555 type: string is_device_type_selected_by_user: + description: Indicates whether the device type was explicitly selected by the user rather than auto-detected. example: false type: boolean session_id: + description: Unique identifier of the RUM session associated with the snapshot. type: string start: + description: Offset in milliseconds from the start of the session at which the snapshot was captured. example: 0 format: int64 type: integer view_id: + description: Unique identifier of the RUM view associated with the snapshot. type: string required: - event_id @@ -62543,6 +63513,7 @@ components: - type type: object StatusPage: + description: Response object for a single status page. properties: data: $ref: "#/components/schemas/StatusPageData" @@ -62553,8 +63524,10 @@ components: type: array type: object StatusPageArray: + description: Response object for a list of status pages. properties: data: + description: A list of status page data objects. items: $ref: "#/components/schemas/StatusPageData" type: array @@ -62569,6 +63542,7 @@ components: - data type: object StatusPageArrayIncluded: + description: An included resource related to a status page. oneOf: - $ref: "#/components/schemas/StatusPagesUser" StatusPageAsIncluded: @@ -62639,8 +63613,10 @@ components: $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" type: object StatusPageAsIncludedAttributesComponentsItems: + description: A component displayed on an included status page. properties: components: + description: If the component is of type `group`, the components within the group. items: $ref: "#/components/schemas/StatusPageAsIncludedAttributesComponentsItemsComponentsItems" type: array @@ -62662,6 +63638,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object StatusPageAsIncludedAttributesComponentsItemsComponentsItems: + description: A grouped component within a status page component group. properties: id: description: The ID of the grouped component. @@ -62691,6 +63668,7 @@ components: description: The Datadog user who last modified the status page. type: object StatusPageAsIncludedRelationshipsCreatedByUser: + description: The Datadog user who created the status page. properties: data: $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUserData" @@ -62698,6 +63676,7 @@ components: - data type: object StatusPageAsIncludedRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the status page. properties: id: description: The ID of the Datadog user who created the status page. @@ -62710,6 +63689,7 @@ components: - id type: object StatusPageAsIncludedRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the status page. properties: data: $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUserData" @@ -62717,6 +63697,7 @@ components: - data type: object StatusPageAsIncludedRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the status page. properties: id: description: The ID of the Datadog user who last modified the status page. @@ -62729,6 +63710,7 @@ components: - id type: object StatusPageData: + description: The data object for a status page. properties: attributes: $ref: "#/components/schemas/StatusPageDataAttributes" @@ -62799,6 +63781,7 @@ components: $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" type: object StatusPageDataAttributesComponentsItems: + description: A component displayed on a status page. properties: components: description: If the component is of type `group`, the components within the group. @@ -62822,6 +63805,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object StatusPageDataAttributesComponentsItemsComponentsItems: + description: A grouped component within a status page component group. properties: id: description: The ID of the component. @@ -62850,6 +63834,7 @@ components: description: The Datadog user who last modified the status page. type: object StatusPageDataRelationshipsCreatedByUser: + description: The Datadog user who created the status page. properties: data: $ref: "#/components/schemas/StatusPageDataRelationshipsCreatedByUserData" @@ -62857,6 +63842,7 @@ components: - data type: object StatusPageDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the status page. properties: id: description: The ID of the Datadog user who created the status page. @@ -62869,6 +63855,7 @@ components: - id type: object StatusPageDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the status page. properties: data: $ref: "#/components/schemas/StatusPageDataRelationshipsLastModifiedByUserData" @@ -62876,6 +63863,7 @@ components: - data type: object StatusPageDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the status page. properties: id: description: The ID of the Datadog user who last modified the status page. @@ -62897,6 +63885,7 @@ components: x-enum-varnames: - STATUS_PAGES StatusPagesComponent: + description: Response object for a single component. properties: data: $ref: "#/components/schemas/StatusPagesComponentData" @@ -62907,8 +63896,10 @@ components: type: array type: object StatusPagesComponentArray: + description: Response object for a list of components. properties: data: + description: A list of component data objects. items: $ref: "#/components/schemas/StatusPagesComponentData" type: array @@ -62921,11 +63912,13 @@ components: - data type: object StatusPagesComponentArrayIncluded: + description: An included resource related to a component. oneOf: - $ref: "#/components/schemas/StatusPagesUser" - $ref: "#/components/schemas/StatusPageAsIncluded" - $ref: "#/components/schemas/StatusPagesComponentGroup" StatusPagesComponentData: + description: The data object for a component. properties: attributes: $ref: "#/components/schemas/StatusPagesComponentDataAttributes" @@ -62971,14 +63964,18 @@ components: - type type: object StatusPagesComponentDataAttributesComponentsItems: + description: A component within a component group. properties: id: + description: The ID of the component within the group. format: uuid readOnly: true type: string name: + description: The name of the component within the group. type: string position: + description: The zero-indexed position of the component within the group. format: int64 type: integer status: @@ -63019,6 +64016,7 @@ components: description: The status page the component belongs to. type: object StatusPagesComponentDataRelationshipsCreatedByUser: + description: The Datadog user who created the component. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUserData" @@ -63026,6 +64024,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the component. properties: id: description: The ID of the Datadog user who created the component. @@ -63038,6 +64037,7 @@ components: - id type: object StatusPagesComponentDataRelationshipsGroup: + description: The group the component belongs to. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsGroupData" @@ -63045,6 +64045,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsGroupData: + description: The data object identifying the group the component belongs to. nullable: true properties: id: @@ -63059,6 +64060,7 @@ components: - id type: object StatusPagesComponentDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the component. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUserData" @@ -63066,6 +64068,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the component. properties: id: description: The ID of the Datadog user who last modified the component. @@ -63078,6 +64081,7 @@ components: - id type: object StatusPagesComponentDataRelationshipsStatusPage: + description: The status page the component belongs to. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsStatusPageData" @@ -63085,6 +64089,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsStatusPageData: + description: The data object identifying the status page the component belongs to. properties: id: description: The ID of the status page the component belongs to. @@ -63144,6 +64149,7 @@ components: - type type: object StatusPagesComponentGroupAttributesComponentsItems: + description: A component within a component group. properties: id: description: The ID of the grouped component. @@ -63207,6 +64213,7 @@ components: - data type: object StatusPagesComponentGroupRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the component group. properties: id: description: The ID of the Datadog user who created the component group. @@ -63227,9 +64234,11 @@ components: - data type: object StatusPagesComponentGroupRelationshipsGroupData: + description: The data object identifying the parent group of a component group. nullable: true properties: id: + description: The ID of the parent group. example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string @@ -63248,6 +64257,7 @@ components: - data type: object StatusPagesComponentGroupRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the component group. properties: id: description: The ID of the Datadog user who last modified the component group. @@ -63268,6 +64278,7 @@ components: - data type: object StatusPagesComponentGroupRelationshipsStatusPageData: + description: The data object identifying the status page the component group belongs to. properties: id: description: The ID of the status page. @@ -63389,6 +64400,7 @@ components: type: number type: object SuiteCreateEdit: + description: Data object for creating or editing a Synthetic test suite. properties: attributes: $ref: "#/components/schemas/SyntheticsSuite" @@ -63399,6 +64411,7 @@ components: - type type: object SuiteCreateEditRequest: + description: Request body for creating or editing a Synthetic test suite. properties: data: $ref: "#/components/schemas/SuiteCreateEdit" @@ -63407,6 +64420,7 @@ components: type: object SuiteSearchResponseType: default: suites_search + description: Type for the Synthetics suites search response, `suites_search`. enum: - suites_search example: suites_search @@ -63440,23 +64454,27 @@ components: $ref: "#/components/schemas/SecurityMonitoringSuppressionAttributes" type: object SyncProperty: - description: Sync property configuration + description: Sync property configuration. properties: sync_type: + description: The direction and type of synchronization for this property. type: string type: object SyncPropertyWithMapping: - description: Sync property with mapping configuration + description: Sync property with mapping configuration. properties: mapping: additionalProperties: type: string + description: Map of source values to destination values for synchronization. type: object name_mapping: additionalProperties: type: string + description: Map of source names to display names used during synchronization. type: object sync_type: + description: The direction and type of synchronization for this property. type: string type: object SyntheticsGlobalVariable: @@ -63816,6 +64834,7 @@ components: $ref: "#/components/schemas/SyntheticsNetworkTestRequest" type: object SyntheticsNetworkTestEdit: + description: Data object for creating or editing a Network Path test. properties: attributes: $ref: "#/components/schemas/SyntheticsNetworkTest" @@ -63983,6 +65002,7 @@ components: type: string type: array tests: + description: Array of Synthetic tests included in the suite. items: $ref: "#/components/schemas/SyntheticsSuiteTest" type: array @@ -64035,6 +65055,7 @@ components: attributes: $ref: "#/components/schemas/SyntheticsSuiteSearchResponseDataAttributes" id: + description: The unique identifier of the suite search response data. format: uuid type: string type: @@ -64044,10 +65065,12 @@ components: description: Synthetics suite search response data attributes properties: suites: + description: List of Synthetic suites matching the search query. items: $ref: "#/components/schemas/SyntheticsSuite" type: array total: + description: Total number of Synthetic suites matching the search query. format: int32 maximum: 2147483647 type: integer @@ -64058,6 +65081,7 @@ components: alerting_criticality: $ref: "#/components/schemas/SyntheticsSuiteTestAlertingCriticality" public_id: + description: The public ID of the Synthetic test included in the suite. example: "" type: string required: @@ -64414,6 +65438,7 @@ components: - "tag_1" - "tag_2" items: + description: A tag associated with the reference table. type: string type: array updated_at: @@ -64564,6 +65589,7 @@ components: example: - "field_1" items: + description: A field name used as a primary key. type: string type: array required: @@ -64638,6 +65664,7 @@ components: description: Row resource containing a single row identifier. properties: id: + description: The primary key value that uniquely identifies the row to delete. example: "primary_key_value" type: string type: @@ -66335,6 +67362,7 @@ components: type: string type: object TenancyConfig: + description: Response containing a single OCI tenancy integration configuration. example: data: attributes: @@ -66372,10 +67400,12 @@ components: $ref: "#/components/schemas/TenancyConfigData" type: object TenancyConfigData: + description: A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes. properties: attributes: $ref: "#/components/schemas/TenancyConfigDataAttributes" id: + description: The OCID of the OCI tenancy. type: string type: $ref: "#/components/schemas/UpdateTenancyConfigDataType" @@ -66383,79 +67413,110 @@ components: - type type: object TenancyConfigDataAttributes: + description: Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. properties: billing_plan_id: + description: The identifier of the billing plan associated with the OCI tenancy. format: int32 maximum: 2147483647 type: integer config_version: + description: Version number of the integration the tenancy is integrated with format: int64 type: integer cost_collection_enabled: + description: Whether cost data collection from OCI is enabled for the tenancy. type: boolean dd_compartment_id: + description: The OCID of the OCI compartment used by the Datadog integration stack. type: string dd_stack_id: + description: The OCID of the OCI Resource Manager stack used by the Datadog integration. type: string home_region: + description: The home region of the OCI tenancy (for example, us-ashburn-1). type: string logs_config: $ref: "#/components/schemas/TenancyConfigDataAttributesLogsConfig" metrics_config: $ref: "#/components/schemas/TenancyConfigDataAttributesMetricsConfig" parent_tenancy_name: + description: The name of the parent OCI tenancy, if applicable. type: string regions_config: $ref: "#/components/schemas/TenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: + description: Whether resource collection from OCI is enabled for the tenancy. type: boolean tenancy_name: + description: The human-readable name of the OCI tenancy. type: string user_ocid: + description: The OCID of the OCI user used by the Datadog integration for authentication. type: string type: object TenancyConfigDataAttributesLogsConfig: + description: Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled. properties: compartment_tag_filters: + description: List of compartment tag filters scoping log collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether log collection is enabled for the tenancy. type: boolean enabled_services: + description: List of OCI service names for which log collection is enabled. items: + description: An OCI service name for which log collection is enabled (for example, compute). type: string type: array type: object TenancyConfigDataAttributesMetricsConfig: + description: Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded. properties: compartment_tag_filters: + description: List of compartment tag filters scoping metrics collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether metrics collection is enabled for the tenancy. type: boolean excluded_services: + description: List of OCI service names excluded from metrics collection. items: + description: An OCI service name excluded from metrics collection (for example, compute). type: string type: array type: object TenancyConfigDataAttributesRegionsConfig: + description: Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection. properties: available: + description: List of OCI regions available for data collection in the tenancy. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array disabled: + description: List of OCI regions explicitly disabled for data collection. items: + description: An OCI region identifier (for example, us-phoenix-1). type: string type: array enabled: + description: List of OCI regions enabled for data collection. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array type: object TenancyConfigList: + description: Response containing a list of OCI tenancy integration configurations. example: data: - attributes: @@ -66490,6 +67551,7 @@ components: type: oci_tenancy properties: data: + description: List of OCI tenancy integration configuration objects. items: $ref: "#/components/schemas/TenancyConfigData" type: array @@ -66497,10 +67559,12 @@ components: - data type: object TenancyProductsData: + description: A single OCI tenancy product resource object containing the tenancy ID, type, and product attributes. properties: attributes: $ref: "#/components/schemas/TenancyProductsDataAttributes" id: + description: The OCID of the OCI tenancy. type: string type: $ref: "#/components/schemas/TenancyProductsDataType" @@ -66508,17 +67572,22 @@ components: - type type: object TenancyProductsDataAttributes: + description: Attributes of an OCI tenancy product resource, containing the list of available products and their enablement status. properties: products: + description: List of Datadog products and their enablement status for the tenancy. items: $ref: "#/components/schemas/TenancyProductsDataAttributesProductsItems" type: array type: object TenancyProductsDataAttributesProductsItems: + description: An individual Datadog product with its enablement status for a tenancy. properties: enabled: + description: Indicates whether the product is enabled for the tenancy. type: boolean product_key: + description: The unique key identifying the Datadog product (for example, CLOUD_SECURITY_POSTURE_MANAGEMENT). type: string type: object TenancyProductsDataType: @@ -66531,6 +67600,7 @@ components: x-enum-varnames: - OCI_TENANCY_PRODUCT TenancyProductsList: + description: Response containing a list of OCI tenancy product resources with their product enablement status. example: data: - attributes: @@ -66541,6 +67611,7 @@ components: type: oci_tenancy_product properties: data: + description: List of OCI tenancy product resource objects. items: $ref: "#/components/schemas/TenancyProductsData" type: array @@ -66935,7 +68006,7 @@ components: $ref: "#/components/schemas/TimeseriesResponseValuesList" type: object TimeseriesResponseSeries: - description: "" + description: A single series in a timeseries query response, containing the query index, unit information, and group tags. properties: group_tags: $ref: "#/components/schemas/GroupTags" @@ -67108,6 +68179,7 @@ components: error_messages: description: The `items` `error_messages`. items: + description: An error message string. type: string nullable: true type: array @@ -67153,12 +68225,14 @@ components: x-enum-varnames: - AZURE_UC_CONFIGS UnassignSeatsUserRequest: + description: The request body for unassigning seats from users for a product code. properties: data: $ref: "#/components/schemas/UnassignSeatsUserRequestData" description: The data for the unassign seats user request. type: object UnassignSeatsUserRequestData: + description: The request data object containing attributes for unassigning seats from users. properties: attributes: $ref: "#/components/schemas/UnassignSeatsUserRequestDataAttributes" @@ -67174,6 +68248,7 @@ components: - attributes type: object UnassignSeatsUserRequestDataAttributes: + description: Attributes specifying the product and users from whom seats will be unassigned. properties: product_code: description: The product code for which to unassign seats. @@ -67184,6 +68259,7 @@ components: example: - "" items: + description: A user UUID identifying a user to unassign seats from. type: string type: array required: @@ -67478,6 +68554,7 @@ components: type: string type: object UpdateConnectionRequest: + description: Request body for updating an existing data source connection by adding, modifying, or removing fields. example: data: attributes: @@ -67505,10 +68582,12 @@ components: $ref: "#/components/schemas/UpdateConnectionRequestData" type: object UpdateConnectionRequestData: + description: The data object containing the resource identifier and attributes for updating an existing connection. properties: attributes: $ref: "#/components/schemas/UpdateConnectionRequestDataAttributes" id: + description: The unique identifier of the connection to update. example: "" type: string type: @@ -67518,33 +68597,45 @@ components: - id type: object UpdateConnectionRequestDataAttributes: + description: Attributes specifying the field modifications to apply to an existing connection. properties: fields_to_add: + description: New fields to add to the connection from the data source. items: $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array fields_to_delete: + description: Identifiers of existing fields to remove from the connection. items: + description: The identifier of a field to delete from the connection. type: string type: array fields_to_update: + description: Existing fields with updated metadata to apply to the connection. items: $ref: "#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems" type: array type: object UpdateConnectionRequestDataAttributesFieldsToUpdateItems: + description: Specification for updating an existing field in a connection, including which field to modify and the new values. properties: field_id: + description: The identifier of the existing field to update. example: "" type: string updated_description: + description: The new description to set for the field. type: string updated_display_name: + description: The new human-readable display name to set for the field. type: string updated_field_id: + description: The new identifier to assign to the field, if renaming it. type: string updated_groups: + description: The updated list of group labels to associate with the field. items: + description: A group label name for categorizing the field. type: string type: array required: @@ -68237,6 +69328,7 @@ components: example: - "" items: + description: A source key for the reference table lookup. type: string type: array table_name: @@ -68273,10 +69365,12 @@ components: x-enum-varnames: - UPDATE_RULESET UpdateTenancyConfigData: + description: The data object for updating an existing OCI tenancy integration configuration, including the tenancy ID, type, and updated attributes. properties: attributes: $ref: "#/components/schemas/UpdateTenancyConfigDataAttributes" id: + description: The OCID of the OCI tenancy to update. example: "" type: string type: @@ -68286,12 +69380,15 @@ components: - id type: object UpdateTenancyConfigDataAttributes: + description: Attributes for updating an existing OCI tenancy integration configuration, including optional credentials, region settings, and collection options. properties: auth_credentials: $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesAuthCredentials" cost_collection_enabled: + description: Whether cost data collection from OCI is enabled for the tenancy. type: boolean home_region: + description: The home region of the OCI tenancy (for example, us-ashburn-1). type: string logs_config: $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesLogsConfig" @@ -68300,58 +69397,82 @@ components: regions_config: $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: + description: Whether resource collection from OCI is enabled for the tenancy. type: boolean user_ocid: + description: The OCID of the OCI user used by the Datadog integration for authentication. type: string type: object UpdateTenancyConfigDataAttributesAuthCredentials: + description: OCI API signing key credentials used to update the Datadog integration's authentication with the OCI tenancy. properties: fingerprint: + description: The fingerprint of the OCI API signing key used for authentication. type: string private_key: + description: The PEM-encoded private key corresponding to the OCI API signing key fingerprint. example: "" type: string required: - private_key type: object UpdateTenancyConfigDataAttributesLogsConfig: + description: Log collection configuration for updating an OCI tenancy, controlling which compartments and services have log collection enabled. properties: compartment_tag_filters: + description: List of compartment tag filters to scope log collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether log collection is enabled for the tenancy. type: boolean enabled_services: + description: List of OCI service names for which log collection is enabled. items: + description: An OCI service name for which log collection is enabled (for example, compute). type: string type: array type: object UpdateTenancyConfigDataAttributesMetricsConfig: + description: Metrics collection configuration for updating an OCI tenancy, controlling which compartments and services are included or excluded. properties: compartment_tag_filters: + description: List of compartment tag filters to scope metrics collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether metrics collection is enabled for the tenancy. type: boolean excluded_services: + description: List of OCI service names to exclude from metrics collection. items: + description: An OCI service name to exclude from metrics collection (for example, compute). type: string type: array type: object UpdateTenancyConfigDataAttributesRegionsConfig: + description: Region configuration for updating an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. properties: available: + description: List of OCI regions available for data collection in the tenancy. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array disabled: + description: List of OCI regions explicitly disabled for data collection. items: + description: An OCI region identifier (for example, us-phoenix-1). type: string type: array enabled: + description: List of OCI regions enabled for data collection. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array type: object @@ -68365,6 +69486,7 @@ components: x-enum-varnames: - OCI_TENANCY UpdateTenancyConfigRequest: + description: Request body for updating an existing OCI tenancy integration configuration. example: data: attributes: @@ -69424,8 +70546,10 @@ components: - UPDATE - DELETE ViewershipHistorySessionArray: + description: A list of RUM replay sessions from a user's viewership history. properties: data: + description: Array of viewership history session data objects. items: $ref: "#/components/schemas/ViewershipHistorySessionData" type: array @@ -69433,10 +70557,12 @@ components: - data type: object ViewershipHistorySessionData: + description: Data object representing a session in the viewership history, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/ViewershipHistorySessionDataAttributes" id: + description: Unique identifier of the RUM replay session. type: string type: $ref: "#/components/schemas/ViewershipHistorySessionDataType" @@ -69444,17 +70570,22 @@ components: - type type: object ViewershipHistorySessionDataAttributes: + description: Attributes of a viewership history session entry, capturing when it was last watched and the associated event data. properties: event_id: + description: Unique identifier of the RUM event associated with the watched session. type: string last_watched_at: + description: Timestamp when the session was last watched by the user. example: "2026-01-13T17:15:53.208340Z" format: date-time type: string session_event: additionalProperties: {} + description: Raw event data associated with the replay session. type: object track: + description: Replay track identifier indicating which recording track the session belongs to. type: string required: - last_watched_at @@ -69598,6 +70729,7 @@ components: example: - CVE-2023-0615 items: + description: A CVE identifier associated with the vulnerability. example: CVE-2023-0615 type: string type: array @@ -69639,6 +70771,7 @@ components: example: - agentless-scanner items: + description: The detection origin of the vulnerability (for example, the scanner type). example: agentless-scanner type: string type: array @@ -69650,6 +70783,7 @@ components: repo_digests: description: Vulnerability `repo_digest` list (when the vulnerability is related to `Image` asset). items: + description: A container image repository digest identifying the affected image. example: sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7 type: string type: array @@ -69789,6 +70923,7 @@ components: example: - NIST items: + description: An exploit source reporting this vulnerability. example: NIST type: string type: array @@ -69945,6 +71080,7 @@ components: - X_PATH_INJECTION - XSS Watch: + description: A single RUM replay session watch resource returned by create operations. properties: data: $ref: "#/components/schemas/WatchData" @@ -69952,10 +71088,12 @@ components: - data type: object WatchData: + description: Data object representing a session watch record, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/WatchDataAttributes" id: + description: Unique identifier of the watch record. type: string type: $ref: "#/components/schemas/WatchDataType" @@ -69963,16 +71101,21 @@ components: - type type: object WatchDataAttributes: + description: Attributes for recording a session watch event, including the application, event reference, and timestamp. properties: application_id: + description: Unique identifier of the RUM application containing the session. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string data_source: + description: Data source type indicating the origin of the session data (e.g., rum or product_analytics). type: string event_id: + description: Unique identifier of the RUM event that was watched. example: 11111111-2222-3333-4444-555555555555 type: string timestamp: + description: Timestamp when the session was watched. example: "2026-01-13T17:15:53.208340Z" format: date-time type: string @@ -69991,8 +71134,10 @@ components: x-enum-varnames: - RUM_REPLAY_WATCH WatcherArray: + description: A list of users who have watched a RUM replay session. properties: data: + description: Array of watcher data objects. items: $ref: "#/components/schemas/WatcherData" type: array @@ -70000,10 +71145,12 @@ components: - data type: object WatcherData: + description: Data object representing a session watcher, including their identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/WatcherDataAttributes" id: + description: Unique identifier of the watcher user. type: string type: $ref: "#/components/schemas/WatcherDataType" @@ -70011,19 +71158,25 @@ components: - type type: object WatcherDataAttributes: + description: Attributes of a user who has watched a RUM replay session, including contact information and watch statistics. properties: handle: + description: Email handle of the user who watched the session. example: john.doe@example.com type: string icon: + description: URL or identifier of the watcher's avatar icon. type: string last_watched_at: + description: Timestamp when the watcher last viewed the session. example: "2026-01-13T17:15:53.208340Z" format: date-time type: string name: + description: Display name of the user who watched the session. type: string watch_count: + description: Total number of times the user has watched the session. example: 0 format: int32 maximum: 2147483647 @@ -70137,6 +71290,7 @@ components: tags: description: Tags of the workflow. items: + description: A tag string in `key:value` format. type: string type: array updatedAt: @@ -70207,6 +71361,7 @@ components: tags: description: Tags of the workflow. items: + description: A tag string in `key:value` format. type: string type: array updatedAt: @@ -70376,6 +71531,7 @@ components: example: - "AWS/AppSync" items: + description: An AWS X-Ray service name to include in traces collection. example: "AWS/AppSync" type: string type: array @@ -74640,7 +75796,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ProjectCreateRequest" - description: Project payload + description: Project payload. required: true responses: "201": @@ -74736,7 +75892,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ProjectUpdateRequest" - description: Project payload + description: Project payload. required: true responses: "200": diff --git a/src/datadog_api_client/v2/api/case_management_api.py b/src/datadog_api_client/v2/api/case_management_api.py index 01d3bfcdaa..a95015f593 100644 --- a/src/datadog_api_client/v2/api/case_management_api.py +++ b/src/datadog_api_client/v2/api/case_management_api.py @@ -1044,7 +1044,7 @@ def create_project( Create a project. - :param body: Project payload + :param body: Project payload. :type body: ProjectCreateRequest :rtype: ProjectResponse """ @@ -1127,7 +1127,7 @@ def delete_project( Remove a project using the project's ``id``. - :param project_id: Project UUID + :param project_id: Project UUID. :type project_id: str :rtype: None """ @@ -1183,7 +1183,7 @@ def get_project( Get the details of a project by ``project_id``. - :param project_id: Project UUID + :param project_id: Project UUID. :type project_id: str :rtype: ProjectResponse """ @@ -1570,9 +1570,9 @@ def update_project( Update a project. - :param project_id: Project UUID + :param project_id: Project UUID. :type project_id: str - :param body: Project payload + :param body: Project payload. :type body: ProjectUpdateRequest :rtype: ProjectResponse """ diff --git a/src/datadog_api_client/v2/model/any_value_item.py b/src/datadog_api_client/v2/model/any_value_item.py index a806e14c64..abada5b793 100644 --- a/src/datadog_api_client/v2/model/any_value_item.py +++ b/src/datadog_api_client/v2/model/any_value_item.py @@ -12,7 +12,9 @@ class AnyValueItem(ModelComposed): def __init__(self, **kwargs): - """ """ + """ + A single item in an array of arbitrary values, which can be a string, number, object, or boolean. + """ super().__init__(kwargs) @cached_property diff --git a/src/datadog_api_client/v2/model/any_value_object.py b/src/datadog_api_client/v2/model/any_value_object.py index a56a7703a5..0f1e4e14c9 100644 --- a/src/datadog_api_client/v2/model/any_value_object.py +++ b/src/datadog_api_client/v2/model/any_value_object.py @@ -11,5 +11,7 @@ class AnyValueObject(ModelNormal): def __init__(self_, **kwargs): - """ """ + """ + An arbitrary object value with additional properties. + """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/argument.py b/src/datadog_api_client/v2/model/argument.py index 6a2dae8ffd..d58a0181cd 100644 --- a/src/datadog_api_client/v2/model/argument.py +++ b/src/datadog_api_client/v2/model/argument.py @@ -25,7 +25,7 @@ def openapi_types(_): def __init__(self_, description: str, name: str, **kwargs): """ - + A named argument for a custom static analysis rule. :param description: Base64-encoded argument description :type description: str diff --git a/src/datadog_api_client/v2/model/assign_seats_user_request.py b/src/datadog_api_client/v2/model/assign_seats_user_request.py index 8b5761aab8..fcccb60c37 100644 --- a/src/datadog_api_client/v2/model/assign_seats_user_request.py +++ b/src/datadog_api_client/v2/model/assign_seats_user_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[AssignSeatsUserRequestData, UnsetType] = unset, **kwargs): """ + The request body for assigning seats to users for a product code. - - :param data: + :param data: The request data object containing attributes for assigning seats to users. :type data: AssignSeatsUserRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/assign_seats_user_request_data.py b/src/datadog_api_client/v2/model/assign_seats_user_request_data.py index 75978dd060..f5692bfd5b 100644 --- a/src/datadog_api_client/v2/model/assign_seats_user_request_data.py +++ b/src/datadog_api_client/v2/model/assign_seats_user_request_data.py @@ -48,9 +48,9 @@ def __init__( **kwargs, ): """ + The request data object containing attributes for assigning seats to users. - - :param attributes: + :param attributes: Attributes specifying the product and users to whom seats will be assigned. :type attributes: AssignSeatsUserRequestDataAttributes :param id: The ID of the assign seats user request. diff --git a/src/datadog_api_client/v2/model/assign_seats_user_request_data_attributes.py b/src/datadog_api_client/v2/model/assign_seats_user_request_data_attributes.py index ed6b913871..81d02dcc2d 100644 --- a/src/datadog_api_client/v2/model/assign_seats_user_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/assign_seats_user_request_data_attributes.py @@ -26,7 +26,7 @@ def openapi_types(_): def __init__(self_, product_code: str, user_uuids: List[str], **kwargs): """ - + Attributes specifying the product and users to whom seats will be assigned. :param product_code: The product code for which to assign seats. :type product_code: str diff --git a/src/datadog_api_client/v2/model/assign_seats_user_response.py b/src/datadog_api_client/v2/model/assign_seats_user_response.py index 72a4a8ebe9..6436f524e9 100644 --- a/src/datadog_api_client/v2/model/assign_seats_user_response.py +++ b/src/datadog_api_client/v2/model/assign_seats_user_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[AssignSeatsUserResponseData, UnsetType] = unset, **kwargs): """ + The response body returned after successfully assigning seats to users. - - :param data: + :param data: The response data object containing attributes of the seat assignment result. :type data: AssignSeatsUserResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/assign_seats_user_response_data.py b/src/datadog_api_client/v2/model/assign_seats_user_response_data.py index e6eb83fb73..a8d0ac4fe1 100644 --- a/src/datadog_api_client/v2/model/assign_seats_user_response_data.py +++ b/src/datadog_api_client/v2/model/assign_seats_user_response_data.py @@ -48,9 +48,9 @@ def __init__( **kwargs, ): """ + The response data object containing attributes of the seat assignment result. - - :param attributes: + :param attributes: Attributes of the assign seats response, including the list of users assigned and the product code. :type attributes: AssignSeatsUserResponseDataAttributes, optional :param id: The ID of the assign seats user response. diff --git a/src/datadog_api_client/v2/model/assign_seats_user_response_data_attributes.py b/src/datadog_api_client/v2/model/assign_seats_user_response_data_attributes.py index 4e77280a79..3dd47f2086 100644 --- a/src/datadog_api_client/v2/model/assign_seats_user_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/assign_seats_user_response_data_attributes.py @@ -30,7 +30,7 @@ def __init__( self_, assigned_ids: Union[List[str], UnsetType] = unset, product_code: Union[str, UnsetType] = unset, **kwargs ): """ - + Attributes of the assign seats response, including the list of users assigned and the product code. :param assigned_ids: The list of user IDs to which the seats were assigned. :type assigned_ids: [str], optional diff --git a/src/datadog_api_client/v2/model/attachment.py b/src/datadog_api_client/v2/model/attachment.py index ccdba2b690..fae682f391 100644 --- a/src/datadog_api_client/v2/model/attachment.py +++ b/src/datadog_api_client/v2/model/attachment.py @@ -47,7 +47,7 @@ def __init__( :param data: Attachment data from a response. :type data: AttachmentData, optional - :param included: + :param included: A list of related objects included in the response. :type included: [AttachmentIncluded], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/attachment_array.py b/src/datadog_api_client/v2/model/attachment_array.py index 0fb52b03f0..93bdfc2b1f 100644 --- a/src/datadog_api_client/v2/model/attachment_array.py +++ b/src/datadog_api_client/v2/model/attachment_array.py @@ -44,10 +44,10 @@ def __init__( """ A list of incident attachments. - :param data: + :param data: An array of attachment data objects. :type data: [AttachmentData] - :param included: + :param included: A list of related objects included in the response. :type included: [AttachmentIncluded], optional """ if included is not unset: diff --git a/src/datadog_api_client/v2/model/auto_close_inactive_cases.py b/src/datadog_api_client/v2/model/auto_close_inactive_cases.py index 3b99462054..cfceee781b 100644 --- a/src/datadog_api_client/v2/model/auto_close_inactive_cases.py +++ b/src/datadog_api_client/v2/model/auto_close_inactive_cases.py @@ -33,12 +33,12 @@ def __init__( **kwargs, ): """ - Auto-close inactive cases settings + Auto-close inactive cases settings. - :param enabled: Whether auto-close is enabled + :param enabled: Whether auto-close is enabled. :type enabled: bool, optional - :param max_inactive_time_in_secs: Maximum inactive time in seconds before auto-closing + :param max_inactive_time_in_secs: Maximum inactive time in seconds before auto-closing. :type max_inactive_time_in_secs: int, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/auto_transition_assigned_cases.py b/src/datadog_api_client/v2/model/auto_transition_assigned_cases.py index 0212ca96d9..bd337f9db8 100644 --- a/src/datadog_api_client/v2/model/auto_transition_assigned_cases.py +++ b/src/datadog_api_client/v2/model/auto_transition_assigned_cases.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, auto_transition_assigned_cases_on_self_assigned: Union[bool, UnsetType] = unset, **kwargs): """ - Auto-transition assigned cases settings + Auto-transition assigned cases settings. - :param auto_transition_assigned_cases_on_self_assigned: Whether to auto-transition cases when self-assigned + :param auto_transition_assigned_cases_on_self_assigned: Whether to auto-transition cases when self-assigned. :type auto_transition_assigned_cases_on_self_assigned: bool, optional """ if auto_transition_assigned_cases_on_self_assigned is not unset: diff --git a/src/datadog_api_client/v2/model/batch_delete_rows_request_array.py b/src/datadog_api_client/v2/model/batch_delete_rows_request_array.py index 13462d542e..b074361f6a 100644 --- a/src/datadog_api_client/v2/model/batch_delete_rows_request_array.py +++ b/src/datadog_api_client/v2/model/batch_delete_rows_request_array.py @@ -38,7 +38,7 @@ def __init__(self_, data: List[TableRowResourceIdentifier], **kwargs): """ The request body for deleting multiple rows from a reference table. - :param data: + :param data: List of row resources to delete from the reference table. :type data: [TableRowResourceIdentifier] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/batch_upsert_rows_request_array.py b/src/datadog_api_client/v2/model/batch_upsert_rows_request_array.py index 1aed40a938..b374db8a3d 100644 --- a/src/datadog_api_client/v2/model/batch_upsert_rows_request_array.py +++ b/src/datadog_api_client/v2/model/batch_upsert_rows_request_array.py @@ -38,7 +38,7 @@ def __init__(self_, data: List[BatchUpsertRowsRequestData], **kwargs): """ The request body for creating or updating multiple rows into a reference table. - :param data: + :param data: List of row resources to create or update in the reference table. :type data: [BatchUpsertRowsRequestData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/batch_upsert_rows_request_data.py b/src/datadog_api_client/v2/model/batch_upsert_rows_request_data.py index ae14d53fae..2767c02d1c 100644 --- a/src/datadog_api_client/v2/model/batch_upsert_rows_request_data.py +++ b/src/datadog_api_client/v2/model/batch_upsert_rows_request_data.py @@ -53,7 +53,7 @@ def __init__( :param attributes: Attributes containing row data values for row creation or update operations. :type attributes: BatchUpsertRowsRequestDataAttributes, optional - :param id: + :param id: The primary key value that uniquely identifies the row to create or update. :type id: str :param type: Row resource type. diff --git a/src/datadog_api_client/v2/model/budget_attributes.py b/src/datadog_api_client/v2/model/budget_attributes.py index a47c1ee54e..fb3fada3c8 100644 --- a/src/datadog_api_client/v2/model/budget_attributes.py +++ b/src/datadog_api_client/v2/model/budget_attributes.py @@ -81,7 +81,7 @@ def __init__( :param end_month: The month when the budget ends. :type end_month: int, optional - :param entries: + :param entries: The list of monthly budget entries. :type entries: [BudgetWithEntriesDataAttributesEntriesItems], optional :param metrics_query: The cost query used to track against the budget. diff --git a/src/datadog_api_client/v2/model/budget_validation_request.py b/src/datadog_api_client/v2/model/budget_validation_request.py index f3e4822d95..edf4c6d507 100644 --- a/src/datadog_api_client/v2/model/budget_validation_request.py +++ b/src/datadog_api_client/v2/model/budget_validation_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[BudgetValidationRequestData, UnsetType] = unset, **kwargs): """ + The request object for validating a budget configuration before creating or updating it. - - :param data: + :param data: The data object for a budget validation request, containing the resource type, ID, and budget attributes to validate. :type data: BudgetValidationRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/budget_validation_request_data.py b/src/datadog_api_client/v2/model/budget_validation_request_data.py index 49b9142ade..0857bc0e70 100644 --- a/src/datadog_api_client/v2/model/budget_validation_request_data.py +++ b/src/datadog_api_client/v2/model/budget_validation_request_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object for a budget validation request, containing the resource type, ID, and budget attributes to validate. - - :param attributes: + :param attributes: The attributes of a budget including all its monthly entries. :type attributes: BudgetWithEntriesDataAttributes, optional - :param id: + :param id: The unique identifier of the budget to validate. :type id: str, optional :param type: Budget resource type. diff --git a/src/datadog_api_client/v2/model/budget_validation_response.py b/src/datadog_api_client/v2/model/budget_validation_response.py index 49531fbfdf..fba8a5f51a 100644 --- a/src/datadog_api_client/v2/model/budget_validation_response.py +++ b/src/datadog_api_client/v2/model/budget_validation_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[BudgetValidationResponseData, UnsetType] = unset, **kwargs): """ + The response object for a budget validation request, containing the validation result data. - - :param data: + :param data: The data object for a budget validation response, containing the resource type, ID, and validation attributes. :type data: BudgetValidationResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/budget_validation_response_data.py b/src/datadog_api_client/v2/model/budget_validation_response_data.py index 6ba2ff6e39..164241d0ec 100644 --- a/src/datadog_api_client/v2/model/budget_validation_response_data.py +++ b/src/datadog_api_client/v2/model/budget_validation_response_data.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + The data object for a budget validation response, containing the resource type, ID, and validation attributes. - - :param attributes: + :param attributes: The attributes of a budget validation response, including any validation errors and the validity status. :type attributes: BudgetValidationResponseDataAttributes, optional - :param id: + :param id: The unique identifier of the budget being validated. :type id: str, optional :param type: Budget validation resource type. diff --git a/src/datadog_api_client/v2/model/budget_validation_response_data_attributes.py b/src/datadog_api_client/v2/model/budget_validation_response_data_attributes.py index 952a5d8ba6..1b54badf16 100644 --- a/src/datadog_api_client/v2/model/budget_validation_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/budget_validation_response_data_attributes.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, errors: Union[List[str], UnsetType] = unset, valid: Union[bool, UnsetType] = unset, **kwargs): """ + The attributes of a budget validation response, including any validation errors and the validity status. - - :param errors: + :param errors: A list of validation error messages for the budget. :type errors: [str], optional - :param valid: + :param valid: Whether the budget configuration is valid. :type valid: bool, optional """ if errors is not unset: diff --git a/src/datadog_api_client/v2/model/budget_with_entries_data_attributes.py b/src/datadog_api_client/v2/model/budget_with_entries_data_attributes.py index 71f894d9e8..48571d57d8 100644 --- a/src/datadog_api_client/v2/model/budget_with_entries_data_attributes.py +++ b/src/datadog_api_client/v2/model/budget_with_entries_data_attributes.py @@ -70,39 +70,39 @@ def __init__( **kwargs, ): """ + The attributes of a budget including all its monthly entries. - - :param created_at: + :param created_at: The timestamp when the budget was created. :type created_at: int, optional - :param created_by: + :param created_by: The ID of the user that created the budget. :type created_by: str, optional - :param end_month: + :param end_month: The month when the budget ends, in YYYYMM format. :type end_month: int, optional - :param entries: + :param entries: The list of monthly budget entries. :type entries: [BudgetWithEntriesDataAttributesEntriesItems], optional - :param metrics_query: + :param metrics_query: The cost query used to track spending against the budget. :type metrics_query: str, optional - :param name: + :param name: The name of the budget. :type name: str, optional - :param org_id: + :param org_id: The ID of the organization the budget belongs to. :type org_id: int, optional - :param start_month: + :param start_month: The month when the budget starts, in YYYYMM format. :type start_month: int, optional - :param total_amount: + :param total_amount: The total budget amount across all entries. :type total_amount: float, optional - :param updated_at: + :param updated_at: The timestamp when the budget was last updated. :type updated_at: int, optional - :param updated_by: + :param updated_by: The ID of the user that last updated the budget. :type updated_by: str, optional """ if created_at is not unset: diff --git a/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items.py b/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items.py index 0289208b8d..f3d3320523 100644 --- a/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items.py +++ b/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items.py @@ -46,15 +46,15 @@ def __init__( **kwargs, ): """ + A single monthly budget entry defining the allocated amount and optional tag filters for a specific month. - - :param amount: + :param amount: The budgeted amount for this entry. :type amount: float, optional - :param month: + :param month: The month this budget entry applies to, in YYYYMM format. :type month: int, optional - :param tag_filters: + :param tag_filters: The list of tag filters that scope this budget entry to specific resources. :type tag_filters: [BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems], optional """ if amount is not unset: diff --git a/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items_tag_filters_items.py b/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items_tag_filters_items.py index 20186d1f12..6e9393e12c 100644 --- a/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items_tag_filters_items.py +++ b/src/datadog_api_client/v2/model/budget_with_entries_data_attributes_entries_items_tag_filters_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, tag_key: Union[str, UnsetType] = unset, tag_value: Union[str, UnsetType] = unset, **kwargs): """ + A tag filter used to scope a budget entry to specific resource tags. - - :param tag_key: + :param tag_key: The tag key to filter on. :type tag_key: str, optional - :param tag_value: + :param tag_value: The tag value to filter on. :type tag_value: str, optional """ if tag_key is not unset: diff --git a/src/datadog_api_client/v2/model/case_create_relationships.py b/src/datadog_api_client/v2/model/case_create_relationships.py index 455cc73e88..4f855cc988 100644 --- a/src/datadog_api_client/v2/model/case_create_relationships.py +++ b/src/datadog_api_client/v2/model/case_create_relationships.py @@ -47,7 +47,7 @@ def __init__( :param assignee: Relationship to user. :type assignee: NullableUserRelationship, none_type, optional - :param project: Relationship to project + :param project: Relationship to project. :type project: ProjectRelationship """ if assignee is not unset: diff --git a/src/datadog_api_client/v2/model/case_management_project.py b/src/datadog_api_client/v2/model/case_management_project.py index b8b789d301..b845700ddc 100644 --- a/src/datadog_api_client/v2/model/case_management_project.py +++ b/src/datadog_api_client/v2/model/case_management_project.py @@ -32,7 +32,7 @@ def __init__(self_, data: CaseManagementProjectData, **kwargs): """ Case management project. - :param data: + :param data: Data object representing a case management project. :type data: CaseManagementProjectData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/case_management_project_data.py b/src/datadog_api_client/v2/model/case_management_project_data.py index b43c704699..d62c9e01a1 100644 --- a/src/datadog_api_client/v2/model/case_management_project_data.py +++ b/src/datadog_api_client/v2/model/case_management_project_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: CaseManagementProjectDataType, **kwargs): """ - + Data object representing a case management project. :param id: Unique identifier of the case management project. :type id: str diff --git a/src/datadog_api_client/v2/model/case_relationships.py b/src/datadog_api_client/v2/model/case_relationships.py index 63be74a232..09ccfeb775 100644 --- a/src/datadog_api_client/v2/model/case_relationships.py +++ b/src/datadog_api_client/v2/model/case_relationships.py @@ -59,7 +59,7 @@ def __init__( :param modified_by: Relationship to user. :type modified_by: NullableUserRelationship, none_type, optional - :param project: Relationship to project + :param project: Relationship to project. :type project: ProjectRelationship, optional """ if assignee is not unset: diff --git a/src/datadog_api_client/v2/model/create_attachment_request_data.py b/src/datadog_api_client/v2/model/create_attachment_request_data.py index 8f34fe2aec..d76a94ae0d 100644 --- a/src/datadog_api_client/v2/model/create_attachment_request_data.py +++ b/src/datadog_api_client/v2/model/create_attachment_request_data.py @@ -53,7 +53,7 @@ def __init__( :param attributes: The attributes for creating an attachment. :type attributes: CreateAttachmentRequestDataAttributes, optional - :param id: + :param id: The unique identifier of the attachment. :type id: str, optional :param type: The incident attachment resource type. diff --git a/src/datadog_api_client/v2/model/create_case_request_array.py b/src/datadog_api_client/v2/model/create_case_request_array.py index 82952edd26..4d242d85bc 100644 --- a/src/datadog_api_client/v2/model/create_case_request_array.py +++ b/src/datadog_api_client/v2/model/create_case_request_array.py @@ -32,7 +32,7 @@ def __init__(self_, data: List[CreateCaseRequestData], **kwargs): """ List of requests to create cases for security findings. - :param data: + :param data: Array of case creation request data objects. :type data: [CreateCaseRequestData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/create_component_request.py b/src/datadog_api_client/v2/model/create_component_request.py index 36bd3b050d..608cdc0095 100644 --- a/src/datadog_api_client/v2/model/create_component_request.py +++ b/src/datadog_api_client/v2/model/create_component_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CreateComponentRequestData, UnsetType] = unset, **kwargs): """ + Request object for creating a component. - - :param data: + :param data: The data object for creating a component. :type data: CreateComponentRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/create_component_request_data.py b/src/datadog_api_client/v2/model/create_component_request_data.py index 50fd8b1487..473b8bb3b3 100644 --- a/src/datadog_api_client/v2/model/create_component_request_data.py +++ b/src/datadog_api_client/v2/model/create_component_request_data.py @@ -54,7 +54,7 @@ def __init__( **kwargs, ): """ - + The data object for creating a component. :param attributes: The supported attributes for creating a component. :type attributes: CreateComponentRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/create_component_request_data_attributes_components_items.py b/src/datadog_api_client/v2/model/create_component_request_data_attributes_components_items.py index cb261f1f0a..ecc2a9a4a1 100644 --- a/src/datadog_api_client/v2/model/create_component_request_data_attributes_components_items.py +++ b/src/datadog_api_client/v2/model/create_component_request_data_attributes_components_items.py @@ -40,7 +40,7 @@ def __init__( self_, name: str, position: int, type: StatusPagesComponentGroupAttributesComponentsItemsType, **kwargs ): """ - + A component to be created within a group. :param name: The name of the grouped component. :type name: str diff --git a/src/datadog_api_client/v2/model/create_component_request_data_relationships.py b/src/datadog_api_client/v2/model/create_component_request_data_relationships.py index 73aaf7d506..0fc4192da1 100644 --- a/src/datadog_api_client/v2/model/create_component_request_data_relationships.py +++ b/src/datadog_api_client/v2/model/create_component_request_data_relationships.py @@ -38,7 +38,7 @@ def __init__(self_, group: Union[CreateComponentRequestDataRelationshipsGroup, U """ The supported relationships for creating a component. - :param group: + :param group: The group to create the component within. :type group: CreateComponentRequestDataRelationshipsGroup, optional """ if group is not unset: diff --git a/src/datadog_api_client/v2/model/create_component_request_data_relationships_group.py b/src/datadog_api_client/v2/model/create_component_request_data_relationships_group.py index 7df2c392b0..b7f4424a26 100644 --- a/src/datadog_api_client/v2/model/create_component_request_data_relationships_group.py +++ b/src/datadog_api_client/v2/model/create_component_request_data_relationships_group.py @@ -35,9 +35,9 @@ def openapi_types(_): def __init__(self_, data: Union[CreateComponentRequestDataRelationshipsGroupData, none_type], **kwargs): """ + The group to create the component within. - - :param data: + :param data: The data object identifying the group to create the component within. :type data: CreateComponentRequestDataRelationshipsGroupData, none_type """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/create_component_request_data_relationships_group_data.py b/src/datadog_api_client/v2/model/create_component_request_data_relationships_group_data.py index de3b395b3d..f965525582 100644 --- a/src/datadog_api_client/v2/model/create_component_request_data_relationships_group_data.py +++ b/src/datadog_api_client/v2/model/create_component_request_data_relationships_group_data.py @@ -35,7 +35,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPagesComponentGroupType, **kwargs): """ - + The data object identifying the group to create the component within. :param id: The ID of the group. :type id: UUID diff --git a/src/datadog_api_client/v2/model/create_connection_request.py b/src/datadog_api_client/v2/model/create_connection_request.py index 085c924395..f50b392997 100644 --- a/src/datadog_api_client/v2/model/create_connection_request.py +++ b/src/datadog_api_client/v2/model/create_connection_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CreateConnectionRequestData, UnsetType] = unset, **kwargs): """ + Request body for creating a new data source connection for an entity. - - :param data: + :param data: The data object containing the resource type and attributes for creating a new connection. :type data: CreateConnectionRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/create_connection_request_data.py b/src/datadog_api_client/v2/model/create_connection_request_data.py index ce3d8d6faf..c9d8db14cb 100644 --- a/src/datadog_api_client/v2/model/create_connection_request_data.py +++ b/src/datadog_api_client/v2/model/create_connection_request_data.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for creating a new connection. - - :param attributes: + :param attributes: Attributes defining the data source connection, including join configuration and custom fields. :type attributes: CreateConnectionRequestDataAttributes, optional - :param id: + :param id: Unique identifier for the new connection resource. :type id: str, optional :param type: Connection id resource type. diff --git a/src/datadog_api_client/v2/model/create_connection_request_data_attributes.py b/src/datadog_api_client/v2/model/create_connection_request_data_attributes.py index 554e99a101..eea108f412 100644 --- a/src/datadog_api_client/v2/model/create_connection_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/create_connection_request_data_attributes.py @@ -52,21 +52,21 @@ def __init__( **kwargs, ): """ + Attributes defining the data source connection, including join configuration and custom fields. - - :param fields: + :param fields: List of custom attribute fields to import from the data source. :type fields: [CreateConnectionRequestDataAttributesFieldsItems], optional - :param join_attribute: + :param join_attribute: The attribute in the data source used to join records with the entity. :type join_attribute: str - :param join_type: + :param join_type: The type of join key used to link the data source to the entity (for example, email or user_id). :type join_type: str - :param metadata: + :param metadata: Additional key-value metadata associated with the connection. :type metadata: {str: (str,)}, optional - :param type: + :param type: The type of data source connection (for example, ref_table). :type type: str """ if fields is not unset: diff --git a/src/datadog_api_client/v2/model/create_connection_request_data_attributes_fields_items.py b/src/datadog_api_client/v2/model/create_connection_request_data_attributes_fields_items.py index 33e3820763..f03731ab75 100644 --- a/src/datadog_api_client/v2/model/create_connection_request_data_attributes_fields_items.py +++ b/src/datadog_api_client/v2/model/create_connection_request_data_attributes_fields_items.py @@ -45,24 +45,24 @@ def __init__( **kwargs, ): """ + Definition of a custom attribute field to import from a data source connection. - - :param description: + :param description: Human-readable explanation of what the field represents. :type description: str, optional - :param display_name: + :param display_name: The human-readable label for the field shown in the UI. :type display_name: str, optional - :param groups: + :param groups: List of group labels used to categorize the field. :type groups: [str], optional - :param id: + :param id: The unique identifier for the field within the connection. :type id: str - :param source_name: + :param source_name: The name of the column or attribute in the source data system that maps to this field. :type source_name: str - :param type: + :param type: The data type of the field (for example, string or number). :type type: str """ if description is not unset: diff --git a/src/datadog_api_client/v2/model/create_degradation_request.py b/src/datadog_api_client/v2/model/create_degradation_request.py index dabff86c80..c6cf5e6385 100644 --- a/src/datadog_api_client/v2/model/create_degradation_request.py +++ b/src/datadog_api_client/v2/model/create_degradation_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CreateDegradationRequestData, UnsetType] = unset, **kwargs): """ + Request object for creating a degradation. - - :param data: + :param data: The data object for creating a degradation. :type data: CreateDegradationRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/create_degradation_request_data.py b/src/datadog_api_client/v2/model/create_degradation_request_data.py index cb1a703506..2daea435eb 100644 --- a/src/datadog_api_client/v2/model/create_degradation_request_data.py +++ b/src/datadog_api_client/v2/model/create_degradation_request_data.py @@ -40,7 +40,7 @@ def __init__( self_, attributes: CreateDegradationRequestDataAttributes, type: PatchDegradationRequestDataType, **kwargs ): """ - + The data object for creating a degradation. :param attributes: The supported attributes for creating a degradation. :type attributes: CreateDegradationRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/create_degradation_request_data_attributes_components_affected_items.py b/src/datadog_api_client/v2/model/create_degradation_request_data_attributes_components_affected_items.py index 675885d541..5405bec5b6 100644 --- a/src/datadog_api_client/v2/model/create_degradation_request_data_attributes_components_affected_items.py +++ b/src/datadog_api_client/v2/model/create_degradation_request_data_attributes_components_affected_items.py @@ -46,12 +46,12 @@ def __init__( self_, id: UUID, status: StatusPagesComponentDataAttributesStatus, name: Union[str, UnsetType] = unset, **kwargs ): """ - + A component affected by a degradation. :param id: The ID of the component. Must be a component of type ``component``. :type id: UUID - :param name: + :param name: The name of the component. :type name: str, optional :param status: The status of the component. diff --git a/src/datadog_api_client/v2/model/create_jira_issue_request_array.py b/src/datadog_api_client/v2/model/create_jira_issue_request_array.py index 03b3f9106c..710ac4007f 100644 --- a/src/datadog_api_client/v2/model/create_jira_issue_request_array.py +++ b/src/datadog_api_client/v2/model/create_jira_issue_request_array.py @@ -32,7 +32,7 @@ def __init__(self_, data: List[CreateJiraIssueRequestData], **kwargs): """ List of requests to create Jira issues for security findings. - :param data: + :param data: Array of Jira issue creation request data objects. :type data: [CreateJiraIssueRequestData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/create_maintenance_request.py b/src/datadog_api_client/v2/model/create_maintenance_request.py index 298def9423..5d6e13f62d 100644 --- a/src/datadog_api_client/v2/model/create_maintenance_request.py +++ b/src/datadog_api_client/v2/model/create_maintenance_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CreateMaintenanceRequestData, UnsetType] = unset, **kwargs): """ + Request object for creating a maintenance. - - :param data: + :param data: The data object for creating a maintenance. :type data: CreateMaintenanceRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/create_maintenance_request_data.py b/src/datadog_api_client/v2/model/create_maintenance_request_data.py index 943ce441b9..870dae4454 100644 --- a/src/datadog_api_client/v2/model/create_maintenance_request_data.py +++ b/src/datadog_api_client/v2/model/create_maintenance_request_data.py @@ -40,7 +40,7 @@ def __init__( self_, attributes: CreateMaintenanceRequestDataAttributes, type: PatchMaintenanceRequestDataType, **kwargs ): """ - + The data object for creating a maintenance. :param attributes: The supported attributes for creating a maintenance. :type attributes: CreateMaintenanceRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/create_maintenance_request_data_attributes_components_affected_items.py b/src/datadog_api_client/v2/model/create_maintenance_request_data_attributes_components_affected_items.py index bcf9b01636..95420acc86 100644 --- a/src/datadog_api_client/v2/model/create_maintenance_request_data_attributes_components_affected_items.py +++ b/src/datadog_api_client/v2/model/create_maintenance_request_data_attributes_components_affected_items.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + A component affected by a maintenance. :param id: The ID of the component. Must be a component of type ``component``. :type id: UUID diff --git a/src/datadog_api_client/v2/model/create_status_page_request.py b/src/datadog_api_client/v2/model/create_status_page_request.py index ec77fbd710..ae2cb03922 100644 --- a/src/datadog_api_client/v2/model/create_status_page_request.py +++ b/src/datadog_api_client/v2/model/create_status_page_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CreateStatusPageRequestData, UnsetType] = unset, **kwargs): """ + Request object for creating a status page. - - :param data: + :param data: The data object for creating a status page. :type data: CreateStatusPageRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/create_status_page_request_data.py b/src/datadog_api_client/v2/model/create_status_page_request_data.py index 96461cb03e..41f9c60566 100644 --- a/src/datadog_api_client/v2/model/create_status_page_request_data.py +++ b/src/datadog_api_client/v2/model/create_status_page_request_data.py @@ -38,7 +38,7 @@ def openapi_types(_): def __init__(self_, attributes: CreateStatusPageRequestDataAttributes, type: StatusPageDataType, **kwargs): """ - + The data object for creating a status page. :param attributes: The supported attributes for creating a status page. :type attributes: CreateStatusPageRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items.py b/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items.py index 703bbcdf2e..0bc5a1ffbd 100644 --- a/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items.py +++ b/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items.py @@ -72,7 +72,7 @@ def __init__( **kwargs, ): """ - + A component to be created on a status page. :param components: If creating a component of type ``group`` , the components to create within the group. :type components: [CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems], optional diff --git a/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items_components_items.py b/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items_components_items.py index c5e47092cd..df60179555 100644 --- a/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items_components_items.py +++ b/src/datadog_api_client/v2/model/create_status_page_request_data_attributes_components_items_components_items.py @@ -63,7 +63,7 @@ def __init__( **kwargs, ): """ - + A grouped component to be created within a status page component group. :param id: The ID of the grouped component. :type id: UUID, optional diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_data.py b/src/datadog_api_client/v2/model/create_tenancy_config_data.py index c9943b3816..aeae712b23 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_data.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes. - - :param attributes: + :param attributes: Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options. :type attributes: CreateTenancyConfigDataAttributes, optional - :param id: + :param id: The OCID of the OCI tenancy to configure. :type id: str :param type: OCI tenancy resource type. diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes.py b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes.py index f8c16d5b10..e1007290b2 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes.py @@ -89,39 +89,39 @@ def __init__( **kwargs, ): """ + Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options. - - :param auth_credentials: + :param auth_credentials: OCI API signing key credentials used to authenticate the Datadog integration with the OCI tenancy. :type auth_credentials: CreateTenancyConfigDataAttributesAuthCredentials - :param config_version: + :param config_version: Version number of the integration the tenancy is integrated with :type config_version: int, none_type, optional - :param cost_collection_enabled: + :param cost_collection_enabled: Whether cost data collection from OCI is enabled for the tenancy. :type cost_collection_enabled: bool, optional - :param dd_compartment_id: + :param dd_compartment_id: The OCID of the OCI compartment used by the Datadog integration stack. :type dd_compartment_id: str, optional - :param dd_stack_id: + :param dd_stack_id: The OCID of the OCI Resource Manager stack used by the Datadog integration. :type dd_stack_id: str, optional - :param home_region: + :param home_region: The home region of the OCI tenancy (for example, us-ashburn-1). :type home_region: str - :param logs_config: + :param logs_config: Log collection configuration for an OCI tenancy, controlling which compartments and services have log collection enabled. :type logs_config: CreateTenancyConfigDataAttributesLogsConfig, optional - :param metrics_config: + :param metrics_config: Metrics collection configuration for an OCI tenancy, controlling which compartments and services are included or excluded. :type metrics_config: CreateTenancyConfigDataAttributesMetricsConfig, optional - :param regions_config: + :param regions_config: Region configuration for an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. :type regions_config: CreateTenancyConfigDataAttributesRegionsConfig, optional - :param resource_collection_enabled: + :param resource_collection_enabled: Whether resource collection from OCI is enabled for the tenancy. :type resource_collection_enabled: bool, optional - :param user_ocid: + :param user_ocid: The OCID of the OCI user used by the Datadog integration for authentication. :type user_ocid: str """ if config_version is not unset: diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_auth_credentials.py b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_auth_credentials.py index fa6f4440b3..e9fe4864c5 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_auth_credentials.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_auth_credentials.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, private_key: str, fingerprint: Union[str, UnsetType] = unset, **kwargs): """ + OCI API signing key credentials used to authenticate the Datadog integration with the OCI tenancy. - - :param fingerprint: + :param fingerprint: The fingerprint of the OCI API signing key used for authentication. :type fingerprint: str, optional - :param private_key: + :param private_key: The PEM-encoded private key corresponding to the OCI API signing key fingerprint. :type private_key: str """ if fingerprint is not unset: diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_logs_config.py b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_logs_config.py index 9ccce26a33..9c9374ea67 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_logs_config.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_logs_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Log collection configuration for an OCI tenancy, controlling which compartments and services have log collection enabled. - - :param compartment_tag_filters: + :param compartment_tag_filters: List of compartment tag filters to scope log collection to specific compartments. :type compartment_tag_filters: [str], optional - :param enabled: + :param enabled: Whether log collection is enabled for the tenancy. :type enabled: bool, optional - :param enabled_services: + :param enabled_services: List of OCI service names for which log collection is enabled. :type enabled_services: [str], optional """ if compartment_tag_filters is not unset: diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_metrics_config.py b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_metrics_config.py index 14cfbdcda9..13439b1a4c 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_metrics_config.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_metrics_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Metrics collection configuration for an OCI tenancy, controlling which compartments and services are included or excluded. - - :param compartment_tag_filters: + :param compartment_tag_filters: List of compartment tag filters to scope metrics collection to specific compartments. :type compartment_tag_filters: [str], optional - :param enabled: + :param enabled: Whether metrics collection is enabled for the tenancy. :type enabled: bool, optional - :param excluded_services: + :param excluded_services: List of OCI service names to exclude from metrics collection. :type excluded_services: [str], optional """ if compartment_tag_filters is not unset: diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_regions_config.py b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_regions_config.py index 84f6ad7388..356ffd4ed4 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_regions_config.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_data_attributes_regions_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Region configuration for an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. - - :param available: + :param available: List of OCI regions available for data collection in the tenancy. :type available: [str], optional - :param disabled: + :param disabled: List of OCI regions explicitly disabled for data collection. :type disabled: [str], optional - :param enabled: + :param enabled: List of OCI regions enabled for data collection. :type enabled: [str], optional """ if available is not unset: diff --git a/src/datadog_api_client/v2/model/create_tenancy_config_request.py b/src/datadog_api_client/v2/model/create_tenancy_config_request.py index 9a17479840..8d42bb7f7f 100644 --- a/src/datadog_api_client/v2/model/create_tenancy_config_request.py +++ b/src/datadog_api_client/v2/model/create_tenancy_config_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: CreateTenancyConfigData, **kwargs): """ + Request body for creating a new OCI tenancy integration configuration. - - :param data: + :param data: The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes. :type data: CreateTenancyConfigData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/custom_rule.py b/src/datadog_api_client/v2/model/custom_rule.py index 80abe78467..398496b5cf 100644 --- a/src/datadog_api_client/v2/model/custom_rule.py +++ b/src/datadog_api_client/v2/model/custom_rule.py @@ -37,7 +37,7 @@ def openapi_types(_): def __init__(self_, created_at: datetime, created_by: str, last_revision: CustomRuleRevision, name: str, **kwargs): """ - + A custom static analysis rule within a ruleset. :param created_at: Creation timestamp :type created_at: datetime @@ -45,7 +45,7 @@ def __init__(self_, created_at: datetime, created_by: str, last_revision: Custom :param created_by: Creator identifier :type created_by: str - :param last_revision: + :param last_revision: A specific revision of a custom static analysis rule. :type last_revision: CustomRuleRevision :param name: Rule name diff --git a/src/datadog_api_client/v2/model/custom_rule_request.py b/src/datadog_api_client/v2/model/custom_rule_request.py index 8b3c4a5057..2a9f5ba966 100644 --- a/src/datadog_api_client/v2/model/custom_rule_request.py +++ b/src/datadog_api_client/v2/model/custom_rule_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CustomRuleRequestData, UnsetType] = unset, **kwargs): """ + Request body for creating or updating a custom rule. - - :param data: + :param data: Data object for a custom rule create or update request. :type data: CustomRuleRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/custom_rule_request_data.py b/src/datadog_api_client/v2/model/custom_rule_request_data.py index 88b24b7ec9..e42f96b0a3 100644 --- a/src/datadog_api_client/v2/model/custom_rule_request_data.py +++ b/src/datadog_api_client/v2/model/custom_rule_request_data.py @@ -44,9 +44,9 @@ def __init__( **kwargs, ): """ + Data object for a custom rule create or update request. - - :param attributes: + :param attributes: Attributes for creating or updating a custom rule. :type attributes: CustomRuleRequestDataAttributes, optional :param id: Rule identifier diff --git a/src/datadog_api_client/v2/model/custom_rule_request_data_attributes.py b/src/datadog_api_client/v2/model/custom_rule_request_data_attributes.py index 514334ebb1..be3527678f 100644 --- a/src/datadog_api_client/v2/model/custom_rule_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/custom_rule_request_data_attributes.py @@ -26,7 +26,7 @@ def openapi_types(_): def __init__(self_, name: Union[str, UnsetType] = unset, **kwargs): """ - + Attributes for creating or updating a custom rule. :param name: Rule name :type name: str, optional diff --git a/src/datadog_api_client/v2/model/custom_rule_response.py b/src/datadog_api_client/v2/model/custom_rule_response.py index 54cdd3a577..0ae45c138f 100644 --- a/src/datadog_api_client/v2/model/custom_rule_response.py +++ b/src/datadog_api_client/v2/model/custom_rule_response.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: CustomRuleResponseData, **kwargs): """ + Response containing a single custom rule. - - :param data: + :param data: Data object returned in a custom rule response, including its ID, type, and attributes. :type data: CustomRuleResponseData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/custom_rule_response_data.py b/src/datadog_api_client/v2/model/custom_rule_response_data.py index a1246c52a8..bebdc2be57 100644 --- a/src/datadog_api_client/v2/model/custom_rule_response_data.py +++ b/src/datadog_api_client/v2/model/custom_rule_response_data.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, attributes: CustomRule, id: str, type: CustomRuleDataType, **kwargs): """ + Data object returned in a custom rule response, including its ID, type, and attributes. - - :param attributes: + :param attributes: A custom static analysis rule within a ruleset. :type attributes: CustomRule :param id: Rule identifier diff --git a/src/datadog_api_client/v2/model/custom_rule_revision.py b/src/datadog_api_client/v2/model/custom_rule_revision.py index e72951feac..70d669edb2 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, attributes: CustomRuleRevisionAttributes, id: str, type: CustomRuleRevisionDataType, **kwargs): """ + A specific revision of a custom static analysis rule. - - :param attributes: + :param attributes: Attributes of a custom rule revision, including code, metadata, and test cases. :type attributes: CustomRuleRevisionAttributes :param id: Revision identifier diff --git a/src/datadog_api_client/v2/model/custom_rule_revision_attributes.py b/src/datadog_api_client/v2/model/custom_rule_revision_attributes.py index f362cbff54..5cfd65e182 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision_attributes.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision_attributes.py @@ -109,7 +109,7 @@ def __init__( **kwargs, ): """ - + Attributes of a custom rule revision, including code, metadata, and test cases. :param arguments: Rule arguments :type arguments: [Argument] diff --git a/src/datadog_api_client/v2/model/custom_rule_revision_input_attributes.py b/src/datadog_api_client/v2/model/custom_rule_revision_input_attributes.py index ad1e835dc8..395484173e 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision_input_attributes.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision_input_attributes.py @@ -99,7 +99,7 @@ def __init__( **kwargs, ): """ - + Input attributes for creating or updating a custom rule revision. :param arguments: Rule arguments :type arguments: [Argument] diff --git a/src/datadog_api_client/v2/model/custom_rule_revision_request.py b/src/datadog_api_client/v2/model/custom_rule_revision_request.py index e93edd0579..b24ab0a5e6 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision_request.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CustomRuleRevisionRequestData, UnsetType] = unset, **kwargs): """ + Request body for creating a new custom rule revision. - - :param data: + :param data: Data object for a custom rule revision create request. :type data: CustomRuleRevisionRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/custom_rule_revision_request_data.py b/src/datadog_api_client/v2/model/custom_rule_revision_request_data.py index 48eba295c5..26f27cc874 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision_request_data.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision_request_data.py @@ -44,9 +44,9 @@ def __init__( **kwargs, ): """ + Data object for a custom rule revision create request. - - :param attributes: + :param attributes: Input attributes for creating or updating a custom rule revision. :type attributes: CustomRuleRevisionInputAttributes, optional :param id: Revision identifier diff --git a/src/datadog_api_client/v2/model/custom_rule_revision_response.py b/src/datadog_api_client/v2/model/custom_rule_revision_response.py index 23ae664f11..99c579628f 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision_response.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision_response.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: CustomRuleRevision, **kwargs): """ + Response containing a single custom rule revision. - - :param data: + :param data: A specific revision of a custom static analysis rule. :type data: CustomRuleRevision """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/custom_rule_revision_test.py b/src/datadog_api_client/v2/model/custom_rule_revision_test.py index ad2c17a0c6..41058f5c43 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revision_test.py +++ b/src/datadog_api_client/v2/model/custom_rule_revision_test.py @@ -27,7 +27,7 @@ def openapi_types(_): def __init__(self_, annotation_count: int, code: str, filename: str, **kwargs): """ - + A test case associated with a custom rule revision, used to validate rule behavior. :param annotation_count: Expected violation count :type annotation_count: int diff --git a/src/datadog_api_client/v2/model/custom_rule_revisions_response.py b/src/datadog_api_client/v2/model/custom_rule_revisions_response.py index cebf0799db..9e580296e2 100644 --- a/src/datadog_api_client/v2/model/custom_rule_revisions_response.py +++ b/src/datadog_api_client/v2/model/custom_rule_revisions_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[List[CustomRuleRevision], UnsetType] = unset, **kwargs): """ + Response containing a paginated list of custom rule revisions. - - :param data: + :param data: List of custom rule revisions. :type data: [CustomRuleRevision], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/custom_ruleset.py b/src/datadog_api_client/v2/model/custom_ruleset.py index 10c64c7b7f..c95dfe7a7b 100644 --- a/src/datadog_api_client/v2/model/custom_ruleset.py +++ b/src/datadog_api_client/v2/model/custom_ruleset.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, attributes: CustomRulesetAttributes, id: str, type: CustomRulesetDataType, **kwargs): """ + A custom static analysis ruleset containing a set of user-defined rules. - - :param attributes: + :param attributes: Attributes of a custom ruleset, including its name, description, and rules. :type attributes: CustomRulesetAttributes :param id: Ruleset identifier diff --git a/src/datadog_api_client/v2/model/custom_ruleset_attributes.py b/src/datadog_api_client/v2/model/custom_ruleset_attributes.py index 893fe78c96..13a208022b 100644 --- a/src/datadog_api_client/v2/model/custom_ruleset_attributes.py +++ b/src/datadog_api_client/v2/model/custom_ruleset_attributes.py @@ -51,7 +51,7 @@ def __init__( **kwargs, ): """ - + Attributes of a custom ruleset, including its name, description, and rules. :param created_at: Creation timestamp :type created_at: datetime diff --git a/src/datadog_api_client/v2/model/custom_ruleset_request.py b/src/datadog_api_client/v2/model/custom_ruleset_request.py index 1a5f2cf4b0..515173bff3 100644 --- a/src/datadog_api_client/v2/model/custom_ruleset_request.py +++ b/src/datadog_api_client/v2/model/custom_ruleset_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[CustomRulesetRequestData, UnsetType] = unset, **kwargs): """ + Request body for creating or updating a custom ruleset. - - :param data: + :param data: Data object for a custom ruleset create or update request. :type data: CustomRulesetRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/custom_ruleset_request_data.py b/src/datadog_api_client/v2/model/custom_ruleset_request_data.py index 93a96c75cc..49803b80cf 100644 --- a/src/datadog_api_client/v2/model/custom_ruleset_request_data.py +++ b/src/datadog_api_client/v2/model/custom_ruleset_request_data.py @@ -46,9 +46,9 @@ def __init__( **kwargs, ): """ + Data object for a custom ruleset create or update request. - - :param attributes: + :param attributes: Attributes for creating or updating a custom ruleset. :type attributes: CustomRulesetRequestDataAttributes, optional :param id: Ruleset identifier diff --git a/src/datadog_api_client/v2/model/custom_ruleset_request_data_attributes.py b/src/datadog_api_client/v2/model/custom_ruleset_request_data_attributes.py index 303760c131..ec64f0d2d9 100644 --- a/src/datadog_api_client/v2/model/custom_ruleset_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/custom_ruleset_request_data_attributes.py @@ -46,7 +46,7 @@ def __init__( **kwargs, ): """ - + Attributes for creating or updating a custom ruleset. :param description: Base64-encoded full description :type description: str, optional diff --git a/src/datadog_api_client/v2/model/custom_ruleset_response.py b/src/datadog_api_client/v2/model/custom_ruleset_response.py index 2a738ef868..cfa853ee8b 100644 --- a/src/datadog_api_client/v2/model/custom_ruleset_response.py +++ b/src/datadog_api_client/v2/model/custom_ruleset_response.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: CustomRuleset, **kwargs): """ + Response containing a single custom ruleset. - - :param data: + :param data: A custom static analysis ruleset containing a set of user-defined rules. :type data: CustomRuleset """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/degradation.py b/src/datadog_api_client/v2/model/degradation.py index d42ea04daa..a2fbc2ce6d 100644 --- a/src/datadog_api_client/v2/model/degradation.py +++ b/src/datadog_api_client/v2/model/degradation.py @@ -43,9 +43,9 @@ def __init__( **kwargs, ): """ + Response object for a single degradation. - - :param data: + :param data: The data object for a degradation. :type data: DegradationData, optional :param included: The included related resources of a degradation. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/degradation_array.py b/src/datadog_api_client/v2/model/degradation_array.py index bfd3787fb3..b9ca6db320 100644 --- a/src/datadog_api_client/v2/model/degradation_array.py +++ b/src/datadog_api_client/v2/model/degradation_array.py @@ -51,9 +51,9 @@ def __init__( **kwargs, ): """ + Response object for a list of degradations. - - :param data: + :param data: A list of degradation data objects. :type data: [DegradationData] :param included: The included related resources of a degradation. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/degradation_data.py b/src/datadog_api_client/v2/model/degradation_data.py index d074a34027..9f4f19af6a 100644 --- a/src/datadog_api_client/v2/model/degradation_data.py +++ b/src/datadog_api_client/v2/model/degradation_data.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + The data object for a degradation. :param attributes: The attributes of a degradation. :type attributes: DegradationDataAttributes, optional diff --git a/src/datadog_api_client/v2/model/degradation_data_attributes_components_affected_items.py b/src/datadog_api_client/v2/model/degradation_data_attributes_components_affected_items.py index bbf6985b21..9a28363cca 100644 --- a/src/datadog_api_client/v2/model/degradation_data_attributes_components_affected_items.py +++ b/src/datadog_api_client/v2/model/degradation_data_attributes_components_affected_items.py @@ -46,7 +46,7 @@ def __init__( self_, id: UUID, status: StatusPagesComponentDataAttributesStatus, name: Union[str, UnsetType] = unset, **kwargs ): """ - + A component affected by a degradation. :param id: The ID of the component. :type id: UUID diff --git a/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items.py b/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items.py index bf10131591..9d179f973d 100644 --- a/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items.py +++ b/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items.py @@ -73,7 +73,7 @@ def __init__( **kwargs, ): """ - + A status update recorded during a degradation. :param components_affected: The components affected at the time of the update. :type components_affected: [DegradationDataAttributesUpdatesItemsComponentsAffectedItems], optional diff --git a/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items_components_affected_items.py b/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items_components_affected_items.py index 8fb286d7c5..dc9b5b422c 100644 --- a/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items_components_affected_items.py +++ b/src/datadog_api_client/v2/model/degradation_data_attributes_updates_items_components_affected_items.py @@ -46,7 +46,7 @@ def __init__( self_, id: UUID, status: StatusPagesComponentDataAttributesStatus, name: Union[str, UnsetType] = unset, **kwargs ): """ - + A component affected at the time of a degradation update. :param id: Identifier of the component affected at the time of the update. :type id: UUID diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships.py b/src/datadog_api_client/v2/model/degradation_data_relationships.py index 2b5cadfe7c..cd5c133eb2 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships.py @@ -60,13 +60,13 @@ def __init__( """ The relationships of a degradation. - :param created_by_user: + :param created_by_user: The Datadog user who created the degradation. :type created_by_user: DegradationDataRelationshipsCreatedByUser, optional - :param last_modified_by_user: + :param last_modified_by_user: The Datadog user who last modified the degradation. :type last_modified_by_user: DegradationDataRelationshipsLastModifiedByUser, optional - :param status_page: + :param status_page: The status page the degradation belongs to. :type status_page: DegradationDataRelationshipsStatusPage, optional """ if created_by_user is not unset: diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user.py b/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user.py index b4c4142d22..c7b46244f0 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: DegradationDataRelationshipsCreatedByUserData, **kwargs): """ + The Datadog user who created the degradation. - - :param data: + :param data: The data object identifying the Datadog user who created the degradation. :type data: DegradationDataRelationshipsCreatedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user_data.py b/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user_data.py index be305786f0..4684a22e00 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user_data.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships_created_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who created the degradation. :param id: The ID of the Datadog user who created the degradation. :type id: str diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user.py b/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user.py index 442c01e9a8..3a0a0f8149 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: DegradationDataRelationshipsLastModifiedByUserData, **kwargs): """ + The Datadog user who last modified the degradation. - - :param data: + :param data: The data object identifying the Datadog user who last modified the degradation. :type data: DegradationDataRelationshipsLastModifiedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user_data.py b/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user_data.py index 81df21f21f..b3d9ca3ce6 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user_data.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships_last_modified_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who last modified the degradation. :param id: The ID of the Datadog user who last modified the degradation. :type id: str diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships_status_page.py b/src/datadog_api_client/v2/model/degradation_data_relationships_status_page.py index 601fc8a24e..d875454a9e 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships_status_page.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships_status_page.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: DegradationDataRelationshipsStatusPageData, **kwargs): """ + The status page the degradation belongs to. - - :param data: + :param data: The data object identifying the status page the degradation belongs to. :type data: DegradationDataRelationshipsStatusPageData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/degradation_data_relationships_status_page_data.py b/src/datadog_api_client/v2/model/degradation_data_relationships_status_page_data.py index 82369ae59a..1290a6a251 100644 --- a/src/datadog_api_client/v2/model/degradation_data_relationships_status_page_data.py +++ b/src/datadog_api_client/v2/model/degradation_data_relationships_status_page_data.py @@ -33,7 +33,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPageDataType, **kwargs): """ - + The data object identifying the status page the degradation belongs to. :param id: The ID of the status page. :type id: UUID diff --git a/src/datadog_api_client/v2/model/degradation_included.py b/src/datadog_api_client/v2/model/degradation_included.py index bd19eee125..186139308c 100644 --- a/src/datadog_api_client/v2/model/degradation_included.py +++ b/src/datadog_api_client/v2/model/degradation_included.py @@ -13,7 +13,7 @@ class DegradationIncluded(ModelComposed): def __init__(self, **kwargs): """ - + An included resource related to a degradation or maintenance. :param attributes: Attributes of the Datadog user. :type attributes: StatusPagesUserAttributes, optional diff --git a/src/datadog_api_client/v2/model/deleted_suite_response_data.py b/src/datadog_api_client/v2/model/deleted_suite_response_data.py index 7862047d05..c7d10b77e5 100644 --- a/src/datadog_api_client/v2/model/deleted_suite_response_data.py +++ b/src/datadog_api_client/v2/model/deleted_suite_response_data.py @@ -46,12 +46,12 @@ def __init__( **kwargs, ): """ + Data object for a deleted Synthetic test suite. - - :param attributes: + :param attributes: Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID. :type attributes: DeletedSuiteResponseDataAttributes, optional - :param id: + :param id: The public ID of the deleted Synthetic test suite. :type id: str, optional :param type: Type for the Synthetics suites responses, ``suites``. diff --git a/src/datadog_api_client/v2/model/deleted_suite_response_data_attributes.py b/src/datadog_api_client/v2/model/deleted_suite_response_data_attributes.py index 58dc23ac18..9c00d7993a 100644 --- a/src/datadog_api_client/v2/model/deleted_suite_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/deleted_suite_response_data_attributes.py @@ -28,7 +28,7 @@ def openapi_types(_): def __init__(self_, deleted_at: Union[str, UnsetType] = unset, public_id: Union[str, UnsetType] = unset, **kwargs): """ - + Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID. :param deleted_at: Deletion timestamp of the Synthetic suite ID. :type deleted_at: str, optional diff --git a/src/datadog_api_client/v2/model/deleted_suites_request_delete.py b/src/datadog_api_client/v2/model/deleted_suites_request_delete.py index ba79c280d4..0e0328e224 100644 --- a/src/datadog_api_client/v2/model/deleted_suites_request_delete.py +++ b/src/datadog_api_client/v2/model/deleted_suites_request_delete.py @@ -48,15 +48,15 @@ def __init__( **kwargs, ): """ + Data object for a bulk delete Synthetic test suites request. - - :param attributes: + :param attributes: Attributes for a bulk delete Synthetic test suites request. :type attributes: DeletedSuitesRequestDeleteAttributes - :param id: + :param id: An optional identifier for the delete request. :type id: str, optional - :param type: + :param type: Type for the bulk delete Synthetic suites request, ``delete_suites_request``. :type type: DeletedSuitesRequestType, optional """ if id is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_suites_request_delete_attributes.py b/src/datadog_api_client/v2/model/deleted_suites_request_delete_attributes.py index d8b88938ae..dbc713c2ee 100644 --- a/src/datadog_api_client/v2/model/deleted_suites_request_delete_attributes.py +++ b/src/datadog_api_client/v2/model/deleted_suites_request_delete_attributes.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, public_ids: List[str], force_delete_dependencies: Union[bool, UnsetType] = unset, **kwargs): """ + Attributes for a bulk delete Synthetic test suites request. - - :param force_delete_dependencies: + :param force_delete_dependencies: Whether to force deletion of suites that have dependent resources. :type force_delete_dependencies: bool, optional - :param public_ids: + :param public_ids: List of public IDs of the Synthetic test suites to delete. :type public_ids: [str] """ if force_delete_dependencies is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_suites_request_delete_request.py b/src/datadog_api_client/v2/model/deleted_suites_request_delete_request.py index 9e8b5c0345..8ed8e726f0 100644 --- a/src/datadog_api_client/v2/model/deleted_suites_request_delete_request.py +++ b/src/datadog_api_client/v2/model/deleted_suites_request_delete_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: DeletedSuitesRequestDelete, **kwargs): """ + Request body for bulk deleting Synthetic test suites. - - :param data: + :param data: Data object for a bulk delete Synthetic test suites request. :type data: DeletedSuitesRequestDelete """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/deleted_suites_request_type.py b/src/datadog_api_client/v2/model/deleted_suites_request_type.py index a3aeab6e59..6f66e207bb 100644 --- a/src/datadog_api_client/v2/model/deleted_suites_request_type.py +++ b/src/datadog_api_client/v2/model/deleted_suites_request_type.py @@ -14,7 +14,7 @@ class DeletedSuitesRequestType(ModelSimple): """ - + Type for the bulk delete Synthetic suites request, `delete_suites_request`. :param value: If omitted defaults to "delete_suites_request". Must be one of ["delete_suites_request"]. :type value: str diff --git a/src/datadog_api_client/v2/model/deleted_suites_response.py b/src/datadog_api_client/v2/model/deleted_suites_response.py index 637ebf027d..01a9c4fb69 100644 --- a/src/datadog_api_client/v2/model/deleted_suites_response.py +++ b/src/datadog_api_client/v2/model/deleted_suites_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[List[DeletedSuiteResponseData], UnsetType] = unset, **kwargs): """ + Response containing the list of deleted Synthetic test suites. - - :param data: + :param data: List of deleted Synthetic suite data objects. :type data: [DeletedSuiteResponseData], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_test_response_data.py b/src/datadog_api_client/v2/model/deleted_test_response_data.py index f0e98b5aea..cb43b70877 100644 --- a/src/datadog_api_client/v2/model/deleted_test_response_data.py +++ b/src/datadog_api_client/v2/model/deleted_test_response_data.py @@ -44,15 +44,15 @@ def __init__( **kwargs, ): """ + Data object for a deleted Synthetic test. - - :param attributes: + :param attributes: Attributes of a deleted Synthetic test, including deletion timestamp and public ID. :type attributes: DeletedTestResponseDataAttributes, optional - :param id: + :param id: The public ID of the deleted Synthetic test. :type id: str, optional - :param type: + :param type: Type for the bulk delete Synthetic tests response, ``delete_tests``. :type type: DeletedTestsResponseType, optional """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_test_response_data_attributes.py b/src/datadog_api_client/v2/model/deleted_test_response_data_attributes.py index 18d8c71605..6d029d381d 100644 --- a/src/datadog_api_client/v2/model/deleted_test_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/deleted_test_response_data_attributes.py @@ -28,7 +28,7 @@ def openapi_types(_): def __init__(self_, deleted_at: Union[str, UnsetType] = unset, public_id: Union[str, UnsetType] = unset, **kwargs): """ - + Attributes of a deleted Synthetic test, including deletion timestamp and public ID. :param deleted_at: Deletion timestamp of the Synthetic test ID. :type deleted_at: str, optional diff --git a/src/datadog_api_client/v2/model/deleted_tests_request_delete.py b/src/datadog_api_client/v2/model/deleted_tests_request_delete.py index 2721b2e828..cd2860bb70 100644 --- a/src/datadog_api_client/v2/model/deleted_tests_request_delete.py +++ b/src/datadog_api_client/v2/model/deleted_tests_request_delete.py @@ -46,15 +46,15 @@ def __init__( **kwargs, ): """ + Data object for a bulk delete Synthetic tests request. - - :param attributes: + :param attributes: Attributes for a bulk delete Synthetic tests request. :type attributes: DeletedTestsRequestDeleteAttributes - :param id: + :param id: An optional identifier for the delete request. :type id: str, optional - :param type: + :param type: Type for the bulk delete Synthetic tests request, ``delete_tests_request``. :type type: DeletedTestsRequestType, optional """ if id is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_tests_request_delete_attributes.py b/src/datadog_api_client/v2/model/deleted_tests_request_delete_attributes.py index b4403cdbbc..27dcfbc09e 100644 --- a/src/datadog_api_client/v2/model/deleted_tests_request_delete_attributes.py +++ b/src/datadog_api_client/v2/model/deleted_tests_request_delete_attributes.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, public_ids: List[str], force_delete_dependencies: Union[bool, UnsetType] = unset, **kwargs): """ + Attributes for a bulk delete Synthetic tests request. - - :param force_delete_dependencies: + :param force_delete_dependencies: Whether to force deletion of tests that have dependent resources. :type force_delete_dependencies: bool, optional - :param public_ids: + :param public_ids: List of public IDs of the Synthetic tests to delete. :type public_ids: [str] """ if force_delete_dependencies is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_tests_request_delete_request.py b/src/datadog_api_client/v2/model/deleted_tests_request_delete_request.py index 141be88e0c..0762349e24 100644 --- a/src/datadog_api_client/v2/model/deleted_tests_request_delete_request.py +++ b/src/datadog_api_client/v2/model/deleted_tests_request_delete_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: DeletedTestsRequestDelete, **kwargs): """ + Request body for bulk deleting Synthetic tests. - - :param data: + :param data: Data object for a bulk delete Synthetic tests request. :type data: DeletedTestsRequestDelete """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/deleted_tests_request_type.py b/src/datadog_api_client/v2/model/deleted_tests_request_type.py index 985923552b..2f488b5684 100644 --- a/src/datadog_api_client/v2/model/deleted_tests_request_type.py +++ b/src/datadog_api_client/v2/model/deleted_tests_request_type.py @@ -14,7 +14,7 @@ class DeletedTestsRequestType(ModelSimple): """ - + Type for the bulk delete Synthetic tests request, `delete_tests_request`. :param value: If omitted defaults to "delete_tests_request". Must be one of ["delete_tests_request"]. :type value: str diff --git a/src/datadog_api_client/v2/model/deleted_tests_response.py b/src/datadog_api_client/v2/model/deleted_tests_response.py index 58c9af89ef..f8d7a66b29 100644 --- a/src/datadog_api_client/v2/model/deleted_tests_response.py +++ b/src/datadog_api_client/v2/model/deleted_tests_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[List[DeletedTestResponseData], UnsetType] = unset, **kwargs): """ + Response containing the list of deleted Synthetic tests. - - :param data: + :param data: List of deleted Synthetic test data objects. :type data: [DeletedTestResponseData], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/deleted_tests_response_type.py b/src/datadog_api_client/v2/model/deleted_tests_response_type.py index adca88dba8..8e7ad294ab 100644 --- a/src/datadog_api_client/v2/model/deleted_tests_response_type.py +++ b/src/datadog_api_client/v2/model/deleted_tests_response_type.py @@ -14,7 +14,7 @@ class DeletedTestsResponseType(ModelSimple): """ - + Type for the bulk delete Synthetic tests response, `delete_tests`. :param value: If omitted defaults to "delete_tests". Must be one of ["delete_tests"]. :type value: str diff --git a/src/datadog_api_client/v2/model/entity_response_array.py b/src/datadog_api_client/v2/model/entity_response_array.py index fefb158a7e..96140b8420 100644 --- a/src/datadog_api_client/v2/model/entity_response_array.py +++ b/src/datadog_api_client/v2/model/entity_response_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[PreviewEntityResponseData], **kwargs): """ + Response object containing an array of entity data items. - - :param data: + :param data: Array of entity response data items. :type data: [PreviewEntityResponseData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/entity_response_data_attributes.py b/src/datadog_api_client/v2/model/entity_response_data_attributes.py index 6bc2dfd0b0..2d945742e3 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/entity_response_data_attributes.py @@ -73,33 +73,33 @@ def __init__( **kwargs, ): """ + Entity response attributes containing core entity metadata fields. - - :param api_version: + :param api_version: The API version of the entity schema. :type api_version: str, optional - :param description: + :param description: A short description of the entity. :type description: str, optional - :param display_name: + :param display_name: The user-friendly display name of the entity. :type display_name: str, optional - :param kind: + :param kind: The kind of the entity (e.g. service, datastore, queue). :type kind: str, optional - :param name: + :param name: The unique name of the entity within its kind and namespace. :type name: str, optional - :param namespace: + :param namespace: The namespace the entity belongs to. :type namespace: str, optional - :param owner: + :param owner: The owner of the entity, usually a team. :type owner: str, optional - :param properties: + :param properties: Additional custom properties for the entity. :type properties: {str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional - :param tags: + :param tags: A set of custom tags assigned to the entity. :type tags: [str], optional """ if api_version is not unset: diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships.py b/src/datadog_api_client/v2/model/entity_response_data_relationships.py index 5b49391843..7a5ce85371 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships.py @@ -76,21 +76,21 @@ def __init__( **kwargs, ): """ + Entity relationships including incidents, oncalls, schemas, and related entities. - - :param incidents: + :param incidents: Incidents relationship containing a list of incident resources associated with this entity. :type incidents: EntityResponseDataRelationshipsIncidents, optional - :param oncalls: + :param oncalls: Oncalls relationship containing a list of oncall resources associated with this entity. :type oncalls: EntityResponseDataRelationshipsOncalls, optional - :param raw_schema: + :param raw_schema: Raw schema relationship linking an entity to its raw schema resource. :type raw_schema: EntityResponseDataRelationshipsRawSchema, optional - :param related_entities: + :param related_entities: Related entities relationship containing a list of entity references related to this entity. :type related_entities: EntityResponseDataRelationshipsRelatedEntities, optional - :param schema: + :param schema: Schema relationship linking an entity to its associated schema resource. :type schema: EntityResponseDataRelationshipsSchema, optional """ if incidents is not unset: diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents.py index 1b31e69f51..805f5ab712 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents.py @@ -38,9 +38,9 @@ def __init__( self_, data: Union[List[EntityResponseDataRelationshipsIncidentsDataItems], UnsetType] = unset, **kwargs ): """ + Incidents relationship containing a list of incident resources associated with this entity. - - :param data: + :param data: List of incident relationship data items. :type data: [EntityResponseDataRelationshipsIncidentsDataItems], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents_data_items.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents_data_items.py index f3bd2b4f5e..cc75bc6a84 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents_data_items.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_incidents_data_items.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, id: str, type: EntityResponseDataRelationshipsIncidentsDataItemsType, **kwargs): """ + Incident relationship data item containing the incident resource identifier and type. - - :param id: + :param id: Incident resource unique identifier. :type id: str :param type: Incident resource type. diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls.py index 2741f7cf1d..b960e2e449 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls.py @@ -38,9 +38,9 @@ def __init__( self_, data: Union[List[EntityResponseDataRelationshipsOncallsDataItems], UnsetType] = unset, **kwargs ): """ + Oncalls relationship containing a list of oncall resources associated with this entity. - - :param data: + :param data: List of oncall relationship data items. :type data: [EntityResponseDataRelationshipsOncallsDataItems], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls_data_items.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls_data_items.py index 5c5cd46ef3..a0705e20a9 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls_data_items.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_oncalls_data_items.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, id: str, type: EntityResponseDataRelationshipsOncallsDataItemsType, **kwargs): """ + Oncall relationship data item containing the oncall resource identifier and type. - - :param id: + :param id: Oncall resource unique identifier. :type id: str :param type: Oncall resource type. diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema.py index e7a7b32cab..4c685b35b8 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: EntityResponseDataRelationshipsRawSchemaData, **kwargs): """ + Raw schema relationship linking an entity to its raw schema resource. - - :param data: + :param data: Raw schema relationship data containing the raw schema resource identifier and type. :type data: EntityResponseDataRelationshipsRawSchemaData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema_data.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema_data.py index 1ecf175e1e..908a811f14 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema_data.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_raw_schema_data.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, id: str, type: EntityResponseDataRelationshipsRawSchemaDataType, **kwargs): """ + Raw schema relationship data containing the raw schema resource identifier and type. - - :param id: + :param id: Raw schema unique identifier. :type id: str :param type: Raw schema resource type. diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities.py index c8c1ef6674..c34ecb0c36 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities.py @@ -38,9 +38,9 @@ def __init__( self_, data: Union[List[EntityResponseDataRelationshipsRelatedEntitiesDataItems], UnsetType] = unset, **kwargs ): """ + Related entities relationship containing a list of entity references related to this entity. - - :param data: + :param data: List of related entity relationship data items. :type data: [EntityResponseDataRelationshipsRelatedEntitiesDataItems], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities_data_items.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities_data_items.py index 8b812cb184..1e31d00cb8 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities_data_items.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_related_entities_data_items.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, id: str, type: EntityResponseDataRelationshipsRelatedEntitiesDataItemsType, **kwargs): """ + Related entity relationship data item containing the related entity resource identifier and type. - - :param id: + :param id: Related entity unique identifier. :type id: str :param type: Related entity resource type. diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_schema.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_schema.py index 0438651fa6..e3fcfe2c43 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_schema.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_schema.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: EntityResponseDataRelationshipsSchemaData, **kwargs): """ + Schema relationship linking an entity to its associated schema resource. - - :param data: + :param data: Schema relationship data containing the schema resource identifier and type. :type data: EntityResponseDataRelationshipsSchemaData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/entity_response_data_relationships_schema_data.py b/src/datadog_api_client/v2/model/entity_response_data_relationships_schema_data.py index 8b0a183212..af5e3a5921 100644 --- a/src/datadog_api_client/v2/model/entity_response_data_relationships_schema_data.py +++ b/src/datadog_api_client/v2/model/entity_response_data_relationships_schema_data.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, id: str, type: EntityResponseDataRelationshipsSchemaDataType, **kwargs): """ + Schema relationship data containing the schema resource identifier and type. - - :param id: + :param id: Entity schema unique identifier. :type id: str :param type: Schema resource type. diff --git a/src/datadog_api_client/v2/model/facet_info_request.py b/src/datadog_api_client/v2/model/facet_info_request.py index 15625bcea6..79db1a90ec 100644 --- a/src/datadog_api_client/v2/model/facet_info_request.py +++ b/src/datadog_api_client/v2/model/facet_info_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[FacetInfoRequestData, UnsetType] = unset, **kwargs): """ + Request body for retrieving facet value information for a specified attribute with optional filtering. - - :param data: + :param data: The data object containing the resource type and attributes for the facet info request. :type data: FacetInfoRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_request_data.py b/src/datadog_api_client/v2/model/facet_info_request_data.py index a09e9b2851..a2f6d99547 100644 --- a/src/datadog_api_client/v2/model/facet_info_request_data.py +++ b/src/datadog_api_client/v2/model/facet_info_request_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for the facet info request. - - :param attributes: + :param attributes: Attributes for the facet info request, specifying which facet to query and optional filters to apply. :type attributes: FacetInfoRequestDataAttributes, optional - :param id: + :param id: Unique identifier for the facet info request resource. :type id: str, optional :param type: Users facet info request resource type. diff --git a/src/datadog_api_client/v2/model/facet_info_request_data_attributes.py b/src/datadog_api_client/v2/model/facet_info_request_data_attributes.py index 28bcf15ec1..0de07ed052 100644 --- a/src/datadog_api_client/v2/model/facet_info_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/facet_info_request_data_attributes.py @@ -55,18 +55,18 @@ def __init__( **kwargs, ): """ + Attributes for the facet info request, specifying which facet to query and optional filters to apply. - - :param facet_id: + :param facet_id: The identifier of the facet attribute to retrieve value information for. :type facet_id: str - :param limit: + :param limit: Maximum number of facet values to return in the response. :type limit: int - :param search: + :param search: Query-based search configuration for filtering the audience context when retrieving facet values. :type search: FacetInfoRequestDataAttributesSearch, optional - :param term_search: + :param term_search: Term-level search configuration for filtering facet values by an exact or partial term match. :type term_search: FacetInfoRequestDataAttributesTermSearch, optional """ if search is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_request_data_attributes_search.py b/src/datadog_api_client/v2/model/facet_info_request_data_attributes_search.py index 441992aeee..a1b0faa101 100644 --- a/src/datadog_api_client/v2/model/facet_info_request_data_attributes_search.py +++ b/src/datadog_api_client/v2/model/facet_info_request_data_attributes_search.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, query: Union[str, UnsetType] = unset, **kwargs): """ + Query-based search configuration for filtering the audience context when retrieving facet values. - - :param query: + :param query: The filter expression used to scope the audience from which facet values are retrieved. :type query: str, optional """ if query is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_request_data_attributes_term_search.py b/src/datadog_api_client/v2/model/facet_info_request_data_attributes_term_search.py index 288650b24f..f46d9229cf 100644 --- a/src/datadog_api_client/v2/model/facet_info_request_data_attributes_term_search.py +++ b/src/datadog_api_client/v2/model/facet_info_request_data_attributes_term_search.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, value: Union[str, UnsetType] = unset, **kwargs): """ + Term-level search configuration for filtering facet values by an exact or partial term match. - - :param value: + :param value: The term string to match against facet values. :type value: str, optional """ if value is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_response.py b/src/datadog_api_client/v2/model/facet_info_response.py index be69cbbf62..f2b0eae8aa 100644 --- a/src/datadog_api_client/v2/model/facet_info_response.py +++ b/src/datadog_api_client/v2/model/facet_info_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[FacetInfoResponseData, UnsetType] = unset, **kwargs): """ + Response containing facet information for an attribute, including its distinct values and occurrence counts. - - :param data: + :param data: The data object containing the resource type and attributes for the facet info response. :type data: FacetInfoResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_response_data.py b/src/datadog_api_client/v2/model/facet_info_response_data.py index 088cffd28e..c07e391b38 100644 --- a/src/datadog_api_client/v2/model/facet_info_response_data.py +++ b/src/datadog_api_client/v2/model/facet_info_response_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for the facet info response. - - :param attributes: + :param attributes: Attributes of the facet info response, containing the facet result data. :type attributes: FacetInfoResponseDataAttributes, optional - :param id: + :param id: Unique identifier for the facet info response resource. :type id: str, optional :param type: Users facet info resource type. diff --git a/src/datadog_api_client/v2/model/facet_info_response_data_attributes.py b/src/datadog_api_client/v2/model/facet_info_response_data_attributes.py index c74082b79e..1789a037fa 100644 --- a/src/datadog_api_client/v2/model/facet_info_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/facet_info_response_data_attributes.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, result: Union[FacetInfoResponseDataAttributesResult, UnsetType] = unset, **kwargs): """ + Attributes of the facet info response, containing the facet result data. - - :param result: + :param result: The facet query result containing discrete value counts or a numeric range for the requested facet. :type result: FacetInfoResponseDataAttributesResult, optional """ if result is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result.py b/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result.py index 634767e3c7..7f54336410 100644 --- a/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result.py +++ b/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result.py @@ -49,12 +49,12 @@ def __init__( **kwargs, ): """ + The facet query result containing discrete value counts or a numeric range for the requested facet. - - :param range: + :param range: The numeric range of a facet attribute, representing the minimum and maximum observed values. :type range: FacetInfoResponseDataAttributesResultRange, optional - :param values: + :param values: List of discrete facet values with their occurrence counts. :type values: [FacetInfoResponseDataAttributesResultValuesItems], optional """ if range is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_range.py b/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_range.py index 073e471ce5..3f37090338 100644 --- a/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_range.py +++ b/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_range.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, max: Union[dict, UnsetType] = unset, min: Union[dict, UnsetType] = unset, **kwargs): """ + The numeric range of a facet attribute, representing the minimum and maximum observed values. - - :param max: + :param max: The maximum observed value for the numeric facet attribute. :type max: dict, optional - :param min: + :param min: The minimum observed value for the numeric facet attribute. :type min: dict, optional """ if max is not unset: diff --git a/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_values_items.py b/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_values_items.py index e232a60df5..d79f95896a 100644 --- a/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_values_items.py +++ b/src/datadog_api_client/v2/model/facet_info_response_data_attributes_result_values_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, count: Union[int, UnsetType] = unset, value: Union[str, UnsetType] = unset, **kwargs): """ + A single facet value with its occurrence count in the dataset. - - :param count: + :param count: The number of records that have this facet value. :type count: int, optional - :param value: + :param value: The facet value (for example, a browser name or country code). :type value: str, optional """ if count is not unset: diff --git a/src/datadog_api_client/v2/model/finding_case_response_array.py b/src/datadog_api_client/v2/model/finding_case_response_array.py index 81b9d644a6..1f6814f2fd 100644 --- a/src/datadog_api_client/v2/model/finding_case_response_array.py +++ b/src/datadog_api_client/v2/model/finding_case_response_array.py @@ -32,7 +32,7 @@ def __init__(self_, data: List[FindingCaseResponseData], **kwargs): """ List of case responses. - :param data: + :param data: Array of case response data objects. :type data: [FindingCaseResponseData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/finding_case_response_data_attributes.py b/src/datadog_api_client/v2/model/finding_case_response_data_attributes.py index 1316817fa4..d36b899f78 100644 --- a/src/datadog_api_client/v2/model/finding_case_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/finding_case_response_data_attributes.py @@ -100,7 +100,7 @@ def __init__( :param assigned_to: Relationship to user. :type assigned_to: RelationshipToUser, optional - :param attributes: + :param attributes: Custom attributes associated with the case as key-value pairs where values are string arrays. :type attributes: {str: ([str],)}, optional :param closed_at: Timestamp of when the case was closed. diff --git a/src/datadog_api_client/v2/model/finding_data.py b/src/datadog_api_client/v2/model/finding_data.py index d3852173ba..29f171c1ee 100644 --- a/src/datadog_api_client/v2/model/finding_data.py +++ b/src/datadog_api_client/v2/model/finding_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: FindingDataType, **kwargs): """ - + Data object representing a security finding. :param id: Unique identifier of the security finding. :type id: str diff --git a/src/datadog_api_client/v2/model/findings.py b/src/datadog_api_client/v2/model/findings.py index dadc91ca7d..1f1e5396d3 100644 --- a/src/datadog_api_client/v2/model/findings.py +++ b/src/datadog_api_client/v2/model/findings.py @@ -34,7 +34,7 @@ def __init__(self_, data: Union[List[FindingData], UnsetType] = unset, **kwargs) """ A list of security findings. - :param data: + :param data: Array of security finding data objects. :type data: [FindingData], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/fleet_agent_attributes_tags_items.py b/src/datadog_api_client/v2/model/fleet_agent_attributes_tags_items.py index 4d0bb0e3aa..4a27c256b1 100644 --- a/src/datadog_api_client/v2/model/fleet_agent_attributes_tags_items.py +++ b/src/datadog_api_client/v2/model/fleet_agent_attributes_tags_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, key: Union[str, UnsetType] = unset, value: Union[str, UnsetType] = unset, **kwargs): """ + A key-value pair representing a tag associated with a Datadog Agent. - - :param key: + :param key: The tag key. :type key: str, optional - :param value: + :param value: The tag value. :type value: str, optional """ if key is not unset: diff --git a/src/datadog_api_client/v2/model/fleet_agent_version.py b/src/datadog_api_client/v2/model/fleet_agent_version.py index d2c6d85e62..a4a622a6ad 100644 --- a/src/datadog_api_client/v2/model/fleet_agent_version.py +++ b/src/datadog_api_client/v2/model/fleet_agent_version.py @@ -46,7 +46,7 @@ def __init__( """ Represents an available Datadog Agent version. - :param attributes: + :param attributes: Attributes of an available Datadog Agent version. :type attributes: FleetAgentVersionAttributes, optional :param id: Unique identifier for the Agent version (same as version). diff --git a/src/datadog_api_client/v2/model/fleet_agent_version_attributes.py b/src/datadog_api_client/v2/model/fleet_agent_version_attributes.py index 1718673002..7dad7f5cc0 100644 --- a/src/datadog_api_client/v2/model/fleet_agent_version_attributes.py +++ b/src/datadog_api_client/v2/model/fleet_agent_version_attributes.py @@ -26,7 +26,7 @@ def openapi_types(_): def __init__(self_, version: Union[str, UnsetType] = unset, **kwargs): """ - + Attributes of an available Datadog Agent version. :param version: The Agent version string. :type version: str, optional diff --git a/src/datadog_api_client/v2/model/fleet_agents_response_data.py b/src/datadog_api_client/v2/model/fleet_agents_response_data.py index d09b3081a4..13dca8efc0 100644 --- a/src/datadog_api_client/v2/model/fleet_agents_response_data.py +++ b/src/datadog_api_client/v2/model/fleet_agents_response_data.py @@ -36,7 +36,7 @@ def __init__(self_, attributes: FleetAgentsResponseDataAttributes, id: str, type """ The response data containing status and agents array. - :param attributes: + :param attributes: Attributes of the fleet agents response containing the list of agents. :type attributes: FleetAgentsResponseDataAttributes :param id: Status identifier. diff --git a/src/datadog_api_client/v2/model/fleet_agents_response_data_attributes.py b/src/datadog_api_client/v2/model/fleet_agents_response_data_attributes.py index 3a66bca439..09f25ddfce 100644 --- a/src/datadog_api_client/v2/model/fleet_agents_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/fleet_agents_response_data_attributes.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, agents: Union[List[FleetAgentAttributes], UnsetType] = unset, **kwargs): """ - + Attributes of the fleet agents response containing the list of agents. :param agents: Array of agents matching the query criteria. :type agents: [FleetAgentAttributes], optional diff --git a/src/datadog_api_client/v2/model/get_mapping_response.py b/src/datadog_api_client/v2/model/get_mapping_response.py index 8a09dcccb1..8bcee580bf 100644 --- a/src/datadog_api_client/v2/model/get_mapping_response.py +++ b/src/datadog_api_client/v2/model/get_mapping_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[GetMappingResponseData, UnsetType] = unset, **kwargs): """ + Response containing the entity attribute mapping configuration including all available attributes and their properties. - - :param data: + :param data: The data object containing the resource type and attributes for the get mapping response. :type data: GetMappingResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/get_mapping_response_data.py b/src/datadog_api_client/v2/model/get_mapping_response_data.py index 7b6ec73641..d6b7aeb763 100644 --- a/src/datadog_api_client/v2/model/get_mapping_response_data.py +++ b/src/datadog_api_client/v2/model/get_mapping_response_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for the get mapping response. - - :param attributes: + :param attributes: Attributes of the get mapping response, containing the list of configured entity attributes. :type attributes: GetMappingResponseDataAttributes, optional - :param id: + :param id: Unique identifier for the get mapping response resource. :type id: str, optional :param type: Get mappings response resource type. diff --git a/src/datadog_api_client/v2/model/get_mapping_response_data_attributes.py b/src/datadog_api_client/v2/model/get_mapping_response_data_attributes.py index 9d192025d4..5a90666eb6 100644 --- a/src/datadog_api_client/v2/model/get_mapping_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/get_mapping_response_data_attributes.py @@ -38,9 +38,9 @@ def __init__( self_, attributes: Union[List[GetMappingResponseDataAttributesAttributesItems], UnsetType] = unset, **kwargs ): """ + Attributes of the get mapping response, containing the list of configured entity attributes. - - :param attributes: + :param attributes: The list of entity attributes and their mapping configurations. :type attributes: [GetMappingResponseDataAttributesAttributesItems], optional """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/get_mapping_response_data_attributes_attributes_items.py b/src/datadog_api_client/v2/model/get_mapping_response_data_attributes_attributes_items.py index 15520bf671..81b45582c4 100644 --- a/src/datadog_api_client/v2/model/get_mapping_response_data_attributes_attributes_items.py +++ b/src/datadog_api_client/v2/model/get_mapping_response_data_attributes_attributes_items.py @@ -45,24 +45,24 @@ def __init__( **kwargs, ): """ + Details of a single entity attribute including its mapping configuration and metadata. - - :param attribute: + :param attribute: The attribute identifier as used in the entity data model. :type attribute: str, optional - :param description: + :param description: Human-readable explanation of what the attribute represents. :type description: str, optional - :param display_name: + :param display_name: The human-readable label for the attribute shown in the UI. :type display_name: str, optional - :param groups: + :param groups: List of group labels used to categorize the attribute. :type groups: [str], optional - :param is_custom: + :param is_custom: Whether this attribute is a custom user-defined attribute rather than a built-in one. :type is_custom: bool, optional - :param type: + :param type: The data type of the attribute (for example, string or number). :type type: str, optional """ if attribute is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_request.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_request.py index 2eb88d20ff..63831a237d 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_request.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[GetMultipleRulesetsRequestData, UnsetType] = unset, **kwargs): """ + The request payload for retrieving rules for multiple rulesets in a single batch call. - - :param data: + :param data: The primary data object in the get-multiple-rulesets request, containing request attributes and resource type. :type data: GetMultipleRulesetsRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data.py index 543423629a..deec2e710a 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data.py @@ -50,12 +50,12 @@ def __init__( **kwargs, ): """ + The primary data object in the get-multiple-rulesets request, containing request attributes and resource type. - - :param attributes: + :param attributes: The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include. :type attributes: GetMultipleRulesetsRequestDataAttributes, optional - :param id: + :param id: An optional identifier for the get-multiple-rulesets request resource. :type id: str, optional :param type: Get multiple rulesets request resource type. diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data_attributes.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data_attributes.py index 519830e923..b99f544158 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_request_data_attributes.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include. - - :param include_testing_rules: + :param include_testing_rules: When true, rules that are available in testing mode are included in the response. :type include_testing_rules: bool, optional - :param include_tests: + :param include_tests: When true, test cases associated with each rule are included in the response. :type include_tests: bool, optional - :param rulesets: + :param rulesets: The list of ruleset names to retrieve. :type rulesets: [str], optional """ if include_testing_rules is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response.py index 7b3d129e5a..91ea450473 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[GetMultipleRulesetsResponseData, UnsetType] = unset, **kwargs): """ + The response payload for the get-multiple-rulesets endpoint, containing the requested rulesets and their rules. - - :param data: + :param data: The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type. :type data: GetMultipleRulesetsResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data.py index 70eccbadba..9a553abb5d 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data.py @@ -50,12 +50,12 @@ def __init__( **kwargs, ): """ + The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type. - - :param attributes: + :param attributes: The attributes of the get-multiple-rulesets response, containing the list of requested rulesets. :type attributes: GetMultipleRulesetsResponseDataAttributes, optional - :param id: + :param id: The unique identifier of the get-multiple-rulesets response resource. :type id: str, optional :param type: Get multiple rulesets response resource type. diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes.py index 97a43e1ea9..da844379a5 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes.py @@ -40,9 +40,9 @@ def __init__( **kwargs, ): """ + The attributes of the get-multiple-rulesets response, containing the list of requested rulesets. - - :param rulesets: + :param rulesets: The list of rulesets returned in response to the batch request. :type rulesets: [GetMultipleRulesetsResponseDataAttributesRulesetsItems], optional """ if rulesets is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items.py index a4383173db..fc3a10881f 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items.py @@ -58,21 +58,21 @@ def __init__( **kwargs, ): """ + A ruleset returned in the response, containing its metadata and associated rules. - - :param data: + :param data: The resource identifier and type for a ruleset. :type data: GetMultipleRulesetsResponseDataAttributesRulesetsItemsData - :param description: + :param description: A detailed description of the ruleset's purpose and the types of issues it targets. :type description: str, optional - :param name: + :param name: The unique name of the ruleset. :type name: str, optional - :param rules: + :param rules: The list of static analysis rules included in this ruleset. :type rules: [GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems], optional - :param short_description: + :param short_description: A brief summary of the ruleset, suitable for display in listings. :type short_description: str, optional """ if description is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_data.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_data.py index 6764f5d7f3..8710b6bdeb 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_data.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_data.py @@ -43,9 +43,9 @@ def __init__( **kwargs, ): """ + The resource identifier and type for a ruleset. - - :param id: + :param id: The unique identifier of the ruleset resource. :type id: str, optional :param type: Rulesets resource type. diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.py index 38b25956c6..53a105719d 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.py @@ -129,81 +129,81 @@ def __init__( **kwargs, ): """ + A static analysis rule within a ruleset, including its definition, metadata, and associated test cases. - - :param arguments: + :param arguments: The list of configurable arguments accepted by this rule. :type arguments: [GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems], optional - :param category: + :param category: The category classifying the type of issue this rule detects (e.g., security, style, performance). :type category: str, optional - :param checksum: + :param checksum: A checksum of the rule definition used to detect changes. :type checksum: str, optional - :param code: + :param code: The rule implementation code used by the static analysis engine. :type code: str, optional - :param created_at: + :param created_at: The date and time when the rule was created. :type created_at: datetime, optional - :param created_by: + :param created_by: The identifier of the user or system that created the rule. :type created_by: str, optional - :param cve: + :param cve: The CVE identifier associated with the vulnerability this rule detects, if applicable. :type cve: str, optional - :param cwe: + :param cwe: The CWE identifier associated with the weakness category this rule detects, if applicable. :type cwe: str, optional - :param data: + :param data: The resource identifier and type for a static analysis rule. :type data: GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData - :param description: + :param description: A detailed explanation of what the rule detects and why it matters. :type description: str, optional - :param documentation_url: + :param documentation_url: A URL pointing to additional documentation for this rule. :type documentation_url: str, optional - :param entity_checked: + :param entity_checked: The code entity type (e.g., function, class, variable) that this rule inspects. :type entity_checked: str, optional - :param is_published: + :param is_published: Indicates whether the rule is publicly published and available to all users. :type is_published: bool, optional - :param is_testing: + :param is_testing: Indicates whether the rule is in testing mode and not yet promoted to production. :type is_testing: bool, optional - :param language: + :param language: The programming language this rule applies to. :type language: str, optional - :param last_updated_at: + :param last_updated_at: The date and time when the rule was last modified. :type last_updated_at: datetime, optional - :param last_updated_by: + :param last_updated_by: The identifier of the user or system that last updated the rule. :type last_updated_by: str, optional - :param name: + :param name: The unique name identifying this rule within its ruleset. :type name: str, optional - :param regex: + :param regex: A regular expression pattern used by the rule for pattern-based detection. :type regex: str, optional - :param severity: + :param severity: The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE). :type severity: str, optional - :param short_description: + :param short_description: A brief summary of what the rule detects, suitable for display in listings. :type short_description: str, optional - :param should_use_ai_fix: + :param should_use_ai_fix: Indicates whether an AI-generated fix suggestion should be offered for findings from this rule. :type should_use_ai_fix: bool, optional - :param tests: + :param tests: The list of test cases used to validate the rule's behavior. :type tests: [GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems], optional - :param tree_sitter_query: + :param tree_sitter_query: The Tree-sitter query expression used by the rule to match code patterns in the AST. :type tree_sitter_query: str, optional - :param type: + :param type: The rule type indicating the detection mechanism used (e.g., tree_sitter, regex). :type type: str, optional """ if arguments is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_arguments_items.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_arguments_items.py index 5d2ae444a2..f1959a9ee4 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_arguments_items.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_arguments_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, description: Union[str, UnsetType] = unset, name: Union[str, UnsetType] = unset, **kwargs): """ + An argument parameter for a static analysis rule, with a name and description. - - :param description: + :param description: A human-readable explanation of the argument's purpose and accepted values. :type description: str, optional - :param name: + :param name: The name of the rule argument. :type name: str, optional """ if description is not unset: diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_data.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_data.py index 2e04ceb620..f6828d0547 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_data.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_data.py @@ -43,9 +43,9 @@ def __init__( **kwargs, ): """ + The resource identifier and type for a static analysis rule. - - :param id: + :param id: The unique identifier of the rule resource. :type id: str, optional :param type: Rules resource type. diff --git a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_tests_items.py b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_tests_items.py index 67b3f5fc68..571fa5136e 100644 --- a/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_tests_items.py +++ b/src/datadog_api_client/v2/model/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_tests_items.py @@ -43,15 +43,15 @@ def __init__( **kwargs, ): """ + A test case associated with a static analysis rule, containing the source code and expected annotation count. - - :param annotation_count: + :param annotation_count: The expected number of annotations (findings) the rule should produce when run against the test code. :type annotation_count: int, optional - :param code: + :param code: The source code snippet used as input for the rule test. :type code: str, optional - :param filename: + :param filename: The filename associated with the test code snippet. :type filename: str, optional """ if annotation_count is not unset: diff --git a/src/datadog_api_client/v2/model/global_incident_settings_data_request.py b/src/datadog_api_client/v2/model/global_incident_settings_data_request.py index 892510b65e..e4fcad1411 100644 --- a/src/datadog_api_client/v2/model/global_incident_settings_data_request.py +++ b/src/datadog_api_client/v2/model/global_incident_settings_data_request.py @@ -45,7 +45,7 @@ def __init__( **kwargs, ): """ - + Data object in the global incident settings request. :param attributes: Global incident settings attributes :type attributes: GlobalIncidentSettingsAttributesRequest, optional diff --git a/src/datadog_api_client/v2/model/global_incident_settings_data_response.py b/src/datadog_api_client/v2/model/global_incident_settings_data_response.py index 85e1f863f0..7bcc0a3779 100644 --- a/src/datadog_api_client/v2/model/global_incident_settings_data_response.py +++ b/src/datadog_api_client/v2/model/global_incident_settings_data_response.py @@ -42,7 +42,7 @@ def __init__( self_, attributes: GlobalIncidentSettingsAttributesResponse, id: str, type: GlobalIncidentSettingsType, **kwargs ): """ - + Data object in the global incident settings response. :param attributes: Global incident settings attributes :type attributes: GlobalIncidentSettingsAttributesResponse diff --git a/src/datadog_api_client/v2/model/global_incident_settings_request.py b/src/datadog_api_client/v2/model/global_incident_settings_request.py index b25ef09d2d..dff93c64ac 100644 --- a/src/datadog_api_client/v2/model/global_incident_settings_request.py +++ b/src/datadog_api_client/v2/model/global_incident_settings_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: GlobalIncidentSettingsDataRequest, **kwargs): """ + Request payload for updating global incident settings. - - :param data: + :param data: Data object in the global incident settings request. :type data: GlobalIncidentSettingsDataRequest """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/global_incident_settings_response.py b/src/datadog_api_client/v2/model/global_incident_settings_response.py index c4664ea2b8..8a2bf280f4 100644 --- a/src/datadog_api_client/v2/model/global_incident_settings_response.py +++ b/src/datadog_api_client/v2/model/global_incident_settings_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: GlobalIncidentSettingsDataResponse, **kwargs): """ + Response payload containing global incident settings. - - :param data: + :param data: Data object in the global incident settings response. :type data: GlobalIncidentSettingsDataResponse """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/global_variable_json_patch_request.py b/src/datadog_api_client/v2/model/global_variable_json_patch_request.py index bd40589abd..7110eb096f 100644 --- a/src/datadog_api_client/v2/model/global_variable_json_patch_request.py +++ b/src/datadog_api_client/v2/model/global_variable_json_patch_request.py @@ -34,7 +34,7 @@ def __init__(self_, data: GlobalVariableJsonPatchRequestData, **kwargs): """ JSON Patch request for global variable. - :param data: + :param data: Data object for a JSON Patch request on a Synthetic global variable. :type data: GlobalVariableJsonPatchRequestData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/global_variable_json_patch_request_data.py b/src/datadog_api_client/v2/model/global_variable_json_patch_request_data.py index 00339f550d..7d2edf921e 100644 --- a/src/datadog_api_client/v2/model/global_variable_json_patch_request_data.py +++ b/src/datadog_api_client/v2/model/global_variable_json_patch_request_data.py @@ -45,9 +45,9 @@ def __init__( **kwargs, ): """ + Data object for a JSON Patch request on a Synthetic global variable. - - :param attributes: + :param attributes: Attributes for a JSON Patch request on a Synthetic global variable. :type attributes: GlobalVariableJsonPatchRequestDataAttributes, optional :param type: Global variable JSON Patch type. diff --git a/src/datadog_api_client/v2/model/global_variable_json_patch_request_data_attributes.py b/src/datadog_api_client/v2/model/global_variable_json_patch_request_data_attributes.py index 46808a7afd..a2b51e734a 100644 --- a/src/datadog_api_client/v2/model/global_variable_json_patch_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/global_variable_json_patch_request_data_attributes.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, json_patch: Union[List[JsonPatchOperation], UnsetType] = unset, **kwargs): """ - + Attributes for a JSON Patch request on a Synthetic global variable. :param json_patch: JSON Patch operations following RFC 6902. :type json_patch: [JsonPatchOperation], optional diff --git a/src/datadog_api_client/v2/model/hamr_org_connection_attributes_request.py b/src/datadog_api_client/v2/model/hamr_org_connection_attributes_request.py index adfc4db8ff..b307c21b9b 100644 --- a/src/datadog_api_client/v2/model/hamr_org_connection_attributes_request.py +++ b/src/datadog_api_client/v2/model/hamr_org_connection_attributes_request.py @@ -49,7 +49,7 @@ def __init__( **kwargs, ): """ - + Attributes for a HAMR organization connection request. :param hamr_status: Status of the HAMR connection: diff --git a/src/datadog_api_client/v2/model/hamr_org_connection_attributes_response.py b/src/datadog_api_client/v2/model/hamr_org_connection_attributes_response.py index 16a0691e5a..6637ef0166 100644 --- a/src/datadog_api_client/v2/model/hamr_org_connection_attributes_response.py +++ b/src/datadog_api_client/v2/model/hamr_org_connection_attributes_response.py @@ -52,7 +52,7 @@ def __init__( **kwargs, ): """ - + Attributes of a HAMR organization connection response. :param hamr_status: Status of the HAMR connection: diff --git a/src/datadog_api_client/v2/model/hamr_org_connection_data_request.py b/src/datadog_api_client/v2/model/hamr_org_connection_data_request.py index 219c61f535..8deb8c2cf9 100644 --- a/src/datadog_api_client/v2/model/hamr_org_connection_data_request.py +++ b/src/datadog_api_client/v2/model/hamr_org_connection_data_request.py @@ -38,9 +38,9 @@ def openapi_types(_): def __init__(self_, attributes: HamrOrgConnectionAttributesRequest, id: str, type: HamrOrgConnectionType, **kwargs): """ + Data object for a HAMR organization connection request. - - :param attributes: + :param attributes: Attributes for a HAMR organization connection request. :type attributes: HamrOrgConnectionAttributesRequest :param id: The organization UUID for this HAMR connection. Must match the authenticated organization's UUID. diff --git a/src/datadog_api_client/v2/model/hamr_org_connection_data_response.py b/src/datadog_api_client/v2/model/hamr_org_connection_data_response.py index 7457555958..2a660e066a 100644 --- a/src/datadog_api_client/v2/model/hamr_org_connection_data_response.py +++ b/src/datadog_api_client/v2/model/hamr_org_connection_data_response.py @@ -40,9 +40,9 @@ def __init__( self_, attributes: HamrOrgConnectionAttributesResponse, id: str, type: HamrOrgConnectionType, **kwargs ): """ + Data object for a HAMR organization connection response. - - :param attributes: + :param attributes: Attributes of a HAMR organization connection response. :type attributes: HamrOrgConnectionAttributesResponse :param id: The organization UUID for this HAMR connection. diff --git a/src/datadog_api_client/v2/model/hamr_org_connection_request.py b/src/datadog_api_client/v2/model/hamr_org_connection_request.py index 212011f49f..ff79d279d2 100644 --- a/src/datadog_api_client/v2/model/hamr_org_connection_request.py +++ b/src/datadog_api_client/v2/model/hamr_org_connection_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: HamrOrgConnectionDataRequest, **kwargs): """ + Request payload for creating or updating a HAMR organization connection. - - :param data: + :param data: Data object for a HAMR organization connection request. :type data: HamrOrgConnectionDataRequest """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/hamr_org_connection_response.py b/src/datadog_api_client/v2/model/hamr_org_connection_response.py index 80e859d6a5..d6d25c9a18 100644 --- a/src/datadog_api_client/v2/model/hamr_org_connection_response.py +++ b/src/datadog_api_client/v2/model/hamr_org_connection_response.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: HamrOrgConnectionDataResponse, **kwargs): """ + Response payload for a HAMR organization connection. - - :param data: + :param data: Data object for a HAMR organization connection response. :type data: HamrOrgConnectionDataResponse """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/incident_handle_data_request.py b/src/datadog_api_client/v2/model/incident_handle_data_request.py index 267122f368..48e29ca310 100644 --- a/src/datadog_api_client/v2/model/incident_handle_data_request.py +++ b/src/datadog_api_client/v2/model/incident_handle_data_request.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + Data object representing an incident handle in a create or update request. :param attributes: Incident handle attributes for requests :type attributes: IncidentHandleAttributesRequest @@ -58,7 +58,7 @@ def __init__( :param id: The ID of the incident handle (required for PUT requests) :type id: str, optional - :param relationships: + :param relationships: Relationships to associate with an incident handle in a create or update request. :type relationships: IncidentHandleRelationshipsRequest, none_type, optional :param type: Incident handle resource type diff --git a/src/datadog_api_client/v2/model/incident_handle_data_response.py b/src/datadog_api_client/v2/model/incident_handle_data_response.py index c4052ea654..6bfa4e5e3c 100644 --- a/src/datadog_api_client/v2/model/incident_handle_data_response.py +++ b/src/datadog_api_client/v2/model/incident_handle_data_response.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + Data object representing an incident handle in a response. :param attributes: Incident handle attributes for responses :type attributes: IncidentHandleAttributesResponse @@ -58,7 +58,7 @@ def __init__( :param id: The ID of the incident handle :type id: str - :param relationships: + :param relationships: Relationships associated with an incident handle response, including linked users and incident type. :type relationships: IncidentHandleRelationships, none_type, optional :param type: Incident handle resource type diff --git a/src/datadog_api_client/v2/model/incident_handle_included_item_response.py b/src/datadog_api_client/v2/model/incident_handle_included_item_response.py index 5565713137..397dcf2231 100644 --- a/src/datadog_api_client/v2/model/incident_handle_included_item_response.py +++ b/src/datadog_api_client/v2/model/incident_handle_included_item_response.py @@ -13,7 +13,7 @@ class IncidentHandleIncludedItemResponse(ModelComposed): def __init__(self, **kwargs): """ - + A single included resource item in an incident handle response, which can be a user or an incident type. :param attributes: Attributes of user object returned by the API. :type attributes: IncidentUserAttributes, optional diff --git a/src/datadog_api_client/v2/model/incident_handle_relationship.py b/src/datadog_api_client/v2/model/incident_handle_relationship.py index 6c3de05944..f3cd4fb0bf 100644 --- a/src/datadog_api_client/v2/model/incident_handle_relationship.py +++ b/src/datadog_api_client/v2/model/incident_handle_relationship.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: IncidentHandleRelationshipData, **kwargs): """ + A single relationship object for an incident handle, wrapping the related resource data. - - :param data: + :param data: Relationship data for an incident handle, containing the ID and type of the related resource. :type data: IncidentHandleRelationshipData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/incident_handle_relationship_data.py b/src/datadog_api_client/v2/model/incident_handle_relationship_data.py index f1445a024d..1f742c3195 100644 --- a/src/datadog_api_client/v2/model/incident_handle_relationship_data.py +++ b/src/datadog_api_client/v2/model/incident_handle_relationship_data.py @@ -25,7 +25,7 @@ def openapi_types(_): def __init__(self_, id: str, type: str, **kwargs): """ - + Relationship data for an incident handle, containing the ID and type of the related resource. :param id: The ID of the related resource :type id: str diff --git a/src/datadog_api_client/v2/model/incident_handle_relationships.py b/src/datadog_api_client/v2/model/incident_handle_relationships.py index 0e7e1ddde5..39ef670842 100644 --- a/src/datadog_api_client/v2/model/incident_handle_relationships.py +++ b/src/datadog_api_client/v2/model/incident_handle_relationships.py @@ -47,18 +47,18 @@ def __init__( **kwargs, ): """ + Relationships associated with an incident handle response, including linked users and incident type. - - :param commander_user: + :param commander_user: A single relationship object for an incident handle, wrapping the related resource data. :type commander_user: IncidentHandleRelationship, optional - :param created_by_user: + :param created_by_user: A single relationship object for an incident handle, wrapping the related resource data. :type created_by_user: IncidentHandleRelationship - :param incident_type: + :param incident_type: A single relationship object for an incident handle, wrapping the related resource data. :type incident_type: IncidentHandleRelationship - :param last_modified_by_user: + :param last_modified_by_user: A single relationship object for an incident handle, wrapping the related resource data. :type last_modified_by_user: IncidentHandleRelationship """ if commander_user is not unset: diff --git a/src/datadog_api_client/v2/model/incident_handle_relationships_request.py b/src/datadog_api_client/v2/model/incident_handle_relationships_request.py index cf71a32e42..70829419b3 100644 --- a/src/datadog_api_client/v2/model/incident_handle_relationships_request.py +++ b/src/datadog_api_client/v2/model/incident_handle_relationships_request.py @@ -41,12 +41,12 @@ def __init__( **kwargs, ): """ + Relationships to associate with an incident handle in a create or update request. - - :param commander_user: + :param commander_user: A single relationship object for an incident handle, wrapping the related resource data. :type commander_user: IncidentHandleRelationship, optional - :param incident_type: + :param incident_type: A single relationship object for an incident handle, wrapping the related resource data. :type incident_type: IncidentHandleRelationship """ if commander_user is not unset: diff --git a/src/datadog_api_client/v2/model/incident_handle_request.py b/src/datadog_api_client/v2/model/incident_handle_request.py index 5e69eef4ed..8151c5b63d 100644 --- a/src/datadog_api_client/v2/model/incident_handle_request.py +++ b/src/datadog_api_client/v2/model/incident_handle_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: IncidentHandleDataRequest, **kwargs): """ + Request payload for creating or updating a global incident handle. - - :param data: + :param data: Data object representing an incident handle in a create or update request. :type data: IncidentHandleDataRequest """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/incident_handle_response.py b/src/datadog_api_client/v2/model/incident_handle_response.py index 212887f1b5..f294d9c51b 100644 --- a/src/datadog_api_client/v2/model/incident_handle_response.py +++ b/src/datadog_api_client/v2/model/incident_handle_response.py @@ -47,9 +47,9 @@ def __init__( **kwargs, ): """ + Response payload for a single incident handle, including the handle data and related resources. - - :param data: + :param data: Data object representing an incident handle in a response. :type data: IncidentHandleDataResponse :param included: Included related resources diff --git a/src/datadog_api_client/v2/model/incident_handles_response.py b/src/datadog_api_client/v2/model/incident_handles_response.py index e9b44a4e8e..857a950484 100644 --- a/src/datadog_api_client/v2/model/incident_handles_response.py +++ b/src/datadog_api_client/v2/model/incident_handles_response.py @@ -47,9 +47,9 @@ def __init__( **kwargs, ): """ + Response payload for a list of global incident handles, including handle data and related resources. - - :param data: + :param data: Array of incident handle data objects returned in a list response. :type data: [IncidentHandleDataResponse] :param included: Included related resources diff --git a/src/datadog_api_client/v2/model/integration_incident.py b/src/datadog_api_client/v2/model/integration_incident.py index 10a674ba91..9b54463062 100644 --- a/src/datadog_api_client/v2/model/integration_incident.py +++ b/src/datadog_api_client/v2/model/integration_incident.py @@ -57,24 +57,24 @@ def __init__( **kwargs, ): """ - Incident integration settings + Incident integration settings. - :param auto_escalation_query: Query for auto-escalation + :param auto_escalation_query: Query for auto-escalation. :type auto_escalation_query: str, optional - :param default_incident_commander: Default incident commander + :param default_incident_commander: Default incident commander. :type default_incident_commander: str, optional - :param enabled: Whether incident integration is enabled + :param enabled: Whether incident integration is enabled. :type enabled: bool, optional - :param field_mappings: + :param field_mappings: List of mappings between incident fields and case fields. :type field_mappings: [IntegrationIncidentFieldMappingsItems], optional - :param incident_type: Incident type + :param incident_type: Incident type. :type incident_type: str, optional - :param severity_config: + :param severity_config: Severity configuration for mapping incident priorities to case priorities. :type severity_config: IntegrationIncidentSeverityConfig, optional """ if auto_escalation_query is not unset: diff --git a/src/datadog_api_client/v2/model/integration_incident_field_mappings_items.py b/src/datadog_api_client/v2/model/integration_incident_field_mappings_items.py index af6c5dcf26..0430e0c171 100644 --- a/src/datadog_api_client/v2/model/integration_incident_field_mappings_items.py +++ b/src/datadog_api_client/v2/model/integration_incident_field_mappings_items.py @@ -33,12 +33,12 @@ def __init__( **kwargs, ): """ + Mapping between an incident user-defined field and a case field. - - :param case_field: + :param case_field: The case field to map the incident field value to. :type case_field: str, optional - :param incident_user_defined_field_id: + :param incident_user_defined_field_id: The identifier of the incident user-defined field to map from. :type incident_user_defined_field_id: str, optional """ if case_field is not unset: diff --git a/src/datadog_api_client/v2/model/integration_incident_severity_config.py b/src/datadog_api_client/v2/model/integration_incident_severity_config.py index b8a470278a..d0138d8bd2 100644 --- a/src/datadog_api_client/v2/model/integration_incident_severity_config.py +++ b/src/datadog_api_client/v2/model/integration_incident_severity_config.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, priority_mapping: Union[Dict[str, str], UnsetType] = unset, **kwargs): """ + Severity configuration for mapping incident priorities to case priorities. - - :param priority_mapping: + :param priority_mapping: Mapping of incident severity values to case priority values. :type priority_mapping: {str: (str,)}, optional """ if priority_mapping is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira.py b/src/datadog_api_client/v2/model/integration_jira.py index 1cfa6a0480..2fd4524ac2 100644 --- a/src/datadog_api_client/v2/model/integration_jira.py +++ b/src/datadog_api_client/v2/model/integration_jira.py @@ -49,18 +49,18 @@ def __init__( **kwargs, ): """ - Jira integration settings + Jira integration settings. - :param auto_creation: + :param auto_creation: Auto-creation settings for Jira issues from cases. :type auto_creation: IntegrationJiraAutoCreation, optional - :param enabled: Whether Jira integration is enabled + :param enabled: Whether Jira integration is enabled. :type enabled: bool, optional - :param metadata: + :param metadata: Metadata for connecting a case management project to a Jira project. :type metadata: IntegrationJiraMetadata, optional - :param sync: + :param sync: Synchronization configuration for Jira integration. :type sync: IntegrationJiraSync, optional """ if auto_creation is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira_auto_creation.py b/src/datadog_api_client/v2/model/integration_jira_auto_creation.py index ea71a29452..370506df18 100644 --- a/src/datadog_api_client/v2/model/integration_jira_auto_creation.py +++ b/src/datadog_api_client/v2/model/integration_jira_auto_creation.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, enabled: Union[bool, UnsetType] = unset, **kwargs): """ + Auto-creation settings for Jira issues from cases. - - :param enabled: + :param enabled: Whether automatic Jira issue creation is enabled. :type enabled: bool, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira_metadata.py b/src/datadog_api_client/v2/model/integration_jira_metadata.py index d9c80fb5ce..65714568c6 100644 --- a/src/datadog_api_client/v2/model/integration_jira_metadata.py +++ b/src/datadog_api_client/v2/model/integration_jira_metadata.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Metadata for connecting a case management project to a Jira project. - - :param account_id: + :param account_id: The Jira account identifier. :type account_id: str, optional - :param issue_type_id: + :param issue_type_id: The Jira issue type identifier to use when creating issues. :type issue_type_id: str, optional - :param project_id: + :param project_id: The Jira project identifier to associate with this case project. :type project_id: str, optional """ if account_id is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira_sync.py b/src/datadog_api_client/v2/model/integration_jira_sync.py index 61cdfe1cc7..bc374bc008 100644 --- a/src/datadog_api_client/v2/model/integration_jira_sync.py +++ b/src/datadog_api_client/v2/model/integration_jira_sync.py @@ -39,12 +39,12 @@ def __init__( **kwargs, ): """ + Synchronization configuration for Jira integration. - - :param enabled: + :param enabled: Whether Jira field synchronization is enabled. :type enabled: bool, optional - :param properties: + :param properties: Field synchronization properties for Jira integration. :type properties: IntegrationJiraSyncProperties, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira_sync_due_date.py b/src/datadog_api_client/v2/model/integration_jira_sync_due_date.py index 6fe92b0a56..b4844a9372 100644 --- a/src/datadog_api_client/v2/model/integration_jira_sync_due_date.py +++ b/src/datadog_api_client/v2/model/integration_jira_sync_due_date.py @@ -30,12 +30,12 @@ def __init__( self_, jira_field_id: Union[str, UnsetType] = unset, sync_type: Union[str, UnsetType] = unset, **kwargs ): """ + Due date synchronization configuration for Jira integration. - - :param jira_field_id: + :param jira_field_id: The Jira field identifier used to store the due date. :type jira_field_id: str, optional - :param sync_type: + :param sync_type: The type of synchronization to apply for the due date field. :type sync_type: str, optional """ if jira_field_id is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira_sync_properties.py b/src/datadog_api_client/v2/model/integration_jira_sync_properties.py index 536fad19a6..4d150b9158 100644 --- a/src/datadog_api_client/v2/model/integration_jira_sync_properties.py +++ b/src/datadog_api_client/v2/model/integration_jira_sync_properties.py @@ -69,30 +69,30 @@ def __init__( **kwargs, ): """ + Field synchronization properties for Jira integration. - - :param assignee: Sync property configuration + :param assignee: Sync property configuration. :type assignee: SyncProperty, optional - :param comments: Sync property configuration + :param comments: Sync property configuration. :type comments: SyncProperty, optional - :param custom_fields: + :param custom_fields: Map of custom field identifiers to their sync configurations. :type custom_fields: {str: (IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties,)}, optional - :param description: Sync property configuration + :param description: Sync property configuration. :type description: SyncProperty, optional - :param due_date: + :param due_date: Due date synchronization configuration for Jira integration. :type due_date: IntegrationJiraSyncDueDate, optional - :param priority: Sync property with mapping configuration + :param priority: Sync property with mapping configuration. :type priority: SyncPropertyWithMapping, optional - :param status: Sync property with mapping configuration + :param status: Sync property with mapping configuration. :type status: SyncPropertyWithMapping, optional - :param title: Sync property configuration + :param title: Sync property configuration. :type title: SyncProperty, optional """ if assignee is not unset: diff --git a/src/datadog_api_client/v2/model/integration_jira_sync_properties_custom_fields_additional_properties.py b/src/datadog_api_client/v2/model/integration_jira_sync_properties_custom_fields_additional_properties.py index 858cb7758f..bef15fa43e 100644 --- a/src/datadog_api_client/v2/model/integration_jira_sync_properties_custom_fields_additional_properties.py +++ b/src/datadog_api_client/v2/model/integration_jira_sync_properties_custom_fields_additional_properties.py @@ -48,9 +48,9 @@ def __init__( **kwargs, ): """ + Synchronization configuration for a Jira custom field. - - :param sync_type: + :param sync_type: The type of synchronization to apply for this custom field. :type sync_type: str, optional :param value: Represents any valid JSON value. diff --git a/src/datadog_api_client/v2/model/integration_monitor.py b/src/datadog_api_client/v2/model/integration_monitor.py index 583f85d73c..16032bc852 100644 --- a/src/datadog_api_client/v2/model/integration_monitor.py +++ b/src/datadog_api_client/v2/model/integration_monitor.py @@ -39,18 +39,18 @@ def __init__( **kwargs, ): """ - Monitor integration settings + Monitor integration settings. - :param auto_resolve_enabled: Whether auto-resolve is enabled + :param auto_resolve_enabled: Whether auto-resolve is enabled. :type auto_resolve_enabled: bool, optional - :param case_type_id: Case type ID for monitor integration + :param case_type_id: Case type ID for monitor integration. :type case_type_id: str, optional - :param enabled: Whether monitor integration is enabled + :param enabled: Whether monitor integration is enabled. :type enabled: bool, optional - :param handle: Monitor handle + :param handle: Monitor handle. :type handle: str, optional """ if auto_resolve_enabled is not unset: diff --git a/src/datadog_api_client/v2/model/integration_on_call.py b/src/datadog_api_client/v2/model/integration_on_call.py index 2579dfd7af..601f0d1ab8 100644 --- a/src/datadog_api_client/v2/model/integration_on_call.py +++ b/src/datadog_api_client/v2/model/integration_on_call.py @@ -46,15 +46,15 @@ def __init__( **kwargs, ): """ - On-Call integration settings + On-Call integration settings. - :param auto_assign_on_call: Whether to auto-assign on-call + :param auto_assign_on_call: Whether to auto-assign on-call. :type auto_assign_on_call: bool, optional - :param enabled: Whether On-Call integration is enabled + :param enabled: Whether On-Call integration is enabled. :type enabled: bool, optional - :param escalation_queries: + :param escalation_queries: List of escalation queries for routing cases to on-call responders. :type escalation_queries: [IntegrationOnCallEscalationQueriesItems], optional """ if auto_assign_on_call is not unset: diff --git a/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items.py b/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items.py index d28386944a..e086b81e3b 100644 --- a/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items.py +++ b/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items.py @@ -49,18 +49,18 @@ def __init__( **kwargs, ): """ + An On-Call escalation query entry used to route cases to on-call responders. - - :param enabled: + :param enabled: Whether this escalation query is enabled. :type enabled: bool, optional - :param id: + :param id: Unique identifier of the escalation query. :type id: str, optional - :param query: + :param query: The query used to match cases for escalation. :type query: str, optional - :param target: + :param target: The target recipient for an On-Call escalation query. :type target: IntegrationOnCallEscalationQueriesItemsTarget, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items_target.py b/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items_target.py index d9cf0d3d3c..4ee8ab0ec5 100644 --- a/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items_target.py +++ b/src/datadog_api_client/v2/model/integration_on_call_escalation_queries_items_target.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + The target recipient for an On-Call escalation query. - - :param dynamic_team_paging: + :param dynamic_team_paging: Whether to use dynamic team paging for escalation. :type dynamic_team_paging: bool, optional - :param team_id: + :param team_id: The identifier of the team to escalate to. :type team_id: str, optional - :param user_id: + :param user_id: The identifier of the user to escalate to. :type user_id: str, optional """ if dynamic_team_paging is not unset: diff --git a/src/datadog_api_client/v2/model/integration_service_now.py b/src/datadog_api_client/v2/model/integration_service_now.py index 9b8d297148..3c05c4b449 100644 --- a/src/datadog_api_client/v2/model/integration_service_now.py +++ b/src/datadog_api_client/v2/model/integration_service_now.py @@ -50,21 +50,21 @@ def __init__( **kwargs, ): """ - ServiceNow integration settings + ServiceNow integration settings. - :param assignment_group: Assignment group + :param assignment_group: Assignment group. :type assignment_group: str, optional - :param auto_creation: + :param auto_creation: Auto-creation settings for ServiceNow incidents from cases. :type auto_creation: IntegrationServiceNowAutoCreation, optional - :param enabled: Whether ServiceNow integration is enabled + :param enabled: Whether ServiceNow integration is enabled. :type enabled: bool, optional - :param instance_name: ServiceNow instance name + :param instance_name: ServiceNow instance name. :type instance_name: str, optional - :param sync_config: + :param sync_config: Synchronization configuration for ServiceNow integration. :type sync_config: IntegrationServiceNowSyncConfig, optional """ if assignment_group is not unset: diff --git a/src/datadog_api_client/v2/model/integration_service_now_auto_creation.py b/src/datadog_api_client/v2/model/integration_service_now_auto_creation.py index 79e21829ad..ab2611fcf2 100644 --- a/src/datadog_api_client/v2/model/integration_service_now_auto_creation.py +++ b/src/datadog_api_client/v2/model/integration_service_now_auto_creation.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, enabled: Union[bool, UnsetType] = unset, **kwargs): """ + Auto-creation settings for ServiceNow incidents from cases. - - :param enabled: + :param enabled: Whether automatic ServiceNow incident creation is enabled. :type enabled: bool, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/integration_service_now_sync_config.py b/src/datadog_api_client/v2/model/integration_service_now_sync_config.py index 6042332ba9..634ba29ae3 100644 --- a/src/datadog_api_client/v2/model/integration_service_now_sync_config.py +++ b/src/datadog_api_client/v2/model/integration_service_now_sync_config.py @@ -43,12 +43,12 @@ def __init__( **kwargs, ): """ + Synchronization configuration for ServiceNow integration. - - :param enabled: + :param enabled: Whether ServiceNow synchronization is enabled. :type enabled: bool, optional - :param properties: + :param properties: Field-level synchronization properties for ServiceNow integration. :type properties: IntegrationServiceNowSyncConfig139772721534496, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/integration_service_now_sync_config139772721534496.py b/src/datadog_api_client/v2/model/integration_service_now_sync_config139772721534496.py index 5b142ff2fc..3d886b3c4d 100644 --- a/src/datadog_api_client/v2/model/integration_service_now_sync_config139772721534496.py +++ b/src/datadog_api_client/v2/model/integration_service_now_sync_config139772721534496.py @@ -50,15 +50,15 @@ def __init__( **kwargs, ): """ + Field-level synchronization properties for ServiceNow integration. - - :param comments: Sync property configuration + :param comments: Sync property configuration. :type comments: SyncProperty, optional - :param priority: + :param priority: Priority synchronization configuration for ServiceNow integration. :type priority: IntegrationServiceNowSyncConfigPriority, optional - :param status: Sync property with mapping configuration + :param status: Sync property with mapping configuration. :type status: SyncPropertyWithMapping, optional """ if comments is not unset: diff --git a/src/datadog_api_client/v2/model/integration_service_now_sync_config_priority.py b/src/datadog_api_client/v2/model/integration_service_now_sync_config_priority.py index 67347e78f8..b1d5d77f0a 100644 --- a/src/datadog_api_client/v2/model/integration_service_now_sync_config_priority.py +++ b/src/datadog_api_client/v2/model/integration_service_now_sync_config_priority.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Priority synchronization configuration for ServiceNow integration. - - :param impact_mapping: + :param impact_mapping: Mapping of case priority values to ServiceNow impact values. :type impact_mapping: {str: (str,)}, optional - :param sync_type: + :param sync_type: The type of synchronization to apply for priority. :type sync_type: str, optional - :param urgency_mapping: + :param urgency_mapping: Mapping of case priority values to ServiceNow urgency values. :type urgency_mapping: {str: (str,)}, optional """ if impact_mapping is not unset: diff --git a/src/datadog_api_client/v2/model/issue_case_relationships.py b/src/datadog_api_client/v2/model/issue_case_relationships.py index 424f0bd6b7..9afa3cfdf0 100644 --- a/src/datadog_api_client/v2/model/issue_case_relationships.py +++ b/src/datadog_api_client/v2/model/issue_case_relationships.py @@ -59,7 +59,7 @@ def __init__( :param modified_by: Relationship to user. :type modified_by: NullableUserRelationship, none_type, optional - :param project: Relationship to project + :param project: Relationship to project. :type project: ProjectRelationship, optional """ if assignee is not unset: diff --git a/src/datadog_api_client/v2/model/list_connections_response.py b/src/datadog_api_client/v2/model/list_connections_response.py index dad8070b22..1b156684a1 100644 --- a/src/datadog_api_client/v2/model/list_connections_response.py +++ b/src/datadog_api_client/v2/model/list_connections_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[ListConnectionsResponseData, UnsetType] = unset, **kwargs): """ + Response containing the list of all data source connections configured for an entity. - - :param data: + :param data: The data object containing the resource type and attributes for the list connections response. :type data: ListConnectionsResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/list_connections_response_data.py b/src/datadog_api_client/v2/model/list_connections_response_data.py index 2d648236ca..a90463ddde 100644 --- a/src/datadog_api_client/v2/model/list_connections_response_data.py +++ b/src/datadog_api_client/v2/model/list_connections_response_data.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for the list connections response. - - :param attributes: + :param attributes: Attributes of the list connections response, containing the collection of data source connections. :type attributes: ListConnectionsResponseDataAttributes, optional - :param id: + :param id: Unique identifier for the list connections response resource. :type id: str, optional :param type: List connections response resource type. diff --git a/src/datadog_api_client/v2/model/list_connections_response_data_attributes.py b/src/datadog_api_client/v2/model/list_connections_response_data_attributes.py index e3ccbb2391..0639306d5a 100644 --- a/src/datadog_api_client/v2/model/list_connections_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/list_connections_response_data_attributes.py @@ -40,9 +40,9 @@ def __init__( **kwargs, ): """ + Attributes of the list connections response, containing the collection of data source connections. - - :param connections: + :param connections: The list of data source connections configured for the entity. :type connections: [ListConnectionsResponseDataAttributesConnectionsItems], optional """ if connections is not unset: diff --git a/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items.py b/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items.py index f75e2f8146..77da6963b9 100644 --- a/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items.py +++ b/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items.py @@ -71,33 +71,33 @@ def __init__( **kwargs, ): """ + Details of a single data source connection, including its fields, join configuration, and audit metadata. - - :param created_at: + :param created_at: Timestamp indicating when the connection was created. :type created_at: datetime, optional - :param created_by: + :param created_by: Identifier of the user who created the connection. :type created_by: str, optional - :param fields: + :param fields: List of custom attribute fields imported from the data source. :type fields: [CreateConnectionRequestDataAttributesFieldsItems], optional - :param id: + :param id: Unique identifier of the connection. :type id: str, optional - :param join: + :param join: The join configuration describing how the data source is linked to the entity. :type join: ListConnectionsResponseDataAttributesConnectionsItemsJoin, optional - :param metadata: + :param metadata: Additional key-value metadata associated with the connection. :type metadata: {str: (str,)}, optional - :param type: + :param type: The type of data source connection (for example, ref_table). :type type: str, optional - :param updated_at: + :param updated_at: Timestamp indicating when the connection was last updated. :type updated_at: datetime, optional - :param updated_by: + :param updated_by: Identifier of the user who last updated the connection. :type updated_by: str, optional """ if created_at is not unset: diff --git a/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items_join.py b/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items_join.py index 015a133e4b..fc7c6edd2a 100644 --- a/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items_join.py +++ b/src/datadog_api_client/v2/model/list_connections_response_data_attributes_connections_items_join.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, attribute: Union[str, UnsetType] = unset, type: Union[str, UnsetType] = unset, **kwargs): """ + The join configuration describing how the data source is linked to the entity. - - :param attribute: + :param attribute: The entity attribute used as the join key to link records from the data source. :type attribute: str, optional - :param type: + :param type: The type of join key used (for example, email or user_id). :type type: str, optional """ if attribute is not unset: diff --git a/src/datadog_api_client/v2/model/list_deployment_rule_response_data.py b/src/datadog_api_client/v2/model/list_deployment_rule_response_data.py index 5e377cfc5c..c780fa952d 100644 --- a/src/datadog_api_client/v2/model/list_deployment_rule_response_data.py +++ b/src/datadog_api_client/v2/model/list_deployment_rule_response_data.py @@ -48,7 +48,7 @@ def __init__( """ Data for a list of deployment rules. - :param attributes: + :param attributes: Attributes of the response for listing deployment rules. :type attributes: ListDeploymentRulesResponseDataAttributes :param id: Unique identifier of the deployment rule. diff --git a/src/datadog_api_client/v2/model/list_deployment_rules_response_data_attributes.py b/src/datadog_api_client/v2/model/list_deployment_rules_response_data_attributes.py index 53ad9dde9f..39f3093e76 100644 --- a/src/datadog_api_client/v2/model/list_deployment_rules_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/list_deployment_rules_response_data_attributes.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, rules: Union[List[DeploymentRuleResponseDataAttributes], UnsetType] = unset, **kwargs): """ + Attributes of the response for listing deployment rules. - - :param rules: + :param rules: The list of deployment rules. :type rules: [DeploymentRuleResponseDataAttributes], optional """ if rules is not unset: diff --git a/src/datadog_api_client/v2/model/list_notification_channels_response.py b/src/datadog_api_client/v2/model/list_notification_channels_response.py index 93d91b93d0..488374d096 100644 --- a/src/datadog_api_client/v2/model/list_notification_channels_response.py +++ b/src/datadog_api_client/v2/model/list_notification_channels_response.py @@ -34,7 +34,7 @@ def __init__(self_, data: Union[List[NotificationChannelData], UnsetType] = unse """ Response type for listing notification channels for a user - :param data: + :param data: Array of notification channel data objects. :type data: [NotificationChannelData], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/list_on_call_notification_rules_response.py b/src/datadog_api_client/v2/model/list_on_call_notification_rules_response.py index ef9a6bf1b9..0619edf897 100644 --- a/src/datadog_api_client/v2/model/list_on_call_notification_rules_response.py +++ b/src/datadog_api_client/v2/model/list_on_call_notification_rules_response.py @@ -44,7 +44,7 @@ def __init__( """ Response type for listing notification rules for a user - :param data: + :param data: Array of notification rule data objects. :type data: [OnCallNotificationRuleData], optional :param included: diff --git a/src/datadog_api_client/v2/model/maintenance.py b/src/datadog_api_client/v2/model/maintenance.py index d9ee9283bd..888da42c78 100644 --- a/src/datadog_api_client/v2/model/maintenance.py +++ b/src/datadog_api_client/v2/model/maintenance.py @@ -43,9 +43,9 @@ def __init__( **kwargs, ): """ + Response object for a single maintenance. - - :param data: + :param data: The data object for a maintenance. :type data: MaintenanceData, optional :param included: The included related resources of a maintenance. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/maintenance_array.py b/src/datadog_api_client/v2/model/maintenance_array.py index c304e393ad..04ec862cf6 100644 --- a/src/datadog_api_client/v2/model/maintenance_array.py +++ b/src/datadog_api_client/v2/model/maintenance_array.py @@ -51,9 +51,9 @@ def __init__( **kwargs, ): """ + Response object for a list of maintenances. - - :param data: + :param data: A list of maintenance data objects. :type data: [MaintenanceData] :param included: The included related resources of a maintenance. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/maintenance_data.py b/src/datadog_api_client/v2/model/maintenance_data.py index 3de2328d66..afd6c04c7f 100644 --- a/src/datadog_api_client/v2/model/maintenance_data.py +++ b/src/datadog_api_client/v2/model/maintenance_data.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + The data object for a maintenance. :param attributes: The attributes of a maintenance. :type attributes: MaintenanceDataAttributes, optional diff --git a/src/datadog_api_client/v2/model/maintenance_data_attributes_components_affected_items.py b/src/datadog_api_client/v2/model/maintenance_data_attributes_components_affected_items.py index 8bbae4c85c..e9c6f74ebd 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_attributes_components_affected_items.py +++ b/src/datadog_api_client/v2/model/maintenance_data_attributes_components_affected_items.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + A component affected by a maintenance. :param id: The ID of the component. Must be a component of type ``component``. :type id: UUID diff --git a/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items.py b/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items.py index 8157c8ae2f..ceb192e58c 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items.py +++ b/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items.py @@ -71,7 +71,7 @@ def __init__( **kwargs, ): """ - + An update made to a maintenance. :param components_affected: The components affected at the time of the update. :type components_affected: [MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems], optional diff --git a/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items_components_affected_items.py b/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items_components_affected_items.py index f8783718df..4e20bf4a1f 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items_components_affected_items.py +++ b/src/datadog_api_client/v2/model/maintenance_data_attributes_updates_items_components_affected_items.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + A component affected at the time of a maintenance update. :param id: Identifier of the component affected at the time of the update. :type id: UUID diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships.py b/src/datadog_api_client/v2/model/maintenance_data_relationships.py index 1bf436ceb5..1401ccbf3e 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships.py @@ -60,13 +60,13 @@ def __init__( """ The relationships of a maintenance. - :param created_by_user: + :param created_by_user: The Datadog user who created the maintenance. :type created_by_user: MaintenanceDataRelationshipsCreatedByUser, optional - :param last_modified_by_user: + :param last_modified_by_user: The Datadog user who last modified the maintenance. :type last_modified_by_user: MaintenanceDataRelationshipsLastModifiedByUser, optional - :param status_page: + :param status_page: The status page the maintenance belongs to. :type status_page: MaintenanceDataRelationshipsStatusPage, optional """ if created_by_user is not unset: diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user.py b/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user.py index 859885b91d..01e30e2744 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: MaintenanceDataRelationshipsCreatedByUserData, **kwargs): """ + The Datadog user who created the maintenance. - - :param data: + :param data: The data object identifying the Datadog user who created the maintenance. :type data: MaintenanceDataRelationshipsCreatedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user_data.py b/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user_data.py index 91a69cc885..8a8f57ca42 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user_data.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships_created_by_user_data.py @@ -33,7 +33,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who created the maintenance. :param id: The ID of the Datadog user who created the maintenance. :type id: UUID diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user.py b/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user.py index daa9533a41..66ba2013cd 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: MaintenanceDataRelationshipsLastModifiedByUserData, **kwargs): """ + The Datadog user who last modified the maintenance. - - :param data: + :param data: The data object identifying the Datadog user who last modified the maintenance. :type data: MaintenanceDataRelationshipsLastModifiedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user_data.py b/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user_data.py index c18eda1ccf..a7abf09767 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user_data.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships_last_modified_by_user_data.py @@ -33,7 +33,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who last modified the maintenance. :param id: The ID of the Datadog user who last modified the maintenance. :type id: UUID diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page.py b/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page.py index 08c6b7611b..66ba46a8e0 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: MaintenanceDataRelationshipsStatusPageData, **kwargs): """ + The status page the maintenance belongs to. - - :param data: + :param data: The data object identifying the status page associated with a maintenance. :type data: MaintenanceDataRelationshipsStatusPageData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page_data.py b/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page_data.py index 5a14cc45ea..b5bcba18a4 100644 --- a/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page_data.py +++ b/src/datadog_api_client/v2/model/maintenance_data_relationships_status_page_data.py @@ -33,7 +33,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPageDataType, **kwargs): """ - + The data object identifying the status page associated with a maintenance. :param id: The ID of the status page. :type id: UUID diff --git a/src/datadog_api_client/v2/model/pagination_meta_page.py b/src/datadog_api_client/v2/model/pagination_meta_page.py index eb3f7053fa..64539b8354 100644 --- a/src/datadog_api_client/v2/model/pagination_meta_page.py +++ b/src/datadog_api_client/v2/model/pagination_meta_page.py @@ -81,7 +81,7 @@ def __init__( :param total: Integer representing the total number of elements available. :type total: int, none_type, optional - :param type: + :param type: The pagination type used for offset-based pagination. :type type: PaginationMetaPageType, optional """ if first_offset is not unset: diff --git a/src/datadog_api_client/v2/model/pagination_meta_page_type.py b/src/datadog_api_client/v2/model/pagination_meta_page_type.py index 3780edc32f..5bfb6001f4 100644 --- a/src/datadog_api_client/v2/model/pagination_meta_page_type.py +++ b/src/datadog_api_client/v2/model/pagination_meta_page_type.py @@ -14,7 +14,7 @@ class PaginationMetaPageType(ModelSimple): """ - + The pagination type used for offset-based pagination. :param value: If omitted defaults to "offset_limit". Must be one of ["offset_limit"]. :type value: str diff --git a/src/datadog_api_client/v2/model/patch_component_request.py b/src/datadog_api_client/v2/model/patch_component_request.py index f81f7c00b1..92a493fa26 100644 --- a/src/datadog_api_client/v2/model/patch_component_request.py +++ b/src/datadog_api_client/v2/model/patch_component_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[PatchComponentRequestData, UnsetType] = unset, **kwargs): """ + Request object for updating a component. - - :param data: + :param data: The data object for updating a component. :type data: PatchComponentRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/patch_component_request_data.py b/src/datadog_api_client/v2/model/patch_component_request_data.py index 1096a5ac9c..42c5bf7b7b 100644 --- a/src/datadog_api_client/v2/model/patch_component_request_data.py +++ b/src/datadog_api_client/v2/model/patch_component_request_data.py @@ -41,7 +41,7 @@ def __init__( self_, attributes: PatchComponentRequestDataAttributes, id: UUID, type: StatusPagesComponentGroupType, **kwargs ): """ - + The data object for updating a component. :param attributes: The supported attributes for updating a component. :type attributes: PatchComponentRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/patch_degradation_request.py b/src/datadog_api_client/v2/model/patch_degradation_request.py index b387a6779d..4a3435b116 100644 --- a/src/datadog_api_client/v2/model/patch_degradation_request.py +++ b/src/datadog_api_client/v2/model/patch_degradation_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[PatchDegradationRequestData, UnsetType] = unset, **kwargs): """ + Request object for updating a degradation. - - :param data: + :param data: The data object for updating a degradation. :type data: PatchDegradationRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/patch_degradation_request_data.py b/src/datadog_api_client/v2/model/patch_degradation_request_data.py index d5f1cad450..98fea10b1c 100644 --- a/src/datadog_api_client/v2/model/patch_degradation_request_data.py +++ b/src/datadog_api_client/v2/model/patch_degradation_request_data.py @@ -47,7 +47,7 @@ def __init__( **kwargs, ): """ - + The data object for updating a degradation. :param attributes: The supported attributes for updating a degradation. :type attributes: PatchDegradationRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/patch_degradation_request_data_attributes_components_affected_items.py b/src/datadog_api_client/v2/model/patch_degradation_request_data_attributes_components_affected_items.py index 9012a75194..08541999a4 100644 --- a/src/datadog_api_client/v2/model/patch_degradation_request_data_attributes_components_affected_items.py +++ b/src/datadog_api_client/v2/model/patch_degradation_request_data_attributes_components_affected_items.py @@ -46,12 +46,12 @@ def __init__( self_, id: UUID, status: StatusPagesComponentDataAttributesStatus, name: Union[str, UnsetType] = unset, **kwargs ): """ - + A component affected by a degradation. :param id: The ID of the component. Must be a component of type ``component``. :type id: UUID - :param name: + :param name: The name of the component. :type name: str, optional :param status: The status of the component. diff --git a/src/datadog_api_client/v2/model/patch_maintenance_request.py b/src/datadog_api_client/v2/model/patch_maintenance_request.py index c5df665110..2f7af34cf0 100644 --- a/src/datadog_api_client/v2/model/patch_maintenance_request.py +++ b/src/datadog_api_client/v2/model/patch_maintenance_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[PatchMaintenanceRequestData, UnsetType] = unset, **kwargs): """ + Request object for updating a maintenance. - - :param data: + :param data: The data object for updating a maintenance. :type data: PatchMaintenanceRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/patch_maintenance_request_data.py b/src/datadog_api_client/v2/model/patch_maintenance_request_data.py index 7b2890ba89..57cde389fb 100644 --- a/src/datadog_api_client/v2/model/patch_maintenance_request_data.py +++ b/src/datadog_api_client/v2/model/patch_maintenance_request_data.py @@ -47,7 +47,7 @@ def __init__( **kwargs, ): """ - + The data object for updating a maintenance. :param attributes: The supported attributes for updating a maintenance. :type attributes: PatchMaintenanceRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/patch_maintenance_request_data_attributes_components_affected_items.py b/src/datadog_api_client/v2/model/patch_maintenance_request_data_attributes_components_affected_items.py index bafc11d922..aab9f57119 100644 --- a/src/datadog_api_client/v2/model/patch_maintenance_request_data_attributes_components_affected_items.py +++ b/src/datadog_api_client/v2/model/patch_maintenance_request_data_attributes_components_affected_items.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + A component affected by a maintenance. :param id: The ID of the component. Must be a component of type ``component``. :type id: UUID diff --git a/src/datadog_api_client/v2/model/patch_status_page_request.py b/src/datadog_api_client/v2/model/patch_status_page_request.py index 512018ec0f..d052c26121 100644 --- a/src/datadog_api_client/v2/model/patch_status_page_request.py +++ b/src/datadog_api_client/v2/model/patch_status_page_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[PatchStatusPageRequestData, UnsetType] = unset, **kwargs): """ + Request object for updating a status page. - - :param data: + :param data: The data object for updating a status page. :type data: PatchStatusPageRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/patch_status_page_request_data.py b/src/datadog_api_client/v2/model/patch_status_page_request_data.py index e023426196..39ca2cdb34 100644 --- a/src/datadog_api_client/v2/model/patch_status_page_request_data.py +++ b/src/datadog_api_client/v2/model/patch_status_page_request_data.py @@ -41,7 +41,7 @@ def openapi_types(_): def __init__(self_, attributes: PatchStatusPageRequestDataAttributes, id: UUID, type: StatusPageDataType, **kwargs): """ - + The data object for updating a status page. :param attributes: The supported attributes for updating a status page. :type attributes: PatchStatusPageRequestDataAttributes diff --git a/src/datadog_api_client/v2/model/playlist.py b/src/datadog_api_client/v2/model/playlist.py index a4c64560eb..01e16a93c5 100644 --- a/src/datadog_api_client/v2/model/playlist.py +++ b/src/datadog_api_client/v2/model/playlist.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: PlaylistData, **kwargs): """ + A single RUM replay playlist resource returned by create, update, or get operations. - - :param data: + :param data: Data object representing a RUM replay playlist, including its identifier, type, and attributes. :type data: PlaylistData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/playlist_array.py b/src/datadog_api_client/v2/model/playlist_array.py index 2978c22893..aefa4b9649 100644 --- a/src/datadog_api_client/v2/model/playlist_array.py +++ b/src/datadog_api_client/v2/model/playlist_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[PlaylistData], **kwargs): """ + A list of RUM replay playlists returned by a list operation. - - :param data: + :param data: Array of playlist data objects. :type data: [PlaylistData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/playlist_data.py b/src/datadog_api_client/v2/model/playlist_data.py index 86c3903b03..85f0a7e3ad 100644 --- a/src/datadog_api_client/v2/model/playlist_data.py +++ b/src/datadog_api_client/v2/model/playlist_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + Data object representing a RUM replay playlist, including its identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes of a RUM replay playlist, including its name, description, session count, and audit timestamps. :type attributes: PlaylistDataAttributes, optional - :param id: + :param id: Unique identifier of the playlist. :type id: str, optional :param type: Rum replay playlist resource type. diff --git a/src/datadog_api_client/v2/model/playlist_data_attributes.py b/src/datadog_api_client/v2/model/playlist_data_attributes.py index 2ab734b120..00b90ed885 100644 --- a/src/datadog_api_client/v2/model/playlist_data_attributes.py +++ b/src/datadog_api_client/v2/model/playlist_data_attributes.py @@ -52,24 +52,24 @@ def __init__( **kwargs, ): """ + Attributes of a RUM replay playlist, including its name, description, session count, and audit timestamps. - - :param created_at: + :param created_at: Timestamp when the playlist was created. :type created_at: datetime, optional - :param created_by: + :param created_by: Information about the user who created the playlist. :type created_by: PlaylistDataAttributesCreatedBy, optional - :param description: + :param description: Optional human-readable description of the playlist's purpose or contents. :type description: str, optional - :param name: + :param name: Human-readable name of the playlist. :type name: str - :param session_count: + :param session_count: Number of replay sessions in the playlist. :type session_count: int, optional - :param updated_at: + :param updated_at: Timestamp when the playlist was last updated. :type updated_at: datetime, optional """ if created_at is not unset: diff --git a/src/datadog_api_client/v2/model/playlist_data_attributes_created_by.py b/src/datadog_api_client/v2/model/playlist_data_attributes_created_by.py index 8e1501559a..86aa56cee6 100644 --- a/src/datadog_api_client/v2/model/playlist_data_attributes_created_by.py +++ b/src/datadog_api_client/v2/model/playlist_data_attributes_created_by.py @@ -42,21 +42,21 @@ def __init__( **kwargs, ): """ + Information about the user who created the playlist. - - :param handle: + :param handle: Email handle of the user who created the playlist. :type handle: str - :param icon: + :param icon: URL or identifier of the user's avatar icon. :type icon: str, optional - :param id: + :param id: Unique identifier of the user who created the playlist. :type id: str - :param name: + :param name: Display name of the user who created the playlist. :type name: str, optional - :param uuid: + :param uuid: UUID of the user who created the playlist. :type uuid: str """ if icon is not unset: diff --git a/src/datadog_api_client/v2/model/playlists_session.py b/src/datadog_api_client/v2/model/playlists_session.py index 24b3ca12ec..812e0c1c51 100644 --- a/src/datadog_api_client/v2/model/playlists_session.py +++ b/src/datadog_api_client/v2/model/playlists_session.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: PlaylistsSessionData, **kwargs): """ + A single RUM replay session resource as it appears within a playlist context. - - :param data: + :param data: Data object representing a session within a playlist, including its identifier, type, and attributes. :type data: PlaylistsSessionData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/playlists_session_array.py b/src/datadog_api_client/v2/model/playlists_session_array.py index a804f8d3f6..f9a7ab42b0 100644 --- a/src/datadog_api_client/v2/model/playlists_session_array.py +++ b/src/datadog_api_client/v2/model/playlists_session_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[PlaylistsSessionData], **kwargs): """ + A list of RUM replay sessions belonging to a playlist. - - :param data: + :param data: Array of playlist session data objects. :type data: [PlaylistsSessionData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/playlists_session_data.py b/src/datadog_api_client/v2/model/playlists_session_data.py index 3770747563..bea2562d26 100644 --- a/src/datadog_api_client/v2/model/playlists_session_data.py +++ b/src/datadog_api_client/v2/model/playlists_session_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + Data object representing a session within a playlist, including its identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes of a session within a playlist, including the session event data and its replay track. :type attributes: PlaylistsSessionDataAttributes, optional - :param id: + :param id: Unique identifier of the RUM replay session. :type id: str, optional :param type: Rum replay session resource type. diff --git a/src/datadog_api_client/v2/model/playlists_session_data_attributes.py b/src/datadog_api_client/v2/model/playlists_session_data_attributes.py index 1c60c87228..2681b573fe 100644 --- a/src/datadog_api_client/v2/model/playlists_session_data_attributes.py +++ b/src/datadog_api_client/v2/model/playlists_session_data_attributes.py @@ -49,12 +49,12 @@ def __init__( self_, session_event: Union[Dict[str, Any], UnsetType] = unset, track: Union[str, UnsetType] = unset, **kwargs ): """ + Attributes of a session within a playlist, including the session event data and its replay track. - - :param session_event: + :param session_event: Raw event data associated with the replay session. :type session_event: {str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional - :param track: + :param track: Replay track identifier indicating which recording track the session belongs to. :type track: str, optional """ if session_event is not unset: diff --git a/src/datadog_api_client/v2/model/postmortem_attachment_request.py b/src/datadog_api_client/v2/model/postmortem_attachment_request.py index 9dd5146563..07021790be 100644 --- a/src/datadog_api_client/v2/model/postmortem_attachment_request.py +++ b/src/datadog_api_client/v2/model/postmortem_attachment_request.py @@ -30,7 +30,7 @@ def openapi_types(_): def __init__(self_, data: PostmortemAttachmentRequestData, **kwargs): """ - + Request body for creating a postmortem attachment. :param data: Postmortem attachment data :type data: PostmortemAttachmentRequestData diff --git a/src/datadog_api_client/v2/model/postmortem_template_attributes_request.py b/src/datadog_api_client/v2/model/postmortem_template_attributes_request.py index 68159fb2b3..8f980239a5 100644 --- a/src/datadog_api_client/v2/model/postmortem_template_attributes_request.py +++ b/src/datadog_api_client/v2/model/postmortem_template_attributes_request.py @@ -23,7 +23,7 @@ def openapi_types(_): def __init__(self_, name: str, **kwargs): """ - + Attributes for creating or updating a postmortem template. :param name: The name of the template :type name: str diff --git a/src/datadog_api_client/v2/model/postmortem_template_attributes_response.py b/src/datadog_api_client/v2/model/postmortem_template_attributes_response.py index 51f9687347..e176cdedf5 100644 --- a/src/datadog_api_client/v2/model/postmortem_template_attributes_response.py +++ b/src/datadog_api_client/v2/model/postmortem_template_attributes_response.py @@ -28,7 +28,7 @@ def openapi_types(_): def __init__(self_, created_at: datetime, modified_at: datetime, name: str, **kwargs): """ - + Attributes of a postmortem template returned in a response. :param created_at: When the template was created :type created_at: datetime diff --git a/src/datadog_api_client/v2/model/postmortem_template_data_request.py b/src/datadog_api_client/v2/model/postmortem_template_data_request.py index 15e4aecfe1..092bf03a9e 100644 --- a/src/datadog_api_client/v2/model/postmortem_template_data_request.py +++ b/src/datadog_api_client/v2/model/postmortem_template_data_request.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, attributes: PostmortemTemplateAttributesRequest, type: PostmortemTemplateType, **kwargs): """ + Data object for creating or updating a postmortem template. - - :param attributes: + :param attributes: Attributes for creating or updating a postmortem template. :type attributes: PostmortemTemplateAttributesRequest :param type: Postmortem template resource type diff --git a/src/datadog_api_client/v2/model/postmortem_template_data_response.py b/src/datadog_api_client/v2/model/postmortem_template_data_response.py index 660f4b090d..9b692ab967 100644 --- a/src/datadog_api_client/v2/model/postmortem_template_data_response.py +++ b/src/datadog_api_client/v2/model/postmortem_template_data_response.py @@ -40,9 +40,9 @@ def __init__( self_, attributes: PostmortemTemplateAttributesResponse, id: str, type: PostmortemTemplateType, **kwargs ): """ + Data object for a postmortem template returned in a response. - - :param attributes: + :param attributes: Attributes of a postmortem template returned in a response. :type attributes: PostmortemTemplateAttributesResponse :param id: The ID of the template diff --git a/src/datadog_api_client/v2/model/postmortem_template_request.py b/src/datadog_api_client/v2/model/postmortem_template_request.py index e327511e36..6c10d5f297 100644 --- a/src/datadog_api_client/v2/model/postmortem_template_request.py +++ b/src/datadog_api_client/v2/model/postmortem_template_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: PostmortemTemplateDataRequest, **kwargs): """ + Request body for creating or updating a postmortem template. - - :param data: + :param data: Data object for creating or updating a postmortem template. :type data: PostmortemTemplateDataRequest """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/postmortem_template_response.py b/src/datadog_api_client/v2/model/postmortem_template_response.py index 84dc53e94b..6f1a7c521e 100644 --- a/src/datadog_api_client/v2/model/postmortem_template_response.py +++ b/src/datadog_api_client/v2/model/postmortem_template_response.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: PostmortemTemplateDataResponse, **kwargs): """ + Response containing a single postmortem template. - - :param data: + :param data: Data object for a postmortem template returned in a response. :type data: PostmortemTemplateDataResponse """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/postmortem_templates_response.py b/src/datadog_api_client/v2/model/postmortem_templates_response.py index 56eb28cc77..8bdbbf9504 100644 --- a/src/datadog_api_client/v2/model/postmortem_templates_response.py +++ b/src/datadog_api_client/v2/model/postmortem_templates_response.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[PostmortemTemplateDataResponse], **kwargs): """ + Response containing a list of postmortem templates. - - :param data: + :param data: An array of postmortem template data objects. :type data: [PostmortemTemplateDataResponse] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/preview_entity_response_data.py b/src/datadog_api_client/v2/model/preview_entity_response_data.py index 0180d27f0b..c839c874f2 100644 --- a/src/datadog_api_client/v2/model/preview_entity_response_data.py +++ b/src/datadog_api_client/v2/model/preview_entity_response_data.py @@ -49,15 +49,15 @@ def __init__( **kwargs, ): """ + Entity data returned in a preview response, including attributes, relationships, and type. - - :param attributes: + :param attributes: Entity response attributes containing core entity metadata fields. :type attributes: EntityResponseDataAttributes, optional - :param id: + :param id: Entity unique identifier. :type id: str, optional - :param relationships: + :param relationships: Entity relationships including incidents, oncalls, schemas, and related entities. :type relationships: EntityResponseDataRelationships, optional :param type: Entity resource type. diff --git a/src/datadog_api_client/v2/model/product_analytics_interval.py b/src/datadog_api_client/v2/model/product_analytics_interval.py index c360dcc78a..1950c5b3f3 100644 --- a/src/datadog_api_client/v2/model/product_analytics_interval.py +++ b/src/datadog_api_client/v2/model/product_analytics_interval.py @@ -41,16 +41,16 @@ def __init__( """ An interval definition in a timeseries response. - :param milliseconds: + :param milliseconds: The duration of each time bucket in milliseconds. :type milliseconds: int, optional - :param start_time: + :param start_time: The start of this interval as an epoch timestamp in milliseconds. :type start_time: int, optional - :param times: + :param times: Epoch timestamps (in milliseconds) for each bucket in this interval. :type times: [int], optional - :param type: + :param type: The interval type (e.g., fixed or auto-computed bucket size). :type type: str, optional """ if milliseconds is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_response_meta.py b/src/datadog_api_client/v2/model/product_analytics_response_meta.py index 93dbd36513..8e246e028d 100644 --- a/src/datadog_api_client/v2/model/product_analytics_response_meta.py +++ b/src/datadog_api_client/v2/model/product_analytics_response_meta.py @@ -43,10 +43,10 @@ def __init__( """ Metadata for a Product Analytics query response. - :param request_id: + :param request_id: Unique identifier for the request, used for multi-step query continuation. :type request_id: str, optional - :param status: + :param status: The execution status of a Product Analytics query. :type status: ProductAnalyticsResponseMetaStatus, optional """ if request_id is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_response_meta_status.py b/src/datadog_api_client/v2/model/product_analytics_response_meta_status.py index b58d6e7a19..8a3be067ab 100644 --- a/src/datadog_api_client/v2/model/product_analytics_response_meta_status.py +++ b/src/datadog_api_client/v2/model/product_analytics_response_meta_status.py @@ -14,7 +14,7 @@ class ProductAnalyticsResponseMetaStatus(ModelSimple): """ - + The execution status of a Product Analytics query. :param value: Must be one of ["done", "running", "timeout"]. :type value: str diff --git a/src/datadog_api_client/v2/model/product_analytics_scalar_column.py b/src/datadog_api_client/v2/model/product_analytics_scalar_column.py index 799e4ea6b9..2cf4e01a81 100644 --- a/src/datadog_api_client/v2/model/product_analytics_scalar_column.py +++ b/src/datadog_api_client/v2/model/product_analytics_scalar_column.py @@ -53,7 +53,7 @@ def __init__( """ A column in a scalar response. - :param meta: + :param meta: Metadata associated with a scalar response column, including optional unit information. :type meta: ProductAnalyticsScalarColumnMeta, optional :param name: Column name (facet name for group-by, or "query"). diff --git a/src/datadog_api_client/v2/model/product_analytics_scalar_column_meta.py b/src/datadog_api_client/v2/model/product_analytics_scalar_column_meta.py index db408cb03f..10168b29f4 100644 --- a/src/datadog_api_client/v2/model/product_analytics_scalar_column_meta.py +++ b/src/datadog_api_client/v2/model/product_analytics_scalar_column_meta.py @@ -33,9 +33,9 @@ def openapi_types(_): def __init__(self_, unit: Union[List[ProductAnalyticsUnit], none_type, UnsetType] = unset, **kwargs): """ + Metadata associated with a scalar response column, including optional unit information. - - :param unit: + :param unit: Unit definitions for the column values, if applicable. :type unit: [ProductAnalyticsUnit], none_type, optional """ if unit is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_scalar_response_attributes.py b/src/datadog_api_client/v2/model/product_analytics_scalar_response_attributes.py index af7324af27..59bae77452 100644 --- a/src/datadog_api_client/v2/model/product_analytics_scalar_response_attributes.py +++ b/src/datadog_api_client/v2/model/product_analytics_scalar_response_attributes.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, columns: Union[List[ProductAnalyticsScalarColumn], UnsetType] = unset, **kwargs): """ + Attributes of a scalar analytics response, containing the result columns. - - :param columns: + :param columns: The list of result columns, each containing values and metadata. :type columns: [ProductAnalyticsScalarColumn], optional """ if columns is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_scalar_response_data.py b/src/datadog_api_client/v2/model/product_analytics_scalar_response_data.py index a02ca854e7..cd326ce160 100644 --- a/src/datadog_api_client/v2/model/product_analytics_scalar_response_data.py +++ b/src/datadog_api_client/v2/model/product_analytics_scalar_response_data.py @@ -52,13 +52,13 @@ def __init__( """ Data object for a scalar response. - :param attributes: + :param attributes: Attributes of a scalar analytics response, containing the result columns. :type attributes: ProductAnalyticsScalarResponseAttributes, optional - :param id: + :param id: Unique identifier for this response data object. :type id: str, optional - :param type: + :param type: The resource type identifier for a scalar analytics response. :type type: ProductAnalyticsScalarResponseType, optional """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_scalar_response_type.py b/src/datadog_api_client/v2/model/product_analytics_scalar_response_type.py index db2051dfd6..b65dd7556a 100644 --- a/src/datadog_api_client/v2/model/product_analytics_scalar_response_type.py +++ b/src/datadog_api_client/v2/model/product_analytics_scalar_response_type.py @@ -14,7 +14,7 @@ class ProductAnalyticsScalarResponseType(ModelSimple): """ - + The resource type identifier for a scalar analytics response. :param value: If omitted defaults to "scalar_response". Must be one of ["scalar_response"]. :type value: str diff --git a/src/datadog_api_client/v2/model/product_analytics_serie.py b/src/datadog_api_client/v2/model/product_analytics_serie.py index 3db4004a02..036b879d8b 100644 --- a/src/datadog_api_client/v2/model/product_analytics_serie.py +++ b/src/datadog_api_client/v2/model/product_analytics_serie.py @@ -44,13 +44,13 @@ def __init__( """ A series in a timeseries response. - :param group_tags: + :param group_tags: The group-by tag values that identify this series. :type group_tags: [str], optional - :param query_index: + :param query_index: The index of the query that produced this series. :type query_index: int, optional - :param unit: + :param unit: Unit definitions for the series values. :type unit: [ProductAnalyticsUnit], optional """ if group_tags is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_timeseries_response.py b/src/datadog_api_client/v2/model/product_analytics_timeseries_response.py index fd44aa73e6..e2d567f719 100644 --- a/src/datadog_api_client/v2/model/product_analytics_timeseries_response.py +++ b/src/datadog_api_client/v2/model/product_analytics_timeseries_response.py @@ -47,7 +47,7 @@ def __init__( """ Response for a timeseries analytics query. - :param data: + :param data: Data object for a timeseries analytics response. :type data: ProductAnalyticsTimeseriesResponseData, optional :param meta: Metadata for a Product Analytics query response. diff --git a/src/datadog_api_client/v2/model/product_analytics_timeseries_response_attributes.py b/src/datadog_api_client/v2/model/product_analytics_timeseries_response_attributes.py index b913dec4a0..d400f94caa 100644 --- a/src/datadog_api_client/v2/model/product_analytics_timeseries_response_attributes.py +++ b/src/datadog_api_client/v2/model/product_analytics_timeseries_response_attributes.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions. - - :param intervals: + :param intervals: Interval definitions describing the time buckets used in the response. :type intervals: [ProductAnalyticsInterval], optional - :param series: + :param series: The list of series, each corresponding to a query or group-by combination. :type series: [ProductAnalyticsSerie], optional :param times: Timestamps for each data point (epoch milliseconds). diff --git a/src/datadog_api_client/v2/model/product_analytics_timeseries_response_data.py b/src/datadog_api_client/v2/model/product_analytics_timeseries_response_data.py index 699e4456f3..8d499f45f0 100644 --- a/src/datadog_api_client/v2/model/product_analytics_timeseries_response_data.py +++ b/src/datadog_api_client/v2/model/product_analytics_timeseries_response_data.py @@ -52,15 +52,15 @@ def __init__( **kwargs, ): """ + Data object for a timeseries analytics response. - - :param attributes: + :param attributes: Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions. :type attributes: ProductAnalyticsTimeseriesResponseAttributes, optional - :param id: + :param id: Unique identifier for this response data object. :type id: str, optional - :param type: + :param type: The resource type identifier for a timeseries analytics response. :type type: ProductAnalyticsTimeseriesResponseType, optional """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/product_analytics_timeseries_response_type.py b/src/datadog_api_client/v2/model/product_analytics_timeseries_response_type.py index c9ab3f77c3..44a8b1b3de 100644 --- a/src/datadog_api_client/v2/model/product_analytics_timeseries_response_type.py +++ b/src/datadog_api_client/v2/model/product_analytics_timeseries_response_type.py @@ -14,7 +14,7 @@ class ProductAnalyticsTimeseriesResponseType(ModelSimple): """ - + The resource type identifier for a timeseries analytics response. :param value: If omitted defaults to "timeseries_response". Must be one of ["timeseries_response"]. :type value: str diff --git a/src/datadog_api_client/v2/model/product_analytics_unit.py b/src/datadog_api_client/v2/model/product_analytics_unit.py index e4c56073e5..424d32b2f7 100644 --- a/src/datadog_api_client/v2/model/product_analytics_unit.py +++ b/src/datadog_api_client/v2/model/product_analytics_unit.py @@ -47,22 +47,22 @@ def __init__( """ A unit definition for metric values. - :param family: + :param family: The unit family (e.g., time, bytes). :type family: str, optional - :param id: + :param id: Numeric identifier for the unit. :type id: int, optional - :param name: + :param name: The full name of the unit (e.g., nanosecond). :type name: str, optional - :param plural: + :param plural: Plural form of the unit name (e.g., nanoseconds). :type plural: str, optional - :param scale_factor: + :param scale_factor: Conversion factor relative to the base unit of the family. :type scale_factor: float, optional - :param short_name: + :param short_name: Abbreviated unit name (e.g., ns). :type short_name: str, optional """ if family is not unset: diff --git a/src/datadog_api_client/v2/model/project.py b/src/datadog_api_client/v2/model/project.py index ac2d2d370a..0344634bad 100644 --- a/src/datadog_api_client/v2/model/project.py +++ b/src/datadog_api_client/v2/model/project.py @@ -49,18 +49,18 @@ def __init__( **kwargs, ): """ - A Project + A Project. - :param attributes: Project attributes + :param attributes: Project attributes. :type attributes: ProjectAttributes - :param id: The Project's identifier + :param id: The Project's identifier. :type id: str - :param relationships: Project relationships + :param relationships: Project relationships. :type relationships: ProjectRelationships, optional - :param type: Project resource type + :param type: Project resource type. :type type: ProjectResourceType """ if relationships is not unset: diff --git a/src/datadog_api_client/v2/model/project_attributes.py b/src/datadog_api_client/v2/model/project_attributes.py index 425a8a133e..315a77948c 100644 --- a/src/datadog_api_client/v2/model/project_attributes.py +++ b/src/datadog_api_client/v2/model/project_attributes.py @@ -53,24 +53,24 @@ def __init__( **kwargs, ): """ - Project attributes + Project attributes. - :param columns_config: Project columns configuration + :param columns_config: Project columns configuration. :type columns_config: ProjectColumnsConfig, optional - :param enabled_custom_case_types: List of enabled custom case type IDs + :param enabled_custom_case_types: List of enabled custom case type IDs. :type enabled_custom_case_types: [str], optional - :param key: The project's key + :param key: The project's key. :type key: str, optional - :param name: Project's name + :param name: Project's name. :type name: str, optional - :param restricted: Whether the project is restricted + :param restricted: Whether the project is restricted. :type restricted: bool, optional - :param settings: Project settings + :param settings: Project settings. :type settings: ProjectSettings, optional """ if columns_config is not unset: diff --git a/src/datadog_api_client/v2/model/project_columns_config.py b/src/datadog_api_client/v2/model/project_columns_config.py index 24bd5a5098..cdcc3aa075 100644 --- a/src/datadog_api_client/v2/model/project_columns_config.py +++ b/src/datadog_api_client/v2/model/project_columns_config.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, columns: Union[List[ProjectColumnsConfigColumnsItems], UnsetType] = unset, **kwargs): """ - Project columns configuration + Project columns configuration. - :param columns: + :param columns: List of column configurations for the project board view. :type columns: [ProjectColumnsConfigColumnsItems], optional """ if columns is not unset: diff --git a/src/datadog_api_client/v2/model/project_columns_config_columns_items.py b/src/datadog_api_client/v2/model/project_columns_config_columns_items.py index c9057f0e98..3685557623 100644 --- a/src/datadog_api_client/v2/model/project_columns_config_columns_items.py +++ b/src/datadog_api_client/v2/model/project_columns_config_columns_items.py @@ -46,15 +46,15 @@ def __init__( **kwargs, ): """ + Configuration for a single column in a project board view. - - :param sort: + :param sort: Sort configuration for a project board column. :type sort: ProjectColumnsConfigColumnsItemsSort, optional - :param sort_field: + :param sort_field: The field used to sort items in this column. :type sort_field: str, optional - :param type: + :param type: The type of column. :type type: str, optional """ if sort is not unset: diff --git a/src/datadog_api_client/v2/model/project_columns_config_columns_items_sort.py b/src/datadog_api_client/v2/model/project_columns_config_columns_items_sort.py index e65dbfa68f..f32ea8bbc6 100644 --- a/src/datadog_api_client/v2/model/project_columns_config_columns_items_sort.py +++ b/src/datadog_api_client/v2/model/project_columns_config_columns_items_sort.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, ascending: Union[bool, UnsetType] = unset, priority: Union[int, UnsetType] = unset, **kwargs): """ + Sort configuration for a project board column. - - :param ascending: + :param ascending: Whether to sort in ascending order. :type ascending: bool, optional - :param priority: + :param priority: The sort priority order for this column. :type priority: int, optional """ if ascending is not unset: diff --git a/src/datadog_api_client/v2/model/project_create.py b/src/datadog_api_client/v2/model/project_create.py index bd4af042a1..dc3b70105c 100644 --- a/src/datadog_api_client/v2/model/project_create.py +++ b/src/datadog_api_client/v2/model/project_create.py @@ -34,12 +34,12 @@ def openapi_types(_): def __init__(self_, attributes: ProjectCreateAttributes, type: ProjectResourceType, **kwargs): """ - Project create + Project create. - :param attributes: Project creation attributes + :param attributes: Project creation attributes. :type attributes: ProjectCreateAttributes - :param type: Project resource type + :param type: Project resource type. :type type: ProjectResourceType """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/project_create_attributes.py b/src/datadog_api_client/v2/model/project_create_attributes.py index 8167dd0e6e..72c97fead3 100644 --- a/src/datadog_api_client/v2/model/project_create_attributes.py +++ b/src/datadog_api_client/v2/model/project_create_attributes.py @@ -39,18 +39,18 @@ def __init__( **kwargs, ): """ - Project creation attributes + Project creation attributes. - :param enabled_custom_case_types: List of enabled custom case type IDs + :param enabled_custom_case_types: List of enabled custom case type IDs. :type enabled_custom_case_types: [str], optional - :param key: Project's key. Cannot be "CASE" + :param key: Project's key. Cannot be "CASE". :type key: str - :param name: Project name + :param name: Project name. :type name: str - :param team_uuid: Team UUID to associate with the project + :param team_uuid: Team UUID to associate with the project. :type team_uuid: str, optional """ if enabled_custom_case_types is not unset: diff --git a/src/datadog_api_client/v2/model/project_create_request.py b/src/datadog_api_client/v2/model/project_create_request.py index 0aded0fa84..d496b22c32 100644 --- a/src/datadog_api_client/v2/model/project_create_request.py +++ b/src/datadog_api_client/v2/model/project_create_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: ProjectCreate, **kwargs): """ - Project create request + Project create request. - :param data: Project create + :param data: Project create. :type data: ProjectCreate """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/project_notification_settings.py b/src/datadog_api_client/v2/model/project_notification_settings.py index b8405ef812..d2f900cb93 100644 --- a/src/datadog_api_client/v2/model/project_notification_settings.py +++ b/src/datadog_api_client/v2/model/project_notification_settings.py @@ -54,33 +54,33 @@ def __init__( **kwargs, ): """ - Project notification settings + Project notification settings. - :param destinations: Notification destinations (1=email, 2=slack, 3=in-app) + :param destinations: Notification destinations (1=email, 2=slack, 3=in-app). :type destinations: [int], optional - :param enabled: Whether notifications are enabled + :param enabled: Whether notifications are enabled. :type enabled: bool, optional - :param notify_on_case_assignment: + :param notify_on_case_assignment: Whether to send a notification when a case is assigned. :type notify_on_case_assignment: bool, optional - :param notify_on_case_closed: + :param notify_on_case_closed: Whether to send a notification when a case is closed. :type notify_on_case_closed: bool, optional - :param notify_on_case_comment: + :param notify_on_case_comment: Whether to send a notification when a comment is added to a case. :type notify_on_case_comment: bool, optional - :param notify_on_case_comment_mention: + :param notify_on_case_comment_mention: Whether to send a notification when a user is mentioned in a case comment. :type notify_on_case_comment_mention: bool, optional - :param notify_on_case_priority_change: + :param notify_on_case_priority_change: Whether to send a notification when a case's priority changes. :type notify_on_case_priority_change: bool, optional - :param notify_on_case_status_change: + :param notify_on_case_status_change: Whether to send a notification when a case's status changes. :type notify_on_case_status_change: bool, optional - :param notify_on_case_unassignment: + :param notify_on_case_unassignment: Whether to send a notification when a case is unassigned. :type notify_on_case_unassignment: bool, optional """ if destinations is not unset: diff --git a/src/datadog_api_client/v2/model/project_relationship.py b/src/datadog_api_client/v2/model/project_relationship.py index 9697705fb3..c47c3ec711 100644 --- a/src/datadog_api_client/v2/model/project_relationship.py +++ b/src/datadog_api_client/v2/model/project_relationship.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: ProjectRelationshipData, **kwargs): """ - Relationship to project + Relationship to project. - :param data: Relationship to project object + :param data: Relationship to project object. :type data: ProjectRelationshipData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/project_relationship_data.py b/src/datadog_api_client/v2/model/project_relationship_data.py index 8af44c7b9a..71ae65de9b 100644 --- a/src/datadog_api_client/v2/model/project_relationship_data.py +++ b/src/datadog_api_client/v2/model/project_relationship_data.py @@ -32,12 +32,12 @@ def openapi_types(_): def __init__(self_, id: str, type: ProjectResourceType, **kwargs): """ - Relationship to project object + Relationship to project object. - :param id: A unique identifier that represents the project + :param id: A unique identifier that represents the project. :type id: str - :param type: Project resource type + :param type: Project resource type. :type type: ProjectResourceType """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/project_relationships.py b/src/datadog_api_client/v2/model/project_relationships.py index 9b8e496691..0837f25092 100644 --- a/src/datadog_api_client/v2/model/project_relationships.py +++ b/src/datadog_api_client/v2/model/project_relationships.py @@ -41,7 +41,7 @@ def __init__( **kwargs, ): """ - Project relationships + Project relationships. :param member_team: Relationship between a team and a team link :type member_team: RelationshipToTeamLinks, optional diff --git a/src/datadog_api_client/v2/model/project_resource_type.py b/src/datadog_api_client/v2/model/project_resource_type.py index c3513efedf..2d8cb5957a 100644 --- a/src/datadog_api_client/v2/model/project_resource_type.py +++ b/src/datadog_api_client/v2/model/project_resource_type.py @@ -14,7 +14,7 @@ class ProjectResourceType(ModelSimple): """ - Project resource type + Project resource type. :param value: If omitted defaults to "project". Must be one of ["project"]. :type value: str diff --git a/src/datadog_api_client/v2/model/project_response.py b/src/datadog_api_client/v2/model/project_response.py index 96c6c7f1ce..e5180aee41 100644 --- a/src/datadog_api_client/v2/model/project_response.py +++ b/src/datadog_api_client/v2/model/project_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[Project, UnsetType] = unset, **kwargs): """ - Project response + Project response. - :param data: A Project + :param data: A Project. :type data: Project, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/project_settings.py b/src/datadog_api_client/v2/model/project_settings.py index 51af6b2002..a1736526e4 100644 --- a/src/datadog_api_client/v2/model/project_settings.py +++ b/src/datadog_api_client/v2/model/project_settings.py @@ -71,30 +71,30 @@ def __init__( **kwargs, ): """ - Project settings + Project settings. - :param auto_close_inactive_cases: Auto-close inactive cases settings + :param auto_close_inactive_cases: Auto-close inactive cases settings. :type auto_close_inactive_cases: AutoCloseInactiveCases, optional - :param auto_transition_assigned_cases: Auto-transition assigned cases settings + :param auto_transition_assigned_cases: Auto-transition assigned cases settings. :type auto_transition_assigned_cases: AutoTransitionAssignedCases, optional - :param integration_incident: Incident integration settings + :param integration_incident: Incident integration settings. :type integration_incident: IntegrationIncident, optional - :param integration_jira: Jira integration settings + :param integration_jira: Jira integration settings. :type integration_jira: IntegrationJira, optional - :param integration_monitor: Monitor integration settings + :param integration_monitor: Monitor integration settings. :type integration_monitor: IntegrationMonitor, optional - :param integration_on_call: On-Call integration settings + :param integration_on_call: On-Call integration settings. :type integration_on_call: IntegrationOnCall, optional - :param integration_service_now: ServiceNow integration settings + :param integration_service_now: ServiceNow integration settings. :type integration_service_now: IntegrationServiceNow, optional - :param notification: Project notification settings + :param notification: Project notification settings. :type notification: ProjectNotificationSettings, optional """ if auto_close_inactive_cases is not unset: diff --git a/src/datadog_api_client/v2/model/project_update.py b/src/datadog_api_client/v2/model/project_update.py index af23d83ff7..0cf59cb1d3 100644 --- a/src/datadog_api_client/v2/model/project_update.py +++ b/src/datadog_api_client/v2/model/project_update.py @@ -38,12 +38,12 @@ def __init__( self_, type: ProjectResourceType, attributes: Union[ProjectUpdateAttributes, UnsetType] = unset, **kwargs ): """ - Project update + Project update. - :param attributes: Project update attributes + :param attributes: Project update attributes. :type attributes: ProjectUpdateAttributes, optional - :param type: Project resource type + :param type: Project resource type. :type type: ProjectResourceType """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/project_update_attributes.py b/src/datadog_api_client/v2/model/project_update_attributes.py index c0650100a2..86d137afb2 100644 --- a/src/datadog_api_client/v2/model/project_update_attributes.py +++ b/src/datadog_api_client/v2/model/project_update_attributes.py @@ -50,21 +50,21 @@ def __init__( **kwargs, ): """ - Project update attributes + Project update attributes. - :param columns_config: Project columns configuration + :param columns_config: Project columns configuration. :type columns_config: ProjectColumnsConfig, optional - :param enabled_custom_case_types: List of enabled custom case type IDs + :param enabled_custom_case_types: List of enabled custom case type IDs. :type enabled_custom_case_types: [str], optional - :param name: Project name + :param name: Project name. :type name: str, optional - :param settings: Project settings + :param settings: Project settings. :type settings: ProjectSettings, optional - :param team_uuid: Team UUID to associate with the project + :param team_uuid: Team UUID to associate with the project. :type team_uuid: str, optional """ if columns_config is not unset: diff --git a/src/datadog_api_client/v2/model/project_update_request.py b/src/datadog_api_client/v2/model/project_update_request.py index 907229a657..67692c2915 100644 --- a/src/datadog_api_client/v2/model/project_update_request.py +++ b/src/datadog_api_client/v2/model/project_update_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: ProjectUpdate, **kwargs): """ - Project update request + Project update request. - :param data: Project update + :param data: Project update. :type data: ProjectUpdate """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/projects_response.py b/src/datadog_api_client/v2/model/projects_response.py index 0c1fc8793f..3e752fa174 100644 --- a/src/datadog_api_client/v2/model/projects_response.py +++ b/src/datadog_api_client/v2/model/projects_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[List[Project], UnsetType] = unset, **kwargs): """ - Response with projects + Response with projects. - :param data: Projects response data + :param data: Projects response data. :type data: [Project], optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/query_account_request.py b/src/datadog_api_client/v2/model/query_account_request.py index 584e285973..b811a1533d 100644 --- a/src/datadog_api_client/v2/model/query_account_request.py +++ b/src/datadog_api_client/v2/model/query_account_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[QueryAccountRequestData, UnsetType] = unset, **kwargs): """ + Request body for querying accounts with optional filtering, column selection, and sorting. - - :param data: + :param data: The data object containing the resource type and attributes for querying accounts. :type data: QueryAccountRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/query_account_request_data.py b/src/datadog_api_client/v2/model/query_account_request_data.py index fdab7735c2..705fef1f18 100644 --- a/src/datadog_api_client/v2/model/query_account_request_data.py +++ b/src/datadog_api_client/v2/model/query_account_request_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for querying accounts. - - :param attributes: + :param attributes: Attributes for filtering and shaping the account query results. :type attributes: QueryAccountRequestDataAttributes, optional - :param id: + :param id: Unique identifier for the query account request resource. :type id: str, optional :param type: Query account request resource type. diff --git a/src/datadog_api_client/v2/model/query_account_request_data_attributes.py b/src/datadog_api_client/v2/model/query_account_request_data_attributes.py index 62e0e7e072..49a31cac32 100644 --- a/src/datadog_api_client/v2/model/query_account_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/query_account_request_data_attributes.py @@ -52,21 +52,21 @@ def __init__( **kwargs, ): """ + Attributes for filtering and shaping the account query results. - - :param limit: + :param limit: Maximum number of account records to return in the response. :type limit: int, optional - :param query: + :param query: Filter expression using account attribute conditions to narrow results. :type query: str, optional - :param select_columns: + :param select_columns: List of account attribute column names to include in the response. :type select_columns: [str], optional - :param sort: + :param sort: Sorting configuration specifying the field and direction for ordering query results. :type sort: QueryAccountRequestDataAttributesSort, optional - :param wildcard_search_term: + :param wildcard_search_term: Free-text term used for wildcard search across account attribute values. :type wildcard_search_term: str, optional """ if limit is not unset: diff --git a/src/datadog_api_client/v2/model/query_account_request_data_attributes_sort.py b/src/datadog_api_client/v2/model/query_account_request_data_attributes_sort.py index 1b4f7b0185..21fe495b35 100644 --- a/src/datadog_api_client/v2/model/query_account_request_data_attributes_sort.py +++ b/src/datadog_api_client/v2/model/query_account_request_data_attributes_sort.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, field: Union[str, UnsetType] = unset, order: Union[str, UnsetType] = unset, **kwargs): """ + Sorting configuration specifying the field and direction for ordering query results. - - :param field: + :param field: The attribute field name to sort results by. :type field: str, optional - :param order: + :param order: The sort direction, either ascending or descending. :type order: str, optional """ if field is not unset: diff --git a/src/datadog_api_client/v2/model/query_event_filtered_users_request.py b/src/datadog_api_client/v2/model/query_event_filtered_users_request.py index 07d8dd69f8..48fbf51c9d 100644 --- a/src/datadog_api_client/v2/model/query_event_filtered_users_request.py +++ b/src/datadog_api_client/v2/model/query_event_filtered_users_request.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: Union[QueryEventFilteredUsersRequestData, UnsetType] = unset, **kwargs): """ + Request body for querying users filtered by user properties combined with event platform activity. - - :param data: + :param data: The data object containing the resource type and attributes for querying event-filtered users. :type data: QueryEventFilteredUsersRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data.py b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data.py index 5398416e21..0b53e33784 100644 --- a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data.py +++ b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data.py @@ -52,12 +52,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for querying event-filtered users. - - :param attributes: + :param attributes: Attributes for filtering users by both user properties and event platform activity. :type attributes: QueryEventFilteredUsersRequestDataAttributes, optional - :param id: + :param id: Unique identifier for the query event filtered users request resource. :type id: str, optional :param type: Query event filtered users request resource type. diff --git a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes.py b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes.py index 8de65aa343..23d1db0ab8 100644 --- a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes.py @@ -52,21 +52,21 @@ def __init__( **kwargs, ): """ + Attributes for filtering users by both user properties and event platform activity. - - :param event_query: + :param event_query: Event platform query used to filter users based on their event activity within a specified time window. :type event_query: QueryEventFilteredUsersRequestDataAttributesEventQuery, optional - :param include_row_count: + :param include_row_count: Whether to include the total count of matching users in the response. :type include_row_count: bool, optional - :param limit: + :param limit: Maximum number of user records to return in the response. :type limit: int, optional - :param query: + :param query: Filter expression using user attribute conditions to narrow results. :type query: str, optional - :param select_columns: + :param select_columns: List of user attribute column names to include in the response. :type select_columns: [str], optional """ if event_query is not unset: diff --git a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query.py b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query.py index a707cbc526..5404d6d2fd 100644 --- a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query.py +++ b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query.py @@ -43,12 +43,12 @@ def __init__( **kwargs, ): """ + Event platform query used to filter users based on their event activity within a specified time window. - - :param query: + :param query: The event platform query expression for filtering users by their event activity. :type query: str, optional - :param time_frame: + :param time_frame: The time window defining the start and end of the event query period as Unix timestamps. :type time_frame: QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame, optional """ if query is not unset: diff --git a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query_time_frame.py b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query_time_frame.py index 83d64cef92..1b591998fd 100644 --- a/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query_time_frame.py +++ b/src/datadog_api_client/v2/model/query_event_filtered_users_request_data_attributes_event_query_time_frame.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, end: Union[int, UnsetType] = unset, start: Union[int, UnsetType] = unset, **kwargs): """ + The time window defining the start and end of the event query period as Unix timestamps. - - :param end: + :param end: End of the time frame as a Unix timestamp in seconds. :type end: int, optional - :param start: + :param start: Start of the time frame as a Unix timestamp in seconds. :type start: int, optional """ if end is not unset: diff --git a/src/datadog_api_client/v2/model/query_response.py b/src/datadog_api_client/v2/model/query_response.py index d9e2a68409..d3b320d23e 100644 --- a/src/datadog_api_client/v2/model/query_response.py +++ b/src/datadog_api_client/v2/model/query_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[QueryResponseData, UnsetType] = unset, **kwargs): """ + Response containing the query results with matched records and total count. - - :param data: + :param data: The data object containing the resource type and attributes of the query response. :type data: QueryResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/query_response_data.py b/src/datadog_api_client/v2/model/query_response_data.py index 15af73293b..103c699c9d 100644 --- a/src/datadog_api_client/v2/model/query_response_data.py +++ b/src/datadog_api_client/v2/model/query_response_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes of the query response. - - :param attributes: + :param attributes: Attributes of the query response, containing the matched records and total count. :type attributes: QueryResponseDataAttributes, optional - :param id: + :param id: Unique identifier for the query response resource. :type id: str, optional :param type: Query response resource type. diff --git a/src/datadog_api_client/v2/model/query_response_data_attributes.py b/src/datadog_api_client/v2/model/query_response_data_attributes.py index 76116c520a..2cce40cf27 100644 --- a/src/datadog_api_client/v2/model/query_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/query_response_data_attributes.py @@ -32,12 +32,12 @@ def openapi_types(_): def __init__(self_, hits: Union[List[Any], UnsetType] = unset, total: Union[int, UnsetType] = unset, **kwargs): """ + Attributes of the query response, containing the matched records and total count. - - :param hits: + :param hits: The list of matching records returned by the query, each as a map of attribute names to values. :type hits: [bool, date, datetime, dict, float, int, list, str, UUID, none_type], optional - :param total: + :param total: Total number of records matching the query, regardless of the limit applied. :type total: int, optional """ if hits is not unset: diff --git a/src/datadog_api_client/v2/model/query_users_request.py b/src/datadog_api_client/v2/model/query_users_request.py index f579f8a6d9..1af90d123f 100644 --- a/src/datadog_api_client/v2/model/query_users_request.py +++ b/src/datadog_api_client/v2/model/query_users_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[QueryUsersRequestData, UnsetType] = unset, **kwargs): """ + Request body for querying users with optional filtering, column selection, and sorting. - - :param data: + :param data: The data object containing the resource type and attributes for querying users. :type data: QueryUsersRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/query_users_request_data.py b/src/datadog_api_client/v2/model/query_users_request_data.py index 49cb426cf1..6e567539a3 100644 --- a/src/datadog_api_client/v2/model/query_users_request_data.py +++ b/src/datadog_api_client/v2/model/query_users_request_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource type and attributes for querying users. - - :param attributes: + :param attributes: Attributes for filtering and shaping the user query results. :type attributes: QueryUsersRequestDataAttributes, optional - :param id: + :param id: Unique identifier for the query users request resource. :type id: str, optional :param type: Query users request resource type. diff --git a/src/datadog_api_client/v2/model/query_users_request_data_attributes.py b/src/datadog_api_client/v2/model/query_users_request_data_attributes.py index 4af164f201..9496e85313 100644 --- a/src/datadog_api_client/v2/model/query_users_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/query_users_request_data_attributes.py @@ -50,21 +50,21 @@ def __init__( **kwargs, ): """ + Attributes for filtering and shaping the user query results. - - :param limit: + :param limit: Maximum number of user records to return in the response. :type limit: int, optional - :param query: + :param query: Filter expression using user attribute conditions to narrow results. :type query: str, optional - :param select_columns: + :param select_columns: List of user attribute column names to include in the response. :type select_columns: [str], optional - :param sort: + :param sort: Sorting configuration specifying the field and direction for ordering user query results. :type sort: QueryUsersRequestDataAttributesSort, optional - :param wildcard_search_term: + :param wildcard_search_term: Free-text term used for wildcard search across user attribute values. :type wildcard_search_term: str, optional """ if limit is not unset: diff --git a/src/datadog_api_client/v2/model/query_users_request_data_attributes_sort.py b/src/datadog_api_client/v2/model/query_users_request_data_attributes_sort.py index 5f8c27acbe..97b824456f 100644 --- a/src/datadog_api_client/v2/model/query_users_request_data_attributes_sort.py +++ b/src/datadog_api_client/v2/model/query_users_request_data_attributes_sort.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, field: Union[str, UnsetType] = unset, order: Union[str, UnsetType] = unset, **kwargs): """ + Sorting configuration specifying the field and direction for ordering user query results. - - :param field: + :param field: The user attribute field name to sort results by. :type field: str, optional - :param order: + :param order: The sort direction, either ascending or descending. :type order: str, optional """ if field is not unset: diff --git a/src/datadog_api_client/v2/model/recommendation_attributes.py b/src/datadog_api_client/v2/model/recommendation_attributes.py index 3310fcc5a3..287b30f5fd 100644 --- a/src/datadog_api_client/v2/model/recommendation_attributes.py +++ b/src/datadog_api_client/v2/model/recommendation_attributes.py @@ -44,7 +44,7 @@ def __init__( """ Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components. - :param confidence_level: + :param confidence_level: The confidence level of the recommendation, expressed as a value between 0.0 (low confidence) and 1.0 (high confidence). :type confidence_level: float, optional :param driver: Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs. diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request.py index d04703a5ec..485db1cee5 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: Union[ResolveVulnerableSymbolsRequestData, UnsetType] = unset, **kwargs): """ + The top-level request object for resolving vulnerable symbols in a set of packages. - - :param data: + :param data: The data object in a request to resolve vulnerable symbols, containing the package PURLs and request type. :type data: ResolveVulnerableSymbolsRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data.py index cc99a6c8a3..00b7f2cc3f 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data.py @@ -52,15 +52,15 @@ def __init__( **kwargs, ): """ + The data object in a request to resolve vulnerable symbols, containing the package PURLs and request type. - - :param attributes: + :param attributes: The attributes of a request to resolve vulnerable symbols, containing the list of package PURLs to check. :type attributes: ResolveVulnerableSymbolsRequestDataAttributes, optional - :param id: + :param id: An optional identifier for this request data object. :type id: str, optional - :param type: + :param type: The type identifier for requests to resolve vulnerable symbols. :type type: ResolveVulnerableSymbolsRequestDataType """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_attributes.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_attributes.py index e906104b5e..08879570a7 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_attributes.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, purls: Union[List[str], UnsetType] = unset, **kwargs): """ + The attributes of a request to resolve vulnerable symbols, containing the list of package PURLs to check. - - :param purls: + :param purls: The list of Package URLs (PURLs) for which to resolve vulnerable symbols. :type purls: [str], optional """ if purls is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_type.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_type.py index 120efa6e2e..abf4a05a75 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_type.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_request_data_type.py @@ -14,7 +14,7 @@ class ResolveVulnerableSymbolsRequestDataType(ModelSimple): """ - + The type identifier for requests to resolve vulnerable symbols. :param value: If omitted defaults to "resolve-vulnerable-symbols-request". Must be one of ["resolve-vulnerable-symbols-request"]. :type value: str diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response.py index 4ab5f49cb6..8f0fd551d3 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, data: Union[ResolveVulnerableSymbolsResponseData, UnsetType] = unset, **kwargs): """ + The top-level response object returned when resolving vulnerable symbols for a set of packages. - - :param data: + :param data: The data object in a response for resolving vulnerable symbols, containing the result attributes and response type. :type data: ResolveVulnerableSymbolsResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data.py index 1b1484c544..6a5c60d275 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data.py @@ -52,15 +52,15 @@ def __init__( **kwargs, ): """ + The data object in a response for resolving vulnerable symbols, containing the result attributes and response type. - - :param attributes: + :param attributes: The attributes of a response containing resolved vulnerable symbols, organized by package. :type attributes: ResolveVulnerableSymbolsResponseDataAttributes, optional - :param id: + :param id: The unique identifier for this response data object. :type id: str, optional - :param type: + :param type: The type identifier for responses containing resolved vulnerable symbols. :type type: ResolveVulnerableSymbolsResponseDataType """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_attributes.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_attributes.py index bcf82426f2..46614fcabc 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_attributes.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, results: Union[List[ResolveVulnerableSymbolsResponseResults], UnsetType] = unset, **kwargs): """ + The attributes of a response containing resolved vulnerable symbols, organized by package. - - :param results: + :param results: The list of resolved vulnerable symbol results, one entry per queried package. :type results: [ResolveVulnerableSymbolsResponseResults], optional """ if results is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_type.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_type.py index c1357e96fd..6105719e89 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_type.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_data_type.py @@ -14,7 +14,7 @@ class ResolveVulnerableSymbolsResponseDataType(ModelSimple): """ - + The type identifier for responses containing resolved vulnerable symbols. :param value: If omitted defaults to "resolve-vulnerable-symbols-response". Must be one of ["resolve-vulnerable-symbols-response"]. :type value: str diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results.py index 4a826d52c3..37cf9ae805 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results.py @@ -43,12 +43,12 @@ def __init__( **kwargs, ): """ + The result of resolving vulnerable symbols for a specific package, identified by its PURL. - - :param purl: + :param purl: The Package URL (PURL) uniquely identifying the package for which vulnerable symbols are resolved. :type purl: str, optional - :param vulnerable_symbols: + :param vulnerable_symbols: The list of vulnerable symbol groups found in this package, organized by advisory. :type vulnerable_symbols: [ResolveVulnerableSymbolsResponseResultsVulnerableSymbols], optional """ if purl is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols.py index 76bd01f902..537043fed4 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols.py @@ -43,12 +43,12 @@ def __init__( **kwargs, ): """ + A collection of vulnerable symbols associated with a specific security advisory. - - :param advisory_id: + :param advisory_id: The identifier of the security advisory that describes the vulnerability. :type advisory_id: str, optional - :param symbols: + :param symbols: The list of symbols that are vulnerable according to this advisory. :type symbols: [ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols], optional """ if advisory_id is not unset: diff --git a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols_symbols.py b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols_symbols.py index a3a1eb4b6c..d163fd9a2c 100644 --- a/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols_symbols.py +++ b/src/datadog_api_client/v2/model/resolve_vulnerable_symbols_response_results_vulnerable_symbols_symbols.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + A symbol identified as vulnerable within a dependency, including its name, type, and value. - - :param name: + :param name: The name of the vulnerable symbol. :type name: str, optional - :param type: + :param type: The type classification of the vulnerable symbol (e.g., function, class, variable). :type type: str, optional - :param value: + :param value: The value or identifier associated with the vulnerable symbol. :type value: str, optional """ if name is not unset: diff --git a/src/datadog_api_client/v2/model/revert_custom_rule_revision_request.py b/src/datadog_api_client/v2/model/revert_custom_rule_revision_request.py index 31c2c8ccc4..579c0a3550 100644 --- a/src/datadog_api_client/v2/model/revert_custom_rule_revision_request.py +++ b/src/datadog_api_client/v2/model/revert_custom_rule_revision_request.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: Union[RevertCustomRuleRevisionRequestData, UnsetType] = unset, **kwargs): """ + Request body for reverting a custom rule to a previous revision. - - :param data: + :param data: Data object for a request to revert a custom rule to a previous revision. :type data: RevertCustomRuleRevisionRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data.py b/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data.py index af9f268d88..b3ee7ca525 100644 --- a/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data.py +++ b/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data.py @@ -48,9 +48,9 @@ def __init__( **kwargs, ): """ + Data object for a request to revert a custom rule to a previous revision. - - :param attributes: + :param attributes: Attributes specifying the current and target revision IDs for a revert operation. :type attributes: RevertCustomRuleRevisionRequestDataAttributes, optional :param id: Request identifier diff --git a/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data_attributes.py b/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data_attributes.py index 35674921ce..96f85c2eb4 100644 --- a/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/revert_custom_rule_revision_request_data_attributes.py @@ -33,7 +33,7 @@ def __init__( **kwargs, ): """ - + Attributes specifying the current and target revision IDs for a revert operation. :param current_revision: Current revision ID :type current_revision: str, optional diff --git a/src/datadog_api_client/v2/model/sca_request.py b/src/datadog_api_client/v2/model/sca_request.py index 548b0a7b42..471f272767 100644 --- a/src/datadog_api_client/v2/model/sca_request.py +++ b/src/datadog_api_client/v2/model/sca_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[ScaRequestData, UnsetType] = unset, **kwargs): """ + The top-level request object for submitting a Software Composition Analysis (SCA) scan result. - - :param data: + :param data: The data object in an SCA request, containing the dependency graph attributes and request type. :type data: ScaRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data.py b/src/datadog_api_client/v2/model/sca_request_data.py index 7cb0c556e8..762f95f6cb 100644 --- a/src/datadog_api_client/v2/model/sca_request_data.py +++ b/src/datadog_api_client/v2/model/sca_request_data.py @@ -44,15 +44,15 @@ def __init__( **kwargs, ): """ + The data object in an SCA request, containing the dependency graph attributes and request type. - - :param attributes: + :param attributes: The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context. :type attributes: ScaRequestDataAttributes, optional - :param id: + :param id: An optional identifier for this SCA request data object. :type id: str, optional - :param type: + :param type: The type identifier for SCA dependency analysis requests. :type type: ScaRequestDataType """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes.py b/src/datadog_api_client/v2/model/sca_request_data_attributes.py index bb3dfdcfb0..0d8d420480 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes.py @@ -86,33 +86,33 @@ def __init__( **kwargs, ): """ + The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context. - - :param commit: + :param commit: Metadata about the commit associated with the SCA scan, including author, committer, and branch information. :type commit: ScaRequestDataAttributesCommit, optional - :param dependencies: + :param dependencies: The list of dependencies discovered in the repository. :type dependencies: [ScaRequestDataAttributesDependenciesItems], optional - :param env: + :param env: The environment context in which the SCA scan was performed (e.g., production, staging). :type env: str, optional - :param files: + :param files: The list of dependency manifest files found in the repository. :type files: [ScaRequestDataAttributesFilesItems], optional - :param relations: + :param relations: The dependency relations describing the inter-component dependency graph. :type relations: [ScaRequestDataAttributesRelationsItems], optional - :param repository: + :param repository: Information about the source code repository being analyzed. :type repository: ScaRequestDataAttributesRepository, optional - :param service: + :param service: The name of the service or application being analyzed. :type service: str, optional - :param tags: + :param tags: A map of key-value tags providing additional metadata for the SCA scan. :type tags: {str: (str,)}, optional - :param vulnerabilities: + :param vulnerabilities: The list of vulnerabilities identified in the dependency graph. :type vulnerabilities: [ScaRequestDataAttributesVulnerabilitiesItems], optional """ if commit is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_commit.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_commit.py index 2bafc53b73..a99ddff015 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_commit.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_commit.py @@ -48,27 +48,27 @@ def __init__( **kwargs, ): """ + Metadata about the commit associated with the SCA scan, including author, committer, and branch information. - - :param author_date: + :param author_date: The date when the commit was authored. :type author_date: str, optional - :param author_email: + :param author_email: The email address of the commit author. :type author_email: str, optional - :param author_name: + :param author_name: The full name of the commit author. :type author_name: str, optional - :param branch: + :param branch: The branch name on which the commit was made. :type branch: str, optional - :param committer_email: + :param committer_email: The email address of the person who committed the change. :type committer_email: str, optional - :param committer_name: + :param committer_name: The full name of the person who committed the change. :type committer_name: str, optional - :param sha: + :param sha: The SHA hash uniquely identifying the commit. :type sha: str, optional """ if author_date is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items.py index 3db0e5c59d..964dfc00f7 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items.py @@ -78,39 +78,39 @@ def __init__( **kwargs, ): """ + A dependency found in the repository, including its identity, location, and reachability metadata. - - :param exclusions: + :param exclusions: A list of patterns or identifiers that should be excluded from analysis for this dependency. :type exclusions: [str], optional - :param group: + :param group: The group or organization namespace of the dependency (e.g., Maven group ID). :type group: str, optional - :param is_dev: + :param is_dev: Indicates whether this is a development-only dependency not used in production. :type is_dev: bool, optional - :param is_direct: + :param is_direct: Indicates whether this is a direct dependency (as opposed to a transitive one). :type is_direct: bool, optional - :param language: + :param language: The programming language ecosystem of this dependency (e.g., java, python, javascript). :type language: str, optional - :param locations: + :param locations: The list of source file locations where this dependency is declared. :type locations: [ScaRequestDataAttributesDependenciesItemsLocationsItems], optional - :param name: + :param name: The name of the dependency package. :type name: str, optional - :param package_manager: + :param package_manager: The package manager responsible for this dependency (e.g., maven, pip, npm). :type package_manager: str, optional - :param purl: + :param purl: The Package URL (PURL) uniquely identifying this dependency. :type purl: str, optional - :param reachable_symbol_properties: + :param reachable_symbol_properties: Properties describing symbols from this dependency that are reachable in the application code. :type reachable_symbol_properties: [ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems], optional - :param version: + :param version: The version of the dependency. :type version: str, optional """ if exclusions is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items.py index 3fc0862dde..70a7d4d568 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items.py @@ -49,18 +49,18 @@ def __init__( **kwargs, ): """ + The source code location where a dependency is declared, including block, name, namespace, and version positions within the file. - - :param block: + :param block: A range within a file defined by a start and end position, along with the file name. :type block: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional - :param name: + :param name: A range within a file defined by a start and end position, along with the file name. :type name: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional - :param namespace: + :param namespace: A range within a file defined by a start and end position, along with the file name. :type namespace: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional - :param version: + :param version: A range within a file defined by a start and end position, along with the file name. :type version: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional """ if block is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_file_position.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_file_position.py index f5a84a23b8..702d0569fb 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_file_position.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_file_position.py @@ -46,15 +46,15 @@ def __init__( **kwargs, ): """ + A range within a file defined by a start and end position, along with the file name. - - :param end: + :param end: A specific position (line and column) within a source file. :type end: ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition, optional - :param file_name: + :param file_name: The name or path of the file containing this location. :type file_name: str, optional - :param start: + :param start: A specific position (line and column) within a source file. :type start: ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition, optional """ if end is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_position.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_position.py index e06e281ca2..60fa91da6f 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_position.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_locations_items_position.py @@ -37,12 +37,12 @@ def openapi_types(_): def __init__(self_, col: Union[int, UnsetType] = unset, line: Union[int, UnsetType] = unset, **kwargs): """ + A specific position (line and column) within a source file. - - :param col: + :param col: The column number of the position within the line. :type col: int, optional - :param line: + :param line: The line number of the position within the file. :type line: int, optional """ if col is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_reachable_symbol_properties_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_reachable_symbol_properties_items.py index c39f8a97cd..b3e01a8c98 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_reachable_symbol_properties_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_dependencies_items_reachable_symbol_properties_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, name: Union[str, UnsetType] = unset, value: Union[str, UnsetType] = unset, **kwargs): """ + A key-value property describing a reachable symbol within a dependency. - - :param name: + :param name: The name of the reachable symbol property. :type name: str, optional - :param value: + :param value: The value of the reachable symbol property. :type value: str, optional """ if name is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_files_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_files_items.py index fe29f4c352..1a25af08b0 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_files_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_files_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, name: Union[str, UnsetType] = unset, purl: Union[str, UnsetType] = unset, **kwargs): """ + A file entry in the repository associated with a dependency manifest. - - :param name: + :param name: The name or path of the file within the repository. :type name: str, optional - :param purl: + :param purl: The Package URL (PURL) associated with the dependency declared in this file. :type purl: str, optional """ if name is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_relations_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_relations_items.py index b4a43a244e..7c82f9d524 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_relations_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_relations_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, depends_on: Union[List[str], UnsetType] = unset, ref: Union[str, UnsetType] = unset, **kwargs): """ + A dependency relation describing which other components a given component depends on. - - :param depends_on: + :param depends_on: The list of BOM references that this component directly depends on. :type depends_on: [str], optional - :param ref: + :param ref: The BOM reference of the component that has dependencies. :type ref: str, optional """ if depends_on is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_repository.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_repository.py index 6d5f20118c..3d3f7c8318 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_repository.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_repository.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, url: Union[str, UnsetType] = unset, **kwargs): """ + Information about the source code repository being analyzed. - - :param url: + :param url: The URL of the repository. :type url: str, optional """ if url is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items.py index 6f4143a22a..3e06a6ea99 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items.py @@ -46,15 +46,15 @@ def __init__( **kwargs, ): """ + A vulnerability entry from the Software Bill of Materials (SBOM), describing a known security issue and the components it affects. - - :param affects: + :param affects: The list of components affected by this vulnerability. :type affects: [ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems], optional - :param bom_ref: + :param bom_ref: The unique BOM reference identifier for this vulnerability entry. :type bom_ref: str, optional - :param id: + :param id: The vulnerability identifier (e.g., CVE ID or similar). :type id: str, optional """ if affects is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items_affects_items.py b/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items_affects_items.py index 80d581c6a2..64f9aba08f 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items_affects_items.py +++ b/src/datadog_api_client/v2/model/sca_request_data_attributes_vulnerabilities_items_affects_items.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, ref: Union[str, UnsetType] = unset, **kwargs): """ + A reference to a component affected by a vulnerability. - - :param ref: + :param ref: The BOM reference identifying the affected component. :type ref: str, optional """ if ref is not unset: diff --git a/src/datadog_api_client/v2/model/sca_request_data_type.py b/src/datadog_api_client/v2/model/sca_request_data_type.py index 9ba1a58738..1049444b48 100644 --- a/src/datadog_api_client/v2/model/sca_request_data_type.py +++ b/src/datadog_api_client/v2/model/sca_request_data_type.py @@ -14,7 +14,7 @@ class ScaRequestDataType(ModelSimple): """ - + The type identifier for SCA dependency analysis requests. :param value: If omitted defaults to "scarequests". Must be one of ["scarequests"]. :type value: str diff --git a/src/datadog_api_client/v2/model/seat_user_data.py b/src/datadog_api_client/v2/model/seat_user_data.py index 9f6e212a49..aa4e3fb54e 100644 --- a/src/datadog_api_client/v2/model/seat_user_data.py +++ b/src/datadog_api_client/v2/model/seat_user_data.py @@ -45,9 +45,9 @@ def __init__( **kwargs, ): """ + A seat user resource object containing its ID, type, and associated attributes. - - :param attributes: + :param attributes: Attributes of a user assigned to a seat, including their email, name, and assignment timestamp. :type attributes: SeatUserDataAttributes, optional :param id: The ID of the seat user. diff --git a/src/datadog_api_client/v2/model/seat_user_data_array.py b/src/datadog_api_client/v2/model/seat_user_data_array.py index df70ada1a9..e16491773c 100644 --- a/src/datadog_api_client/v2/model/seat_user_data_array.py +++ b/src/datadog_api_client/v2/model/seat_user_data_array.py @@ -41,12 +41,12 @@ def __init__( **kwargs, ): """ - + A paginated list of seat user resources with associated pagination metadata. :param data: The list of seat users. :type data: [SeatUserData], optional - :param meta: + :param meta: Pagination metadata for the seat users list response. :type meta: SeatUserMeta, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/seat_user_data_attributes.py b/src/datadog_api_client/v2/model/seat_user_data_attributes.py index 9579966092..5fae63a163 100644 --- a/src/datadog_api_client/v2/model/seat_user_data_attributes.py +++ b/src/datadog_api_client/v2/model/seat_user_data_attributes.py @@ -38,7 +38,7 @@ def __init__( **kwargs, ): """ - + Attributes of a user assigned to a seat, including their email, name, and assignment timestamp. :param assigned_at: The date and time the seat was assigned. :type assigned_at: datetime, none_type, optional diff --git a/src/datadog_api_client/v2/model/seat_user_meta.py b/src/datadog_api_client/v2/model/seat_user_meta.py index 6549784f28..c769e08ce4 100644 --- a/src/datadog_api_client/v2/model/seat_user_meta.py +++ b/src/datadog_api_client/v2/model/seat_user_meta.py @@ -36,7 +36,7 @@ def __init__( **kwargs, ): """ - + Pagination metadata for the seat users list response. :param cursor: The cursor for the seat users. :type cursor: str, optional diff --git a/src/datadog_api_client/v2/model/secret_rule_array.py b/src/datadog_api_client/v2/model/secret_rule_array.py index cff8f64616..d86b434209 100644 --- a/src/datadog_api_client/v2/model/secret_rule_array.py +++ b/src/datadog_api_client/v2/model/secret_rule_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[SecretRuleData], **kwargs): """ + A collection of secret detection rules returned by the list endpoint. - - :param data: + :param data: The list of secret detection rules. :type data: [SecretRuleData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/secret_rule_data.py b/src/datadog_api_client/v2/model/secret_rule_data.py index c9f3fc27c6..f151d7640a 100644 --- a/src/datadog_api_client/v2/model/secret_rule_data.py +++ b/src/datadog_api_client/v2/model/secret_rule_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object representing a secret detection rule, including its attributes and resource type. - - :param attributes: + :param attributes: The attributes of a secret detection rule, including its pattern, priority, and validation configuration. :type attributes: SecretRuleDataAttributes, optional - :param id: + :param id: The unique identifier of the secret rule resource. :type id: str, optional :param type: Secret rule resource type. diff --git a/src/datadog_api_client/v2/model/secret_rule_data_attributes.py b/src/datadog_api_client/v2/model/secret_rule_data_attributes.py index 661ffd472c..e9f96fe465 100644 --- a/src/datadog_api_client/v2/model/secret_rule_data_attributes.py +++ b/src/datadog_api_client/v2/model/secret_rule_data_attributes.py @@ -64,33 +64,33 @@ def __init__( **kwargs, ): """ + The attributes of a secret detection rule, including its pattern, priority, and validation configuration. - - :param default_included_keywords: + :param default_included_keywords: A list of keywords that are included by default when scanning for secrets matching this rule. :type default_included_keywords: [str], optional - :param description: + :param description: A detailed explanation of what type of secret this rule detects. :type description: str, optional - :param license: + :param license: The license under which this secret rule is distributed. :type license: str, optional - :param match_validation: + :param match_validation: Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response. :type match_validation: SecretRuleDataAttributesMatchValidation, optional - :param name: + :param name: The unique name of the secret detection rule. :type name: str, optional - :param pattern: + :param pattern: The regular expression pattern used to identify potential secrets in source code or configuration. :type pattern: str, optional - :param priority: + :param priority: The priority level of this rule, used to rank findings when multiple rules match. :type priority: str, optional - :param sds_id: + :param sds_id: The identifier of the corresponding Sensitive Data Scanner rule, if one exists. :type sds_id: str, optional - :param validators: + :param validators: A list of validator identifiers used to further confirm a detected secret is genuine. :type validators: [str], optional """ if default_included_keywords is not unset: diff --git a/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation.py b/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation.py index ddadcd974a..0d4dfbb92c 100644 --- a/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation.py +++ b/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation.py @@ -78,30 +78,30 @@ def __init__( **kwargs, ): """ + Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response. - - :param endpoint: + :param endpoint: The URL endpoint to call when validating a detected secret. :type endpoint: str, optional - :param hosts: + :param hosts: The list of hostnames to include when performing secret match validation. :type hosts: [str], optional - :param http_method: + :param http_method: The HTTP method (e.g., GET, POST) to use when making the validation request. :type http_method: str, optional - :param invalid_http_status_code: + :param invalid_http_status_code: The HTTP status code ranges that indicate the detected secret is invalid or inactive. :type invalid_http_status_code: [SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems], optional - :param request_headers: + :param request_headers: A map of HTTP header names to values to include in the validation request. :type request_headers: {str: (str,)}, optional - :param timeout_seconds: + :param timeout_seconds: The maximum number of seconds to wait for a response during validation before timing out. :type timeout_seconds: int, optional - :param type: + :param type: The type of match validation to perform (e.g., http). :type type: str, optional - :param valid_http_status_code: + :param valid_http_status_code: The HTTP status code ranges that indicate the detected secret is valid and active. :type valid_http_status_code: [SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems], optional """ if endpoint is not unset: diff --git a/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_invalid_http_status_code_items.py b/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_invalid_http_status_code_items.py index ef8579db0a..f57cf8a00f 100644 --- a/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_invalid_http_status_code_items.py +++ b/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_invalid_http_status_code_items.py @@ -39,12 +39,12 @@ def openapi_types(_): def __init__(self_, end: Union[int, UnsetType] = unset, start: Union[int, UnsetType] = unset, **kwargs): """ + An HTTP status code range that indicates an invalid (unsuccessful) secret match during validation. - - :param end: + :param end: The inclusive upper bound of the HTTP status code range. :type end: int, optional - :param start: + :param start: The inclusive lower bound of the HTTP status code range. :type start: int, optional """ if end is not unset: diff --git a/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_valid_http_status_code_items.py b/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_valid_http_status_code_items.py index 4fa6ded114..ffa510ec36 100644 --- a/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_valid_http_status_code_items.py +++ b/src/datadog_api_client/v2/model/secret_rule_data_attributes_match_validation_valid_http_status_code_items.py @@ -39,12 +39,12 @@ def openapi_types(_): def __init__(self_, end: Union[int, UnsetType] = unset, start: Union[int, UnsetType] = unset, **kwargs): """ + An HTTP status code range that indicates a valid (successful) secret match during validation. - - :param end: + :param end: The inclusive upper bound of the HTTP status code range. :type end: int, optional - :param start: + :param start: The inclusive lower bound of the HTTP status code range. :type start: int, optional """ if end is not unset: diff --git a/src/datadog_api_client/v2/model/security_entity_risk_scores_response.py b/src/datadog_api_client/v2/model/security_entity_risk_scores_response.py index 8dca227622..8650a6dc96 100644 --- a/src/datadog_api_client/v2/model/security_entity_risk_scores_response.py +++ b/src/datadog_api_client/v2/model/security_entity_risk_scores_response.py @@ -36,7 +36,7 @@ def __init__(self_, data: List[SecurityEntityRiskScore], meta: SecurityEntityRis """ Response containing a list of entity risk scores - :param data: + :param data: Array of entity risk score objects. :type data: [SecurityEntityRiskScore] :param meta: Metadata for pagination diff --git a/src/datadog_api_client/v2/model/service_list.py b/src/datadog_api_client/v2/model/service_list.py index ad4860f847..dbc8b9337c 100644 --- a/src/datadog_api_client/v2/model/service_list.py +++ b/src/datadog_api_client/v2/model/service_list.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[ServiceListData, UnsetType] = unset, **kwargs): """ + The response body for the service list endpoint. - - :param data: + :param data: A single data item in the service list response. :type data: ServiceListData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/service_list_data.py b/src/datadog_api_client/v2/model/service_list_data.py index 666990211f..6becfd537e 100644 --- a/src/datadog_api_client/v2/model/service_list_data.py +++ b/src/datadog_api_client/v2/model/service_list_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + A single data item in the service list response. - - :param attributes: + :param attributes: Attributes of a service list entry, containing metadata and a list of service names. :type attributes: ServiceListDataAttributes, optional - :param id: + :param id: The unique identifier of the service. :type id: str, optional :param type: Services list resource type. diff --git a/src/datadog_api_client/v2/model/service_list_data_attributes.py b/src/datadog_api_client/v2/model/service_list_data_attributes.py index 5599d6065e..565e2f3000 100644 --- a/src/datadog_api_client/v2/model/service_list_data_attributes.py +++ b/src/datadog_api_client/v2/model/service_list_data_attributes.py @@ -43,12 +43,12 @@ def __init__( **kwargs, ): """ + Attributes of a service list entry, containing metadata and a list of service names. - - :param metadata: + :param metadata: A list of metadata items associated with the service. :type metadata: [ServiceListDataAttributesMetadataItems], optional - :param services: + :param services: A list of service names. :type services: [str], optional """ if metadata is not unset: diff --git a/src/datadog_api_client/v2/model/service_list_data_attributes_metadata_items.py b/src/datadog_api_client/v2/model/service_list_data_attributes_metadata_items.py index 451a56d11a..ca63bd7fbe 100644 --- a/src/datadog_api_client/v2/model/service_list_data_attributes_metadata_items.py +++ b/src/datadog_api_client/v2/model/service_list_data_attributes_metadata_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, is_traced: Union[bool, UnsetType] = unset, is_usm: Union[bool, UnsetType] = unset, **kwargs): """ + An object containing metadata flags for a service, indicating whether it is traced by APM or monitored through Universal Service Monitoring. - - :param is_traced: + :param is_traced: Indicates whether the service is traced by APM. :type is_traced: bool, optional - :param is_usm: + :param is_usm: Indicates whether the service uses Universal Service Monitoring. :type is_usm: bool, optional """ if is_traced is not unset: diff --git a/src/datadog_api_client/v2/model/session_id_array.py b/src/datadog_api_client/v2/model/session_id_array.py index 950a587500..43a6ce9889 100644 --- a/src/datadog_api_client/v2/model/session_id_array.py +++ b/src/datadog_api_client/v2/model/session_id_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[SessionIdData], **kwargs): """ + A collection of session identifiers used for bulk add or remove operations on a playlist. - - :param data: + :param data: Array of session identifier data objects. :type data: [SessionIdData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/session_id_data.py b/src/datadog_api_client/v2/model/session_id_data.py index 8d88b34f6c..1272c1df1b 100644 --- a/src/datadog_api_client/v2/model/session_id_data.py +++ b/src/datadog_api_client/v2/model/session_id_data.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, type: ViewershipHistorySessionDataType, id: Union[str, UnsetType] = unset, **kwargs): """ + A session identifier data object used for bulk playlist operations. - - :param id: + :param id: Unique identifier of the RUM replay session. :type id: str, optional :param type: Rum replay session resource type. diff --git a/src/datadog_api_client/v2/model/snapshot.py b/src/datadog_api_client/v2/model/snapshot.py index 3c3555f800..1851cf066e 100644 --- a/src/datadog_api_client/v2/model/snapshot.py +++ b/src/datadog_api_client/v2/model/snapshot.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[SnapshotData, UnsetType] = unset, **kwargs): """ + A single heatmap snapshot resource returned by create or update operations. - - :param data: + :param data: Data object representing a heatmap snapshot, including its identifier, type, and attributes. :type data: SnapshotData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/snapshot_array.py b/src/datadog_api_client/v2/model/snapshot_array.py index d00163646f..d2dce4ee05 100644 --- a/src/datadog_api_client/v2/model/snapshot_array.py +++ b/src/datadog_api_client/v2/model/snapshot_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[SnapshotData], **kwargs): """ + A list of heatmap snapshots returned by a list operation. - - :param data: + :param data: Array of heatmap snapshot data objects. :type data: [SnapshotData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/snapshot_create_request.py b/src/datadog_api_client/v2/model/snapshot_create_request.py index 39b05b451e..b1ae9261c1 100644 --- a/src/datadog_api_client/v2/model/snapshot_create_request.py +++ b/src/datadog_api_client/v2/model/snapshot_create_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: SnapshotCreateRequestData, **kwargs): """ + Request body for creating a heatmap snapshot. - - :param data: + :param data: Data object for a heatmap snapshot creation request, containing the resource type and attributes. :type data: SnapshotCreateRequestData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/snapshot_create_request_data.py b/src/datadog_api_client/v2/model/snapshot_create_request_data.py index 5e6f28791d..4b29e298dd 100644 --- a/src/datadog_api_client/v2/model/snapshot_create_request_data.py +++ b/src/datadog_api_client/v2/model/snapshot_create_request_data.py @@ -43,9 +43,9 @@ def __init__( **kwargs, ): """ + Data object for a heatmap snapshot creation request, containing the resource type and attributes. - - :param attributes: + :param attributes: Attributes for creating a heatmap snapshot, including the view, session, event, and device context. :type attributes: SnapshotCreateRequestDataAttributes, optional :param type: Snapshots resource type. diff --git a/src/datadog_api_client/v2/model/snapshot_create_request_data_attributes.py b/src/datadog_api_client/v2/model/snapshot_create_request_data_attributes.py index 43377f8870..c673f80557 100644 --- a/src/datadog_api_client/v2/model/snapshot_create_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/snapshot_create_request_data_attributes.py @@ -54,33 +54,33 @@ def __init__( **kwargs, ): """ + Attributes for creating a heatmap snapshot, including the view, session, event, and device context. - - :param application_id: + :param application_id: Unique identifier of the RUM application. :type application_id: str - :param device_type: + :param device_type: Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). :type device_type: str - :param event_id: + :param event_id: Unique identifier of the RUM event associated with the snapshot. :type event_id: str - :param is_device_type_selected_by_user: + :param is_device_type_selected_by_user: Indicates whether the device type was explicitly selected by the user rather than auto-detected. :type is_device_type_selected_by_user: bool - :param session_id: + :param session_id: Unique identifier of the RUM session associated with the snapshot. :type session_id: str, optional - :param snapshot_name: + :param snapshot_name: Human-readable name for the snapshot. :type snapshot_name: str - :param start: + :param start: Offset in milliseconds from the start of the session at which the snapshot was captured. :type start: int - :param view_id: + :param view_id: Unique identifier of the RUM view associated with the snapshot. :type view_id: str, optional - :param view_name: + :param view_name: URL path or name of the view where the snapshot was captured. :type view_name: str """ if session_id is not unset: diff --git a/src/datadog_api_client/v2/model/snapshot_data.py b/src/datadog_api_client/v2/model/snapshot_data.py index 5b79976997..a2b51263c6 100644 --- a/src/datadog_api_client/v2/model/snapshot_data.py +++ b/src/datadog_api_client/v2/model/snapshot_data.py @@ -47,12 +47,12 @@ def __init__( **kwargs, ): """ + Data object representing a heatmap snapshot, including its identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes of a heatmap snapshot, including view context, device information, and audit metadata. :type attributes: SnapshotDataAttributes, optional - :param id: + :param id: Unique identifier of the heatmap snapshot. :type id: str, optional :param type: Snapshots resource type. diff --git a/src/datadog_api_client/v2/model/snapshot_data_attributes.py b/src/datadog_api_client/v2/model/snapshot_data_attributes.py index 8fb1e88ea1..1823b5f458 100644 --- a/src/datadog_api_client/v2/model/snapshot_data_attributes.py +++ b/src/datadog_api_client/v2/model/snapshot_data_attributes.py @@ -81,51 +81,51 @@ def __init__( **kwargs, ): """ + Attributes of a heatmap snapshot, including view context, device information, and audit metadata. - - :param application_id: + :param application_id: Unique identifier of the RUM application. :type application_id: str, optional - :param created_at: + :param created_at: Timestamp when the snapshot was created. :type created_at: datetime, optional - :param created_by: + :param created_by: Display name of the user who created the snapshot. :type created_by: str, optional - :param created_by_handle: + :param created_by_handle: Email handle of the user who created the snapshot. :type created_by_handle: str, optional - :param created_by_user_id: + :param created_by_user_id: Numeric identifier of the user who created the snapshot. :type created_by_user_id: int, optional - :param device_type: + :param device_type: Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). :type device_type: str, optional - :param event_id: + :param event_id: Unique identifier of the RUM event associated with the snapshot. :type event_id: str, optional - :param is_device_type_selected_by_user: + :param is_device_type_selected_by_user: Indicates whether the device type was explicitly selected by the user rather than auto-detected. :type is_device_type_selected_by_user: bool, optional - :param modified_at: + :param modified_at: Timestamp when the snapshot was last modified. :type modified_at: datetime, optional - :param org_id: + :param org_id: Numeric identifier of the organization that owns the snapshot. :type org_id: int, optional - :param session_id: + :param session_id: Unique identifier of the RUM session associated with the snapshot. :type session_id: str, optional - :param snapshot_name: + :param snapshot_name: Human-readable name for the snapshot. :type snapshot_name: str, optional - :param start: + :param start: Offset in milliseconds from the start of the session at which the snapshot was captured. :type start: int, optional - :param view_id: + :param view_id: Unique identifier of the RUM view associated with the snapshot. :type view_id: str, optional - :param view_name: + :param view_name: URL path or name of the view where the snapshot was captured. :type view_name: str, optional """ if application_id is not unset: diff --git a/src/datadog_api_client/v2/model/snapshot_update_request.py b/src/datadog_api_client/v2/model/snapshot_update_request.py index 0f40bb449c..ada54826e0 100644 --- a/src/datadog_api_client/v2/model/snapshot_update_request.py +++ b/src/datadog_api_client/v2/model/snapshot_update_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: SnapshotUpdateRequestData, **kwargs): """ + Request body for updating a heatmap snapshot. - - :param data: + :param data: Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. :type data: SnapshotUpdateRequestData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/snapshot_update_request_data.py b/src/datadog_api_client/v2/model/snapshot_update_request_data.py index 3376a618c5..02a4ea8c45 100644 --- a/src/datadog_api_client/v2/model/snapshot_update_request_data.py +++ b/src/datadog_api_client/v2/model/snapshot_update_request_data.py @@ -46,12 +46,12 @@ def __init__( **kwargs, ): """ + Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes for updating a heatmap snapshot, including event, session, and view context. :type attributes: SnapshotUpdateRequestDataAttributes, optional - :param id: + :param id: Unique identifier of the heatmap snapshot to update. :type id: str, optional :param type: Snapshots resource type. diff --git a/src/datadog_api_client/v2/model/snapshot_update_request_data_attributes.py b/src/datadog_api_client/v2/model/snapshot_update_request_data_attributes.py index 61cab43f65..dc1e13de64 100644 --- a/src/datadog_api_client/v2/model/snapshot_update_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/snapshot_update_request_data_attributes.py @@ -42,21 +42,21 @@ def __init__( **kwargs, ): """ + Attributes for updating a heatmap snapshot, including event, session, and view context. - - :param event_id: + :param event_id: Unique identifier of the RUM event associated with the snapshot. :type event_id: str - :param is_device_type_selected_by_user: + :param is_device_type_selected_by_user: Indicates whether the device type was explicitly selected by the user rather than auto-detected. :type is_device_type_selected_by_user: bool - :param session_id: + :param session_id: Unique identifier of the RUM session associated with the snapshot. :type session_id: str, optional - :param start: + :param start: Offset in milliseconds from the start of the session at which the snapshot was captured. :type start: int - :param view_id: + :param view_id: Unique identifier of the RUM view associated with the snapshot. :type view_id: str, optional """ if session_id is not unset: diff --git a/src/datadog_api_client/v2/model/status_page.py b/src/datadog_api_client/v2/model/status_page.py index d733a6c702..468ace20e2 100644 --- a/src/datadog_api_client/v2/model/status_page.py +++ b/src/datadog_api_client/v2/model/status_page.py @@ -42,9 +42,9 @@ def __init__( **kwargs, ): """ + Response object for a single status page. - - :param data: + :param data: The data object for a status page. :type data: StatusPageData, optional :param included: The included related resources of a status page. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/status_page_array.py b/src/datadog_api_client/v2/model/status_page_array.py index 460eda5303..b53f3bb09f 100644 --- a/src/datadog_api_client/v2/model/status_page_array.py +++ b/src/datadog_api_client/v2/model/status_page_array.py @@ -50,9 +50,9 @@ def __init__( **kwargs, ): """ + Response object for a list of status pages. - - :param data: + :param data: A list of status page data objects. :type data: [StatusPageData] :param included: The included related resources of a status page. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/status_page_array_included.py b/src/datadog_api_client/v2/model/status_page_array_included.py index 39bab85b81..57c9af2eea 100644 --- a/src/datadog_api_client/v2/model/status_page_array_included.py +++ b/src/datadog_api_client/v2/model/status_page_array_included.py @@ -13,7 +13,7 @@ class StatusPageArrayIncluded(ModelComposed): def __init__(self, **kwargs): """ - + An included resource related to a status page. :param attributes: Attributes of the Datadog user. :type attributes: StatusPagesUserAttributes, optional diff --git a/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items.py b/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items.py index ad24465cf4..4c90a162f7 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items.py @@ -72,9 +72,9 @@ def __init__( **kwargs, ): """ + A component displayed on an included status page. - - :param components: + :param components: If the component is of type ``group`` , the components within the group. :type components: [StatusPageAsIncludedAttributesComponentsItemsComponentsItems], optional :param id: The ID of the component. diff --git a/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items_components_items.py b/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items_components_items.py index 0b19a140a8..a91cb77da9 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items_components_items.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_attributes_components_items_components_items.py @@ -63,7 +63,7 @@ def __init__( **kwargs, ): """ - + A grouped component within a status page component group. :param id: The ID of the grouped component. :type id: UUID, optional diff --git a/src/datadog_api_client/v2/model/status_page_as_included_relationships.py b/src/datadog_api_client/v2/model/status_page_as_included_relationships.py index 2ac92a2051..d4f6576ba1 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_relationships.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_relationships.py @@ -51,10 +51,10 @@ def __init__( """ The relationships of a status page. - :param created_by_user: + :param created_by_user: The Datadog user who created the status page. :type created_by_user: StatusPageAsIncludedRelationshipsCreatedByUser, optional - :param last_modified_by_user: + :param last_modified_by_user: The Datadog user who last modified the status page. :type last_modified_by_user: StatusPageAsIncludedRelationshipsLastModifiedByUser, optional """ if created_by_user is not unset: diff --git a/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user.py b/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user.py index e81695e2f7..8b63c75dbd 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPageAsIncludedRelationshipsCreatedByUserData, **kwargs): """ + The Datadog user who created the status page. - - :param data: + :param data: The data object identifying the Datadog user who created the status page. :type data: StatusPageAsIncludedRelationshipsCreatedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user_data.py b/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user_data.py index 38c5f4cf7f..abb9720fa4 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_relationships_created_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who created the status page. :param id: The ID of the Datadog user who created the status page. :type id: str diff --git a/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user.py b/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user.py index 7ab0393f5b..aaaaebb410 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPageAsIncludedRelationshipsLastModifiedByUserData, **kwargs): """ + The Datadog user who last modified the status page. - - :param data: + :param data: The data object identifying the Datadog user who last modified the status page. :type data: StatusPageAsIncludedRelationshipsLastModifiedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user_data.py b/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user_data.py index a2b15a7f37..8fb2f5768c 100644 --- a/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_page_as_included_relationships_last_modified_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who last modified the status page. :param id: The ID of the Datadog user who last modified the status page. :type id: str diff --git a/src/datadog_api_client/v2/model/status_page_data.py b/src/datadog_api_client/v2/model/status_page_data.py index 95c63c04c3..0708d8633f 100644 --- a/src/datadog_api_client/v2/model/status_page_data.py +++ b/src/datadog_api_client/v2/model/status_page_data.py @@ -50,7 +50,7 @@ def __init__( **kwargs, ): """ - + The data object for a status page. :param attributes: The attributes of a status page. :type attributes: StatusPageDataAttributes, optional diff --git a/src/datadog_api_client/v2/model/status_page_data_attributes_components_items.py b/src/datadog_api_client/v2/model/status_page_data_attributes_components_items.py index 60d8c9c8d4..360faec1df 100644 --- a/src/datadog_api_client/v2/model/status_page_data_attributes_components_items.py +++ b/src/datadog_api_client/v2/model/status_page_data_attributes_components_items.py @@ -71,7 +71,7 @@ def __init__( **kwargs, ): """ - + A component displayed on a status page. :param components: If the component is of type ``group`` , the components within the group. :type components: [StatusPageDataAttributesComponentsItemsComponentsItems], optional diff --git a/src/datadog_api_client/v2/model/status_page_data_attributes_components_items_components_items.py b/src/datadog_api_client/v2/model/status_page_data_attributes_components_items_components_items.py index babb9aca16..8596ce4d57 100644 --- a/src/datadog_api_client/v2/model/status_page_data_attributes_components_items_components_items.py +++ b/src/datadog_api_client/v2/model/status_page_data_attributes_components_items_components_items.py @@ -62,7 +62,7 @@ def __init__( **kwargs, ): """ - + A grouped component within a status page component group. :param id: The ID of the component. :type id: UUID, optional diff --git a/src/datadog_api_client/v2/model/status_page_data_relationships.py b/src/datadog_api_client/v2/model/status_page_data_relationships.py index 20d7005a1d..3babbe5c56 100644 --- a/src/datadog_api_client/v2/model/status_page_data_relationships.py +++ b/src/datadog_api_client/v2/model/status_page_data_relationships.py @@ -51,10 +51,10 @@ def __init__( """ The relationships of a status page. - :param created_by_user: + :param created_by_user: The Datadog user who created the status page. :type created_by_user: StatusPageDataRelationshipsCreatedByUser, optional - :param last_modified_by_user: + :param last_modified_by_user: The Datadog user who last modified the status page. :type last_modified_by_user: StatusPageDataRelationshipsLastModifiedByUser, optional """ if created_by_user is not unset: diff --git a/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user.py b/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user.py index 8a6f05949a..f3c86ca7a4 100644 --- a/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user.py +++ b/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPageDataRelationshipsCreatedByUserData, **kwargs): """ + The Datadog user who created the status page. - - :param data: + :param data: The data object identifying the Datadog user who created the status page. :type data: StatusPageDataRelationshipsCreatedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user_data.py b/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user_data.py index 7b0780b2bb..ec74e58374 100644 --- a/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_page_data_relationships_created_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who created the status page. :param id: The ID of the Datadog user who created the status page. :type id: str diff --git a/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user.py b/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user.py index 772fc05e56..d84938197f 100644 --- a/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user.py +++ b/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPageDataRelationshipsLastModifiedByUserData, **kwargs): """ + The Datadog user who last modified the status page. - - :param data: + :param data: The data object identifying the Datadog user who last modified the status page. :type data: StatusPageDataRelationshipsLastModifiedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user_data.py b/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user_data.py index 41b4c92132..1a54baf80e 100644 --- a/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_page_data_relationships_last_modified_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who last modified the status page. :param id: The ID of the Datadog user who last modified the status page. :type id: str diff --git a/src/datadog_api_client/v2/model/status_pages_component.py b/src/datadog_api_client/v2/model/status_pages_component.py index 9ca95ae1df..f7199f1cfb 100644 --- a/src/datadog_api_client/v2/model/status_pages_component.py +++ b/src/datadog_api_client/v2/model/status_pages_component.py @@ -51,9 +51,9 @@ def __init__( **kwargs, ): """ + Response object for a single component. - - :param data: + :param data: The data object for a component. :type data: StatusPagesComponentData, optional :param included: The included related resources of a component. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/status_pages_component_array.py b/src/datadog_api_client/v2/model/status_pages_component_array.py index d67fc80a73..7262e03fcb 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_array.py +++ b/src/datadog_api_client/v2/model/status_pages_component_array.py @@ -51,9 +51,9 @@ def __init__( **kwargs, ): """ + Response object for a list of components. - - :param data: + :param data: A list of component data objects. :type data: [StatusPagesComponentData] :param included: The included related resources of a component. Client must explicitly request these resources by name in the ``include`` query parameter. diff --git a/src/datadog_api_client/v2/model/status_pages_component_array_included.py b/src/datadog_api_client/v2/model/status_pages_component_array_included.py index 4434983317..7c43ca81ea 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_array_included.py +++ b/src/datadog_api_client/v2/model/status_pages_component_array_included.py @@ -13,7 +13,7 @@ class StatusPagesComponentArrayIncluded(ModelComposed): def __init__(self, **kwargs): """ - + An included resource related to a component. :param attributes: Attributes of the Datadog user. :type attributes: StatusPagesUserAttributes, optional diff --git a/src/datadog_api_client/v2/model/status_pages_component_data.py b/src/datadog_api_client/v2/model/status_pages_component_data.py index a2d7c14666..d38b6455bf 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data.py @@ -56,7 +56,7 @@ def __init__( **kwargs, ): """ - + The data object for a component. :param attributes: The attributes of a component. :type attributes: StatusPagesComponentDataAttributes, optional diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_attributes_components_items.py b/src/datadog_api_client/v2/model/status_pages_component_data_attributes_components_items.py index bbdcf86630..3344baaf51 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_attributes_components_items.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_attributes_components_items.py @@ -63,15 +63,15 @@ def __init__( **kwargs, ): """ + A component within a component group. - - :param id: + :param id: The ID of the component within the group. :type id: UUID, optional - :param name: + :param name: The name of the component within the group. :type name: str, optional - :param position: + :param position: The zero-indexed position of the component within the group. :type position: int, optional :param status: The status of the component. diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships.py index 1516a763e2..43de7fc6f3 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships.py @@ -69,16 +69,16 @@ def __init__( """ The relationships of a component. - :param created_by_user: + :param created_by_user: The Datadog user who created the component. :type created_by_user: StatusPagesComponentDataRelationshipsCreatedByUser, optional - :param group: + :param group: The group the component belongs to. :type group: StatusPagesComponentDataRelationshipsGroup, optional - :param last_modified_by_user: + :param last_modified_by_user: The Datadog user who last modified the component. :type last_modified_by_user: StatusPagesComponentDataRelationshipsLastModifiedByUser, optional - :param status_page: + :param status_page: The status page the component belongs to. :type status_page: StatusPagesComponentDataRelationshipsStatusPage, optional """ if created_by_user is not unset: diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user.py index 54336470b8..97f69e2bb5 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPagesComponentDataRelationshipsCreatedByUserData, **kwargs): """ + The Datadog user who created the component. - - :param data: + :param data: The data object identifying the Datadog user who created the component. :type data: StatusPagesComponentDataRelationshipsCreatedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user_data.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user_data.py index ed30582049..9904a9e9cb 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_created_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who created the component. :param id: The ID of the Datadog user who created the component. :type id: str diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group.py index ee11ed5b0d..ea5d7f9a97 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group.py @@ -35,9 +35,9 @@ def openapi_types(_): def __init__(self_, data: Union[StatusPagesComponentDataRelationshipsGroupData, none_type], **kwargs): """ + The group the component belongs to. - - :param data: + :param data: The data object identifying the group the component belongs to. :type data: StatusPagesComponentDataRelationshipsGroupData, none_type """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group_data.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group_data.py index 6de8856963..91fc0cfd76 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_group_data.py @@ -35,7 +35,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPagesComponentGroupType, **kwargs): """ - + The data object identifying the group the component belongs to. :param id: The ID of the group the component belongs to. :type id: UUID diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user.py index b078b38bc2..99c4d5b996 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPagesComponentDataRelationshipsLastModifiedByUserData, **kwargs): """ + The Datadog user who last modified the component. - - :param data: + :param data: The data object identifying the Datadog user who last modified the component. :type data: StatusPagesComponentDataRelationshipsLastModifiedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user_data.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user_data.py index 149590c23c..14c02ae64e 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_last_modified_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who last modified the component. :param id: The ID of the Datadog user who last modified the component. :type id: str diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page.py index ad06b7f1b7..2b34b2eda6 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page.py @@ -34,9 +34,9 @@ def openapi_types(_): def __init__(self_, data: StatusPagesComponentDataRelationshipsStatusPageData, **kwargs): """ + The status page the component belongs to. - - :param data: + :param data: The data object identifying the status page the component belongs to. :type data: StatusPagesComponentDataRelationshipsStatusPageData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page_data.py b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page_data.py index e2e9ca3005..1b32d7de9b 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_data_relationships_status_page_data.py @@ -33,7 +33,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPageDataType, **kwargs): """ - + The data object identifying the status page the component belongs to. :param id: The ID of the status page the component belongs to. :type id: UUID diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_attributes_components_items.py b/src/datadog_api_client/v2/model/status_pages_component_group_attributes_components_items.py index de49dd5e84..3ab2b1c871 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_attributes_components_items.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_attributes_components_items.py @@ -63,7 +63,7 @@ def __init__( **kwargs, ): """ - + A component within a component group. :param id: The ID of the grouped component. :type id: UUID, optional diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user.py index 14655b5aae..39cad60765 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user.py @@ -36,7 +36,7 @@ def __init__(self_, data: StatusPagesComponentGroupRelationshipsCreatedByUserDat """ The Datadog user who created the component group. - :param data: + :param data: The data object identifying the Datadog user who created the component group. :type data: StatusPagesComponentGroupRelationshipsCreatedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user_data.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user_data.py index a68568653f..761ea9d19f 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_created_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who created the component group. :param id: The ID of the Datadog user who created the component group. :type id: str diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group.py index c4cffdc936..ce76575b8f 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group.py @@ -37,7 +37,7 @@ def __init__(self_, data: Union[StatusPagesComponentGroupRelationshipsGroupData, """ The group the component group belongs to. - :param data: + :param data: The data object identifying the parent group of a component group. :type data: StatusPagesComponentGroupRelationshipsGroupData, none_type """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group_data.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group_data.py index e1431e3131..d1d83aa4a3 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_group_data.py @@ -35,9 +35,9 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPagesComponentGroupType, **kwargs): """ + The data object identifying the parent group of a component group. - - :param id: + :param id: The ID of the parent group. :type id: UUID :param type: Components resource type. diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user.py index a5a61e945a..72a7407a20 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user.py @@ -36,7 +36,7 @@ def __init__(self_, data: StatusPagesComponentGroupRelationshipsLastModifiedByUs """ The Datadog user who last modified the component group. - :param data: + :param data: The data object identifying the Datadog user who last modified the component group. :type data: StatusPagesComponentGroupRelationshipsLastModifiedByUserData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user_data.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user_data.py index b3de0ab5ef..053db2b63b 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_last_modified_by_user_data.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, id: str, type: StatusPagesUserType, **kwargs): """ - + The data object identifying the Datadog user who last modified the component group. :param id: The ID of the Datadog user who last modified the component group. :type id: str diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page.py index 59799faad4..3ae42345e8 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page.py @@ -36,7 +36,7 @@ def __init__(self_, data: StatusPagesComponentGroupRelationshipsStatusPageData, """ The status page the component group belongs to. - :param data: + :param data: The data object identifying the status page the component group belongs to. :type data: StatusPagesComponentGroupRelationshipsStatusPageData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page_data.py b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page_data.py index d8e542d08b..85017c90d2 100644 --- a/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page_data.py +++ b/src/datadog_api_client/v2/model/status_pages_component_group_relationships_status_page_data.py @@ -33,7 +33,7 @@ def openapi_types(_): def __init__(self_, id: UUID, type: StatusPageDataType, **kwargs): """ - + The data object identifying the status page the component group belongs to. :param id: The ID of the status page. :type id: UUID diff --git a/src/datadog_api_client/v2/model/suite_create_edit.py b/src/datadog_api_client/v2/model/suite_create_edit.py index 86d2f29a7e..a3bd48a8e2 100644 --- a/src/datadog_api_client/v2/model/suite_create_edit.py +++ b/src/datadog_api_client/v2/model/suite_create_edit.py @@ -34,7 +34,7 @@ def openapi_types(_): def __init__(self_, attributes: SyntheticsSuite, type: SyntheticsSuiteTypes, **kwargs): """ - + Data object for creating or editing a Synthetic test suite. :param attributes: Object containing details about a Synthetic suite. :type attributes: SyntheticsSuite diff --git a/src/datadog_api_client/v2/model/suite_create_edit_request.py b/src/datadog_api_client/v2/model/suite_create_edit_request.py index 8ce9a26d0e..065eccd6c8 100644 --- a/src/datadog_api_client/v2/model/suite_create_edit_request.py +++ b/src/datadog_api_client/v2/model/suite_create_edit_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: SuiteCreateEdit, **kwargs): """ + Request body for creating or editing a Synthetic test suite. - - :param data: + :param data: Data object for creating or editing a Synthetic test suite. :type data: SuiteCreateEdit """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/suite_search_response_type.py b/src/datadog_api_client/v2/model/suite_search_response_type.py index fe5cf1443d..5360c63be4 100644 --- a/src/datadog_api_client/v2/model/suite_search_response_type.py +++ b/src/datadog_api_client/v2/model/suite_search_response_type.py @@ -14,7 +14,7 @@ class SuiteSearchResponseType(ModelSimple): """ - + Type for the Synthetics suites search response, `suites_search`. :param value: If omitted defaults to "suites_search". Must be one of ["suites_search"]. :type value: str diff --git a/src/datadog_api_client/v2/model/sync_property.py b/src/datadog_api_client/v2/model/sync_property.py index d507aa6d6a..bb588ab1fa 100644 --- a/src/datadog_api_client/v2/model/sync_property.py +++ b/src/datadog_api_client/v2/model/sync_property.py @@ -26,9 +26,9 @@ def openapi_types(_): def __init__(self_, sync_type: Union[str, UnsetType] = unset, **kwargs): """ - Sync property configuration + Sync property configuration. - :param sync_type: + :param sync_type: The direction and type of synchronization for this property. :type sync_type: str, optional """ if sync_type is not unset: diff --git a/src/datadog_api_client/v2/model/sync_property_with_mapping.py b/src/datadog_api_client/v2/model/sync_property_with_mapping.py index f9464f15f0..84ffb16166 100644 --- a/src/datadog_api_client/v2/model/sync_property_with_mapping.py +++ b/src/datadog_api_client/v2/model/sync_property_with_mapping.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ - Sync property with mapping configuration + Sync property with mapping configuration. - :param mapping: + :param mapping: Map of source values to destination values for synchronization. :type mapping: {str: (str,)}, optional - :param name_mapping: + :param name_mapping: Map of source names to display names used during synchronization. :type name_mapping: {str: (str,)}, optional - :param sync_type: + :param sync_type: The direction and type of synchronization for this property. :type sync_type: str, optional """ if mapping is not unset: diff --git a/src/datadog_api_client/v2/model/synthetics_network_test_edit.py b/src/datadog_api_client/v2/model/synthetics_network_test_edit.py index 4966faacf2..b5838d5332 100644 --- a/src/datadog_api_client/v2/model/synthetics_network_test_edit.py +++ b/src/datadog_api_client/v2/model/synthetics_network_test_edit.py @@ -34,7 +34,7 @@ def openapi_types(_): def __init__(self_, attributes: SyntheticsNetworkTest, type: SyntheticsNetworkTestType, **kwargs): """ - + Data object for creating or editing a Network Path test. :param attributes: Object containing details about a Network Path test. :type attributes: SyntheticsNetworkTest diff --git a/src/datadog_api_client/v2/model/synthetics_network_test_edit_request.py b/src/datadog_api_client/v2/model/synthetics_network_test_edit_request.py index d035d1e4fe..9ef1e5ac27 100644 --- a/src/datadog_api_client/v2/model/synthetics_network_test_edit_request.py +++ b/src/datadog_api_client/v2/model/synthetics_network_test_edit_request.py @@ -32,7 +32,7 @@ def __init__(self_, data: SyntheticsNetworkTestEdit, **kwargs): """ Network Path test request. - :param data: + :param data: Data object for creating or editing a Network Path test. :type data: SyntheticsNetworkTestEdit """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/synthetics_suite.py b/src/datadog_api_client/v2/model/synthetics_suite.py index 0c039e58ac..8736a912ad 100644 --- a/src/datadog_api_client/v2/model/synthetics_suite.py +++ b/src/datadog_api_client/v2/model/synthetics_suite.py @@ -85,7 +85,7 @@ def __init__( :param tags: Array of tags attached to the suite. :type tags: [str], optional - :param tests: + :param tests: Array of Synthetic tests included in the suite. :type tests: [SyntheticsSuiteTest] :param type: Type of the Synthetic suite, ``suite``. diff --git a/src/datadog_api_client/v2/model/synthetics_suite_search_response_data.py b/src/datadog_api_client/v2/model/synthetics_suite_search_response_data.py index ef55ea9895..4a9585cdfb 100644 --- a/src/datadog_api_client/v2/model/synthetics_suite_search_response_data.py +++ b/src/datadog_api_client/v2/model/synthetics_suite_search_response_data.py @@ -54,10 +54,10 @@ def __init__( :param attributes: Synthetics suite search response data attributes :type attributes: SyntheticsSuiteSearchResponseDataAttributes, optional - :param id: + :param id: The unique identifier of the suite search response data. :type id: UUID, optional - :param type: + :param type: Type for the Synthetics suites search response, ``suites_search``. :type type: SuiteSearchResponseType, optional """ if attributes is not unset: diff --git a/src/datadog_api_client/v2/model/synthetics_suite_search_response_data_attributes.py b/src/datadog_api_client/v2/model/synthetics_suite_search_response_data_attributes.py index 1497b85adb..93de5af9b0 100644 --- a/src/datadog_api_client/v2/model/synthetics_suite_search_response_data_attributes.py +++ b/src/datadog_api_client/v2/model/synthetics_suite_search_response_data_attributes.py @@ -44,10 +44,10 @@ def __init__( """ Synthetics suite search response data attributes - :param suites: + :param suites: List of Synthetic suites matching the search query. :type suites: [SyntheticsSuite], optional - :param total: + :param total: Total number of Synthetic suites matching the search query. :type total: int, optional """ if suites is not unset: diff --git a/src/datadog_api_client/v2/model/synthetics_suite_test.py b/src/datadog_api_client/v2/model/synthetics_suite_test.py index aea30d1179..6ebe788319 100644 --- a/src/datadog_api_client/v2/model/synthetics_suite_test.py +++ b/src/datadog_api_client/v2/model/synthetics_suite_test.py @@ -48,7 +48,7 @@ def __init__( :param alerting_criticality: Alerting criticality for each the test. :type alerting_criticality: SyntheticsSuiteTestAlertingCriticality, optional - :param public_id: + :param public_id: The public ID of the Synthetic test included in the suite. :type public_id: str """ if alerting_criticality is not unset: diff --git a/src/datadog_api_client/v2/model/table_row_resource_identifier.py b/src/datadog_api_client/v2/model/table_row_resource_identifier.py index 5ba481afab..4d0115a580 100644 --- a/src/datadog_api_client/v2/model/table_row_resource_identifier.py +++ b/src/datadog_api_client/v2/model/table_row_resource_identifier.py @@ -34,7 +34,7 @@ def __init__(self_, id: str, type: TableRowResourceDataType, **kwargs): """ Row resource containing a single row identifier. - :param id: + :param id: The primary key value that uniquely identifies the row to delete. :type id: str :param type: Row resource type. diff --git a/src/datadog_api_client/v2/model/tenancy_config.py b/src/datadog_api_client/v2/model/tenancy_config.py index 06979262b2..ff40ae4b20 100644 --- a/src/datadog_api_client/v2/model/tenancy_config.py +++ b/src/datadog_api_client/v2/model/tenancy_config.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[TenancyConfigData, UnsetType] = unset, **kwargs): """ + Response containing a single OCI tenancy integration configuration. - - :param data: + :param data: A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes. :type data: TenancyConfigData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_config_data.py b/src/datadog_api_client/v2/model/tenancy_config_data.py index e83e7786bd..67d6da4a93 100644 --- a/src/datadog_api_client/v2/model/tenancy_config_data.py +++ b/src/datadog_api_client/v2/model/tenancy_config_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes. - - :param attributes: + :param attributes: Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. :type attributes: TenancyConfigDataAttributes, optional - :param id: + :param id: The OCID of the OCI tenancy. :type id: str, optional :param type: OCI tenancy resource type. diff --git a/src/datadog_api_client/v2/model/tenancy_config_data_attributes.py b/src/datadog_api_client/v2/model/tenancy_config_data_attributes.py index 75bff9ba19..fbda153a3a 100644 --- a/src/datadog_api_client/v2/model/tenancy_config_data_attributes.py +++ b/src/datadog_api_client/v2/model/tenancy_config_data_attributes.py @@ -94,45 +94,45 @@ def __init__( **kwargs, ): """ + Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. - - :param billing_plan_id: + :param billing_plan_id: The identifier of the billing plan associated with the OCI tenancy. :type billing_plan_id: int, optional - :param config_version: + :param config_version: Version number of the integration the tenancy is integrated with :type config_version: int, optional - :param cost_collection_enabled: + :param cost_collection_enabled: Whether cost data collection from OCI is enabled for the tenancy. :type cost_collection_enabled: bool, optional - :param dd_compartment_id: + :param dd_compartment_id: The OCID of the OCI compartment used by the Datadog integration stack. :type dd_compartment_id: str, optional - :param dd_stack_id: + :param dd_stack_id: The OCID of the OCI Resource Manager stack used by the Datadog integration. :type dd_stack_id: str, optional - :param home_region: + :param home_region: The home region of the OCI tenancy (for example, us-ashburn-1). :type home_region: str, optional - :param logs_config: + :param logs_config: Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled. :type logs_config: TenancyConfigDataAttributesLogsConfig, optional - :param metrics_config: + :param metrics_config: Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded. :type metrics_config: TenancyConfigDataAttributesMetricsConfig, optional - :param parent_tenancy_name: + :param parent_tenancy_name: The name of the parent OCI tenancy, if applicable. :type parent_tenancy_name: str, optional - :param regions_config: + :param regions_config: Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection. :type regions_config: TenancyConfigDataAttributesRegionsConfig, optional - :param resource_collection_enabled: + :param resource_collection_enabled: Whether resource collection from OCI is enabled for the tenancy. :type resource_collection_enabled: bool, optional - :param tenancy_name: + :param tenancy_name: The human-readable name of the OCI tenancy. :type tenancy_name: str, optional - :param user_ocid: + :param user_ocid: The OCID of the OCI user used by the Datadog integration for authentication. :type user_ocid: str, optional """ if billing_plan_id is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_config_data_attributes_logs_config.py b/src/datadog_api_client/v2/model/tenancy_config_data_attributes_logs_config.py index 408e70fd35..c856a1f490 100644 --- a/src/datadog_api_client/v2/model/tenancy_config_data_attributes_logs_config.py +++ b/src/datadog_api_client/v2/model/tenancy_config_data_attributes_logs_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled. - - :param compartment_tag_filters: + :param compartment_tag_filters: List of compartment tag filters scoping log collection to specific compartments. :type compartment_tag_filters: [str], optional - :param enabled: + :param enabled: Whether log collection is enabled for the tenancy. :type enabled: bool, optional - :param enabled_services: + :param enabled_services: List of OCI service names for which log collection is enabled. :type enabled_services: [str], optional """ if compartment_tag_filters is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_config_data_attributes_metrics_config.py b/src/datadog_api_client/v2/model/tenancy_config_data_attributes_metrics_config.py index d479faf711..2a7be73730 100644 --- a/src/datadog_api_client/v2/model/tenancy_config_data_attributes_metrics_config.py +++ b/src/datadog_api_client/v2/model/tenancy_config_data_attributes_metrics_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded. - - :param compartment_tag_filters: + :param compartment_tag_filters: List of compartment tag filters scoping metrics collection to specific compartments. :type compartment_tag_filters: [str], optional - :param enabled: + :param enabled: Whether metrics collection is enabled for the tenancy. :type enabled: bool, optional - :param excluded_services: + :param excluded_services: List of OCI service names excluded from metrics collection. :type excluded_services: [str], optional """ if compartment_tag_filters is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_config_data_attributes_regions_config.py b/src/datadog_api_client/v2/model/tenancy_config_data_attributes_regions_config.py index 5aac02e501..730f22d168 100644 --- a/src/datadog_api_client/v2/model/tenancy_config_data_attributes_regions_config.py +++ b/src/datadog_api_client/v2/model/tenancy_config_data_attributes_regions_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection. - - :param available: + :param available: List of OCI regions available for data collection in the tenancy. :type available: [str], optional - :param disabled: + :param disabled: List of OCI regions explicitly disabled for data collection. :type disabled: [str], optional - :param enabled: + :param enabled: List of OCI regions enabled for data collection. :type enabled: [str], optional """ if available is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_config_list.py b/src/datadog_api_client/v2/model/tenancy_config_list.py index eb9096b8be..8c7f1f3035 100644 --- a/src/datadog_api_client/v2/model/tenancy_config_list.py +++ b/src/datadog_api_client/v2/model/tenancy_config_list.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[TenancyConfigData], **kwargs): """ + Response containing a list of OCI tenancy integration configurations. - - :param data: + :param data: List of OCI tenancy integration configuration objects. :type data: [TenancyConfigData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/tenancy_products_data.py b/src/datadog_api_client/v2/model/tenancy_products_data.py index 75c9e1a9a4..b224fffa88 100644 --- a/src/datadog_api_client/v2/model/tenancy_products_data.py +++ b/src/datadog_api_client/v2/model/tenancy_products_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + A single OCI tenancy product resource object containing the tenancy ID, type, and product attributes. - - :param attributes: + :param attributes: Attributes of an OCI tenancy product resource, containing the list of available products and their enablement status. :type attributes: TenancyProductsDataAttributes, optional - :param id: + :param id: The OCID of the OCI tenancy. :type id: str, optional :param type: OCI tenancy product resource type. diff --git a/src/datadog_api_client/v2/model/tenancy_products_data_attributes.py b/src/datadog_api_client/v2/model/tenancy_products_data_attributes.py index 077dd15bce..703605126c 100644 --- a/src/datadog_api_client/v2/model/tenancy_products_data_attributes.py +++ b/src/datadog_api_client/v2/model/tenancy_products_data_attributes.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, products: Union[List[TenancyProductsDataAttributesProductsItems], UnsetType] = unset, **kwargs): """ + Attributes of an OCI tenancy product resource, containing the list of available products and their enablement status. - - :param products: + :param products: List of Datadog products and their enablement status for the tenancy. :type products: [TenancyProductsDataAttributesProductsItems], optional """ if products is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_products_data_attributes_products_items.py b/src/datadog_api_client/v2/model/tenancy_products_data_attributes_products_items.py index 029bf74d09..d587afb329 100644 --- a/src/datadog_api_client/v2/model/tenancy_products_data_attributes_products_items.py +++ b/src/datadog_api_client/v2/model/tenancy_products_data_attributes_products_items.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, enabled: Union[bool, UnsetType] = unset, product_key: Union[str, UnsetType] = unset, **kwargs): """ + An individual Datadog product with its enablement status for a tenancy. - - :param enabled: + :param enabled: Indicates whether the product is enabled for the tenancy. :type enabled: bool, optional - :param product_key: + :param product_key: The unique key identifying the Datadog product (for example, CLOUD_SECURITY_POSTURE_MANAGEMENT). :type product_key: str, optional """ if enabled is not unset: diff --git a/src/datadog_api_client/v2/model/tenancy_products_list.py b/src/datadog_api_client/v2/model/tenancy_products_list.py index ee4a880e49..f897ac4ff8 100644 --- a/src/datadog_api_client/v2/model/tenancy_products_list.py +++ b/src/datadog_api_client/v2/model/tenancy_products_list.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[TenancyProductsData], **kwargs): """ + Response containing a list of OCI tenancy product resources with their product enablement status. - - :param data: + :param data: List of OCI tenancy product resource objects. :type data: [TenancyProductsData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/timeseries_response_series.py b/src/datadog_api_client/v2/model/timeseries_response_series.py index 51f369e6bb..67abbb4fef 100644 --- a/src/datadog_api_client/v2/model/timeseries_response_series.py +++ b/src/datadog_api_client/v2/model/timeseries_response_series.py @@ -51,7 +51,7 @@ def __init__( **kwargs, ): """ - + A single series in a timeseries query response, containing the query index, unit information, and group tags. :param group_tags: List of tags that apply to a single response value. :type group_tags: GroupTags, optional diff --git a/src/datadog_api_client/v2/model/unassign_seats_user_request.py b/src/datadog_api_client/v2/model/unassign_seats_user_request.py index 3f0f33e0fa..f0735c4462 100644 --- a/src/datadog_api_client/v2/model/unassign_seats_user_request.py +++ b/src/datadog_api_client/v2/model/unassign_seats_user_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[UnassignSeatsUserRequestData, UnsetType] = unset, **kwargs): """ + The request body for unassigning seats from users for a product code. - - :param data: + :param data: The request data object containing attributes for unassigning seats from users. :type data: UnassignSeatsUserRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/unassign_seats_user_request_data.py b/src/datadog_api_client/v2/model/unassign_seats_user_request_data.py index 619847e035..5d444066cd 100644 --- a/src/datadog_api_client/v2/model/unassign_seats_user_request_data.py +++ b/src/datadog_api_client/v2/model/unassign_seats_user_request_data.py @@ -48,9 +48,9 @@ def __init__( **kwargs, ): """ + The request data object containing attributes for unassigning seats from users. - - :param attributes: + :param attributes: Attributes specifying the product and users from whom seats will be unassigned. :type attributes: UnassignSeatsUserRequestDataAttributes :param id: The ID of the unassign seats user request. diff --git a/src/datadog_api_client/v2/model/unassign_seats_user_request_data_attributes.py b/src/datadog_api_client/v2/model/unassign_seats_user_request_data_attributes.py index 58b8b4130e..ed37b05ffb 100644 --- a/src/datadog_api_client/v2/model/unassign_seats_user_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/unassign_seats_user_request_data_attributes.py @@ -26,7 +26,7 @@ def openapi_types(_): def __init__(self_, product_code: str, user_uuids: List[str], **kwargs): """ - + Attributes specifying the product and users from whom seats will be unassigned. :param product_code: The product code for which to unassign seats. :type product_code: str diff --git a/src/datadog_api_client/v2/model/update_connection_request.py b/src/datadog_api_client/v2/model/update_connection_request.py index b948aa8011..49917be670 100644 --- a/src/datadog_api_client/v2/model/update_connection_request.py +++ b/src/datadog_api_client/v2/model/update_connection_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[UpdateConnectionRequestData, UnsetType] = unset, **kwargs): """ + Request body for updating an existing data source connection by adding, modifying, or removing fields. - - :param data: + :param data: The data object containing the resource identifier and attributes for updating an existing connection. :type data: UpdateConnectionRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/update_connection_request_data.py b/src/datadog_api_client/v2/model/update_connection_request_data.py index 381d878fb2..ade7f07e70 100644 --- a/src/datadog_api_client/v2/model/update_connection_request_data.py +++ b/src/datadog_api_client/v2/model/update_connection_request_data.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + The data object containing the resource identifier and attributes for updating an existing connection. - - :param attributes: + :param attributes: Attributes specifying the field modifications to apply to an existing connection. :type attributes: UpdateConnectionRequestDataAttributes, optional - :param id: + :param id: The unique identifier of the connection to update. :type id: str :param type: Connection id resource type. diff --git a/src/datadog_api_client/v2/model/update_connection_request_data_attributes.py b/src/datadog_api_client/v2/model/update_connection_request_data_attributes.py index c16da63b31..51adf55c7b 100644 --- a/src/datadog_api_client/v2/model/update_connection_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/update_connection_request_data_attributes.py @@ -52,15 +52,15 @@ def __init__( **kwargs, ): """ + Attributes specifying the field modifications to apply to an existing connection. - - :param fields_to_add: + :param fields_to_add: New fields to add to the connection from the data source. :type fields_to_add: [CreateConnectionRequestDataAttributesFieldsItems], optional - :param fields_to_delete: + :param fields_to_delete: Identifiers of existing fields to remove from the connection. :type fields_to_delete: [str], optional - :param fields_to_update: + :param fields_to_update: Existing fields with updated metadata to apply to the connection. :type fields_to_update: [UpdateConnectionRequestDataAttributesFieldsToUpdateItems], optional """ if fields_to_add is not unset: diff --git a/src/datadog_api_client/v2/model/update_connection_request_data_attributes_fields_to_update_items.py b/src/datadog_api_client/v2/model/update_connection_request_data_attributes_fields_to_update_items.py index 9e997e267c..057c4eb381 100644 --- a/src/datadog_api_client/v2/model/update_connection_request_data_attributes_fields_to_update_items.py +++ b/src/datadog_api_client/v2/model/update_connection_request_data_attributes_fields_to_update_items.py @@ -42,21 +42,21 @@ def __init__( **kwargs, ): """ + Specification for updating an existing field in a connection, including which field to modify and the new values. - - :param field_id: + :param field_id: The identifier of the existing field to update. :type field_id: str - :param updated_description: + :param updated_description: The new description to set for the field. :type updated_description: str, optional - :param updated_display_name: + :param updated_display_name: The new human-readable display name to set for the field. :type updated_display_name: str, optional - :param updated_field_id: + :param updated_field_id: The new identifier to assign to the field, if renaming it. :type updated_field_id: str, optional - :param updated_groups: + :param updated_groups: The updated list of group labels to associate with the field. :type updated_groups: [str], optional """ if updated_description is not unset: diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_data.py b/src/datadog_api_client/v2/model/update_tenancy_config_data.py index 81193613e1..1fda7af07f 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_data.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + The data object for updating an existing OCI tenancy integration configuration, including the tenancy ID, type, and updated attributes. - - :param attributes: + :param attributes: Attributes for updating an existing OCI tenancy integration configuration, including optional credentials, region settings, and collection options. :type attributes: UpdateTenancyConfigDataAttributes, optional - :param id: + :param id: The OCID of the OCI tenancy to update. :type id: str :param type: OCI tenancy resource type. diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes.py b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes.py index 3d8fd79f6f..0cac986ee3 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes.py @@ -79,30 +79,30 @@ def __init__( **kwargs, ): """ + Attributes for updating an existing OCI tenancy integration configuration, including optional credentials, region settings, and collection options. - - :param auth_credentials: + :param auth_credentials: OCI API signing key credentials used to update the Datadog integration's authentication with the OCI tenancy. :type auth_credentials: UpdateTenancyConfigDataAttributesAuthCredentials, optional - :param cost_collection_enabled: + :param cost_collection_enabled: Whether cost data collection from OCI is enabled for the tenancy. :type cost_collection_enabled: bool, optional - :param home_region: + :param home_region: The home region of the OCI tenancy (for example, us-ashburn-1). :type home_region: str, optional - :param logs_config: + :param logs_config: Log collection configuration for updating an OCI tenancy, controlling which compartments and services have log collection enabled. :type logs_config: UpdateTenancyConfigDataAttributesLogsConfig, optional - :param metrics_config: + :param metrics_config: Metrics collection configuration for updating an OCI tenancy, controlling which compartments and services are included or excluded. :type metrics_config: UpdateTenancyConfigDataAttributesMetricsConfig, optional - :param regions_config: + :param regions_config: Region configuration for updating an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. :type regions_config: UpdateTenancyConfigDataAttributesRegionsConfig, optional - :param resource_collection_enabled: + :param resource_collection_enabled: Whether resource collection from OCI is enabled for the tenancy. :type resource_collection_enabled: bool, optional - :param user_ocid: + :param user_ocid: The OCID of the OCI user used by the Datadog integration for authentication. :type user_ocid: str, optional """ if auth_credentials is not unset: diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_auth_credentials.py b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_auth_credentials.py index cb93ac5ec7..dfeb29cd64 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_auth_credentials.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_auth_credentials.py @@ -28,12 +28,12 @@ def openapi_types(_): def __init__(self_, private_key: str, fingerprint: Union[str, UnsetType] = unset, **kwargs): """ + OCI API signing key credentials used to update the Datadog integration's authentication with the OCI tenancy. - - :param fingerprint: + :param fingerprint: The fingerprint of the OCI API signing key used for authentication. :type fingerprint: str, optional - :param private_key: + :param private_key: The PEM-encoded private key corresponding to the OCI API signing key fingerprint. :type private_key: str """ if fingerprint is not unset: diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_logs_config.py b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_logs_config.py index cbd7c3b4c9..7a1a6954aa 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_logs_config.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_logs_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Log collection configuration for updating an OCI tenancy, controlling which compartments and services have log collection enabled. - - :param compartment_tag_filters: + :param compartment_tag_filters: List of compartment tag filters to scope log collection to specific compartments. :type compartment_tag_filters: [str], optional - :param enabled: + :param enabled: Whether log collection is enabled for the tenancy. :type enabled: bool, optional - :param enabled_services: + :param enabled_services: List of OCI service names for which log collection is enabled. :type enabled_services: [str], optional """ if compartment_tag_filters is not unset: diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_metrics_config.py b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_metrics_config.py index fca9482761..c2ef078033 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_metrics_config.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_metrics_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Metrics collection configuration for updating an OCI tenancy, controlling which compartments and services are included or excluded. - - :param compartment_tag_filters: + :param compartment_tag_filters: List of compartment tag filters to scope metrics collection to specific compartments. :type compartment_tag_filters: [str], optional - :param enabled: + :param enabled: Whether metrics collection is enabled for the tenancy. :type enabled: bool, optional - :param excluded_services: + :param excluded_services: List of OCI service names to exclude from metrics collection. :type excluded_services: [str], optional """ if compartment_tag_filters is not unset: diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_regions_config.py b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_regions_config.py index 6c23b0ba25..28e5699829 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_regions_config.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_data_attributes_regions_config.py @@ -36,15 +36,15 @@ def __init__( **kwargs, ): """ + Region configuration for updating an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. - - :param available: + :param available: List of OCI regions available for data collection in the tenancy. :type available: [str], optional - :param disabled: + :param disabled: List of OCI regions explicitly disabled for data collection. :type disabled: [str], optional - :param enabled: + :param enabled: List of OCI regions enabled for data collection. :type enabled: [str], optional """ if available is not unset: diff --git a/src/datadog_api_client/v2/model/update_tenancy_config_request.py b/src/datadog_api_client/v2/model/update_tenancy_config_request.py index e105d6263c..aa6ac61290 100644 --- a/src/datadog_api_client/v2/model/update_tenancy_config_request.py +++ b/src/datadog_api_client/v2/model/update_tenancy_config_request.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: UpdateTenancyConfigData, **kwargs): """ + Request body for updating an existing OCI tenancy integration configuration. - - :param data: + :param data: The data object for updating an existing OCI tenancy integration configuration, including the tenancy ID, type, and updated attributes. :type data: UpdateTenancyConfigData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/viewership_history_session_array.py b/src/datadog_api_client/v2/model/viewership_history_session_array.py index 31c5d39dce..c3860620ef 100644 --- a/src/datadog_api_client/v2/model/viewership_history_session_array.py +++ b/src/datadog_api_client/v2/model/viewership_history_session_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[ViewershipHistorySessionData], **kwargs): """ + A list of RUM replay sessions from a user's viewership history. - - :param data: + :param data: Array of viewership history session data objects. :type data: [ViewershipHistorySessionData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/viewership_history_session_data.py b/src/datadog_api_client/v2/model/viewership_history_session_data.py index 266edc9a3f..c5e0cb736b 100644 --- a/src/datadog_api_client/v2/model/viewership_history_session_data.py +++ b/src/datadog_api_client/v2/model/viewership_history_session_data.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + Data object representing a session in the viewership history, including its identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes of a viewership history session entry, capturing when it was last watched and the associated event data. :type attributes: ViewershipHistorySessionDataAttributes, optional - :param id: + :param id: Unique identifier of the RUM replay session. :type id: str, optional :param type: Rum replay session resource type. diff --git a/src/datadog_api_client/v2/model/viewership_history_session_data_attributes.py b/src/datadog_api_client/v2/model/viewership_history_session_data_attributes.py index aa2f520c69..0b1727a76c 100644 --- a/src/datadog_api_client/v2/model/viewership_history_session_data_attributes.py +++ b/src/datadog_api_client/v2/model/viewership_history_session_data_attributes.py @@ -58,18 +58,18 @@ def __init__( **kwargs, ): """ + Attributes of a viewership history session entry, capturing when it was last watched and the associated event data. - - :param event_id: + :param event_id: Unique identifier of the RUM event associated with the watched session. :type event_id: str, optional - :param last_watched_at: + :param last_watched_at: Timestamp when the session was last watched by the user. :type last_watched_at: datetime - :param session_event: + :param session_event: Raw event data associated with the replay session. :type session_event: {str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional - :param track: + :param track: Replay track identifier indicating which recording track the session belongs to. :type track: str, optional """ if event_id is not unset: diff --git a/src/datadog_api_client/v2/model/watch.py b/src/datadog_api_client/v2/model/watch.py index eedca1a782..6e844cc44d 100644 --- a/src/datadog_api_client/v2/model/watch.py +++ b/src/datadog_api_client/v2/model/watch.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: WatchData, **kwargs): """ + A single RUM replay session watch resource returned by create operations. - - :param data: + :param data: Data object representing a session watch record, including its identifier, type, and attributes. :type data: WatchData """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/watch_data.py b/src/datadog_api_client/v2/model/watch_data.py index 973497b885..5f0058382f 100644 --- a/src/datadog_api_client/v2/model/watch_data.py +++ b/src/datadog_api_client/v2/model/watch_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + Data object representing a session watch record, including its identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes for recording a session watch event, including the application, event reference, and timestamp. :type attributes: WatchDataAttributes, optional - :param id: + :param id: Unique identifier of the watch record. :type id: str, optional :param type: Rum replay watch resource type. diff --git a/src/datadog_api_client/v2/model/watch_data_attributes.py b/src/datadog_api_client/v2/model/watch_data_attributes.py index fe4e19f6b0..96cbbace3b 100644 --- a/src/datadog_api_client/v2/model/watch_data_attributes.py +++ b/src/datadog_api_client/v2/model/watch_data_attributes.py @@ -40,18 +40,18 @@ def __init__( **kwargs, ): """ + Attributes for recording a session watch event, including the application, event reference, and timestamp. - - :param application_id: + :param application_id: Unique identifier of the RUM application containing the session. :type application_id: str - :param data_source: + :param data_source: Data source type indicating the origin of the session data (e.g., rum or product_analytics). :type data_source: str, optional - :param event_id: + :param event_id: Unique identifier of the RUM event that was watched. :type event_id: str - :param timestamp: + :param timestamp: Timestamp when the session was watched. :type timestamp: datetime """ if data_source is not unset: diff --git a/src/datadog_api_client/v2/model/watcher_array.py b/src/datadog_api_client/v2/model/watcher_array.py index f98d110d21..e2bd082875 100644 --- a/src/datadog_api_client/v2/model/watcher_array.py +++ b/src/datadog_api_client/v2/model/watcher_array.py @@ -30,9 +30,9 @@ def openapi_types(_): def __init__(self_, data: List[WatcherData], **kwargs): """ + A list of users who have watched a RUM replay session. - - :param data: + :param data: Array of watcher data objects. :type data: [WatcherData] """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/watcher_data.py b/src/datadog_api_client/v2/model/watcher_data.py index 5150c6dd41..59030daff1 100644 --- a/src/datadog_api_client/v2/model/watcher_data.py +++ b/src/datadog_api_client/v2/model/watcher_data.py @@ -44,12 +44,12 @@ def __init__( **kwargs, ): """ + Data object representing a session watcher, including their identifier, type, and attributes. - - :param attributes: + :param attributes: Attributes of a user who has watched a RUM replay session, including contact information and watch statistics. :type attributes: WatcherDataAttributes, optional - :param id: + :param id: Unique identifier of the watcher user. :type id: str, optional :param type: Rum replay watcher resource type. diff --git a/src/datadog_api_client/v2/model/watcher_data_attributes.py b/src/datadog_api_client/v2/model/watcher_data_attributes.py index 828f003bc8..66d195fc32 100644 --- a/src/datadog_api_client/v2/model/watcher_data_attributes.py +++ b/src/datadog_api_client/v2/model/watcher_data_attributes.py @@ -49,21 +49,21 @@ def __init__( **kwargs, ): """ + Attributes of a user who has watched a RUM replay session, including contact information and watch statistics. - - :param handle: + :param handle: Email handle of the user who watched the session. :type handle: str - :param icon: + :param icon: URL or identifier of the watcher's avatar icon. :type icon: str, optional - :param last_watched_at: + :param last_watched_at: Timestamp when the watcher last viewed the session. :type last_watched_at: datetime - :param name: + :param name: Display name of the user who watched the session. :type name: str, optional - :param watch_count: + :param watch_count: Total number of times the user has watched the session. :type watch_count: int """ if icon is not unset: