@dynatrace-sdk/client-classic-environment-v2 3.0.0 → 3.2.0

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.d.ts

@@ -8,14 +8,26 @@ import { TrackingLink } from './tracking-link';
  * Detailed information of a remediation item for a security problem.
  */
 export interface RemediationDetailsItem {
+    /**
+     * Assessment of the remediation item.
+     */
     assessment?: RemediationAssessment;
     entityIds?: string[];
     firstAffectedTimestamp?: number;
     id?: string;
+    /**
+     * The mute state of a remediation item of a security problem.
+     */
     muteState?: RemediationItemMuteState;
     name?: string;
+    /**
+     * The progress of this remediation item. It contains affected and unaffected entities.
+     */
     remediationProgress?: RemediationProgress;
     resolvedTimestamp?: number;
+    /**
+     * External tracking link URL associated with the remediable entity of the security problem.
+     */
     trackingLink?: TrackingLink;
     vulnerabilityState?: RemediationDetailsItemVulnerabilityState;
     /**

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state-change.d.ts

@@ -11,5 +11,8 @@ export interface RemediationItemMuteStateChange {
      * The desired mute state of the remediation item.
      */
     muted: boolean;
+    /**
+     * The reason for the mute state change.
+     */
     reason: RemediationItemMuteStateChangeReason;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state.d.ts

@@ -15,6 +15,9 @@ export interface RemediationItemMuteState {
      * The remediation is (`true`) or is not (`false`) muted.
      */
     muted?: boolean;
+    /**
+     * The reason for the most recent mute state change.
+     */
     reason?: RemediationItemMuteStateReason;
     /**
      * The user who last changed the mute state.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts

@@ -7,6 +7,9 @@ export interface RemediationItemMutingSummary {
      * Whether a mute state change for the given remediation item was triggered by this request.
      */
     muteStateChangeTriggered: boolean;
+    /**
+     * Contains a reason, in case the requested operation was not executed.
+     */
     reason?: RemediationItemMutingSummaryReason;
     /**
      * The id of the remediation item that will be (un-)muted.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.d.ts

@@ -8,14 +8,26 @@ import { VulnerableComponent } from './vulnerable-component';
  * A possible remediation for a security problem.
  */
 export interface RemediationItem {
+    /**
+     * Assessment of the remediation item.
+     */
     assessment?: RemediationAssessment;
     entityIds?: string[];
     firstAffectedTimestamp?: number;
     id?: string;
+    /**
+     * The mute state of a remediation item of a security problem.
+     */
     muteState?: RemediationItemMuteState;
     name?: string;
+    /**
+     * The progress of this remediation item. It contains affected and unaffected entities.
+     */
     remediationProgress?: RemediationProgress;
     resolvedTimestamp?: number;
+    /**
+     * External tracking link URL associated with the remediable entity of the security problem.
+     */
     trackingLink?: TrackingLink;
     vulnerabilityState?: RemediationItemVulnerabilityState;
     /**

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts

@@ -7,6 +7,9 @@ export interface RemediationItemsBulkMute {
      * A comment about the muting reason.
      */
     comment?: string;
+    /**
+     * The reason for muting the remediation items.
+     */
     reason: RemediationItemsBulkMuteReason;
     /**
      * The ids of the remediation items to be muted.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts

@@ -7,6 +7,9 @@ export interface RemediationItemsBulkUnmute {
      * A comment about the un-muting reason.
      */
     comment?: string;
+    /**
+     * The reason for un-muting the remediation items.
+     */
     reason: RemediationItemsBulkUnmuteReason;
     /**
      * The ids of the remediation items to be un-muted.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.d.ts

@@ -9,5 +9,12 @@ export interface RemediationItemsBulkUpdateDeleteDto {
      * List of remediation item IDs of the security problem for which to remove the tracking links.
      */
     deletes?: string[];
+    /**
+     * Tracking links to set for the security problem.
+     *
+     * Map of remediation item ID to tracking link objects.
+     *
+     * Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.
+     */
     updates?: RemediationItemsBulkUpdateDeleteDtoUpdates;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment.d.ts

@@ -8,6 +8,9 @@ export interface RemediationProgressEntityAssessment {
      * Whether a restart is required for the latest vulnerable function data.
      */
     vulnerableFunctionRestartRequired?: boolean;
+    /**
+     * The usage of vulnerable functions
+     */
     vulnerableFunctionUsage?: RemediationProgressEntityAssessmentVulnerableFunctionUsage;
     /**
      * A list of vulnerable functions that are in use.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity.d.ts

@@ -5,6 +5,9 @@ import { RemediationProgressVulnerableComponent } from './remediation-progress-v
  * An affected or unaffected entity of a remediation for a security problem.
  */
 export interface RemediationProgressEntity {
+    /**
+     * Assessment of the remediation progress entity.
+     */
     assessment?: RemediationProgressEntityAssessment;
     /**
      * The timestamp when the remediation progress entity has first been related to the vulnerability.
@@ -18,6 +21,9 @@ export interface RemediationProgressEntity {
      * The name of the remediation progress entity.
      */
     name?: string;
+    /**
+     * The current state of the remediation progress entity.
+     */
     state?: RemediationProgressEntityState;
     /**
      * A list of vulnerable components of the remediation item.

package/types/packages/client/classic-environment-v2/src/lib/models/request-information.d.ts

@@ -11,6 +11,9 @@ export interface RequestInformation {
      * The request path.
      */
     path?: string;
+    /**
+     * Details that are specific to the used protocol.
+     */
     protocolDetails?: ProtocolDetails;
     /**
      * The requested URL.

package/types/packages/client/classic-environment-v2/src/lib/models/resource-context.d.ts

@@ -4,6 +4,9 @@ import { ResourceContextOperationsItem } from './resource-context-operations-ite
  * The resource context, which contains additional permission information about the object.
  */
 export interface ResourceContext {
+    /**
+     * The additional modification details for this settings object.
+     */
     modifications: Modification;
     /**
      * The allowed operations on this settings object.

package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts

@@ -17,6 +17,9 @@ export interface RevisionDiff {
      * The JSON Patch for this value. May be null if the diff type is not UPDATE.
      */
     jsonPatch?: AnyValue;
+    /**
+     * Modification information about the setting.
+     */
     modificationInfo?: HistoryModificationInfo;
     /**
      * The ID of the settings object.
@@ -30,5 +33,8 @@ export interface RevisionDiff {
      * The schema version the new value complies to
      */
     schemaVersion?: string;
+    /**
+     * The type of the difference.
+     */
     type?: RevisionDiffType;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-changes.d.ts

@@ -29,7 +29,16 @@ export interface RiskAssessmentChanges {
      * The delta of the Davis risk score.
      */
     deltaRiskScore?: number;
+    /**
+     * The previous level of exposure of affected entities.
+     */
     previousExposure?: RiskAssessmentChangesPreviousExposure;
+    /**
+     * The previous availability status of public exploits.
+     */
     previousPublicExploit?: RiskAssessmentChangesPreviousPublicExploit;
+    /**
+     * The previous state of vulnerable code execution.
+     */
     previousVulnerableFunctionUsage?: RiskAssessmentChangesPreviousVulnerableFunctionUsage;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.d.ts

@@ -10,8 +10,17 @@ import { RiskAssessmentDetailsVulnerableFunctionUsage } from './risk-assessment-
  * Risk assessment of a security problem.
  */
 export interface RiskAssessmentDetails {
+    /**
+     * The accuracy of the assessment.
+     */
     assessmentAccuracy?: RiskAssessmentDetailsAssessmentAccuracy;
+    /**
+     * The assessment accuracy details.
+     */
     assessmentAccuracyDetails?: AssessmentAccuracyDetails;
+    /**
+     * The risk level from the CVSS score.
+     */
     baseRiskLevel?: RiskAssessmentDetailsBaseRiskLevel;
     /**
      * The risk score (1-10) from the CVSS score.
@@ -21,9 +30,23 @@ export interface RiskAssessmentDetails {
      * The original attack vector of the CVSS assessment.
      */
     baseRiskVector?: string;
+    /**
+     * The reachability of related data assets by affected entities.
+     */
     dataAssets?: RiskAssessmentDetailsDataAssets;
+    /**
+     * The level of exposure of affected entities.
+     */
     exposure?: RiskAssessmentDetailsExposure;
+    /**
+     * The availability status of public exploits.
+     */
     publicExploit?: RiskAssessmentDetailsPublicExploit;
+    /**
+     * The Davis risk level.
+     *
+     *  It is calculated by Dynatrace on the basis of CVSS score.
+     */
     riskLevel?: RiskAssessmentDetailsRiskLevel;
     /**
      * The Davis risk score (1-10).
@@ -39,5 +62,8 @@ export interface RiskAssessmentDetails {
      * Whether a restart is required for new vulnerable function data.
      */
     vulnerableFunctionRestartRequired?: boolean;
+    /**
+     * The state of vulnerable code execution.
+     */
     vulnerableFunctionUsage?: RiskAssessmentDetailsVulnerableFunctionUsage;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot.d.ts

@@ -11,7 +11,13 @@ export interface RiskAssessmentSnapshot {
      * The risk score (1-10) from the CVSS score.
      */
     baseRiskScore?: number;
+    /**
+     * All changes of the risk assessment.
+     */
     changes?: RiskAssessmentChanges;
+    /**
+     * The level of exposure of affected entities.
+     */
     exposure?: RiskAssessmentSnapshotExposure;
     /**
      * The number of currently affected entities.
@@ -33,7 +39,15 @@ export interface RiskAssessmentSnapshot {
      * The number of related attacks.
      */
     numberOfRelatedAttacks?: number;
+    /**
+     * The availability status of public exploits.
+     */
     publicExploit?: RiskAssessmentSnapshotPublicExploit;
+    /**
+     * The Davis risk level.
+     *
+     *  It is calculated by Dynatrace on the basis of CVSS score.
+     */
     riskLevel?: RiskAssessmentSnapshotRiskLevel;
     /**
      * The Davis risk score (1-10).
@@ -41,5 +55,8 @@ export interface RiskAssessmentSnapshot {
      *  It is calculated by Dynatrace on the basis of CVSS score.
      */
     riskScore?: number;
+    /**
+     * The state of vulnerable code execution.
+     */
     vulnerableFunctionUsage?: RiskAssessmentSnapshotVulnerableFunctionUsage;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment.d.ts

@@ -10,8 +10,17 @@ import { RiskAssessmentVulnerableFunctionUsage } from './risk-assessment-vulnera
  * Risk assessment of a security problem.
  */
 export interface RiskAssessment {
+    /**
+     * The accuracy of the assessment.
+     */
     assessmentAccuracy?: RiskAssessmentAssessmentAccuracy;
+    /**
+     * The assessment accuracy details.
+     */
     assessmentAccuracyDetails?: AssessmentAccuracyDetails;
+    /**
+     * The risk level from the CVSS score.
+     */
     baseRiskLevel?: RiskAssessmentBaseRiskLevel;
     /**
      * The risk score (1-10) from the CVSS score.
@@ -21,9 +30,23 @@ export interface RiskAssessment {
      * The original attack vector of the CVSS assessment.
      */
     baseRiskVector?: string;
+    /**
+     * The reachability of related data assets by affected entities.
+     */
     dataAssets?: RiskAssessmentDataAssets;
+    /**
+     * The level of exposure of affected entities.
+     */
     exposure?: RiskAssessmentExposure;
+    /**
+     * The availability status of public exploits.
+     */
     publicExploit?: RiskAssessmentPublicExploit;
+    /**
+     * The Davis risk level.
+     *
+     *  It is calculated by Dynatrace on the basis of CVSS score.
+     */
     riskLevel?: RiskAssessmentRiskLevel;
     /**
      * The Davis risk score (1-10).
@@ -35,5 +58,8 @@ export interface RiskAssessment {
      * The attack vector calculated by Dynatrace based on the CVSS attack vector.
      */
     riskVector?: string;
+    /**
+     * The state of vulnerable code execution.
+     */
     vulnerableFunctionUsage?: RiskAssessmentVulnerableFunctionUsage;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.d.ts

@@ -12,6 +12,9 @@ export interface SchemaConstraintRestDto {
      * Whether to skip validation on a change made from the UI.
      */
     skipAsyncValidation?: boolean;
+    /**
+     * The type of the schema constraint.
+     */
     type: SchemaConstraintRestDtoType;
     /**
      * The list of properties for which the combination of values needs to be unique

package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts

@@ -36,6 +36,9 @@ export interface SchemaDefinitionRestDto {
      * The version of the data format.
      */
     dynatrace: string;
+    /**
+     * A list of definitions of enum properties.
+     */
     enums: SchemaDefinitionRestDtoEnums;
     /**
      * Name of the key property in this schema.
@@ -47,6 +50,9 @@ export interface SchemaDefinitionRestDto {
      * Only applicable when **multiObject** is set to `true`.
      */
     maxObjects: number;
+    /**
+     * Metadata of the setting.
+     */
     metadata?: SchemaDefinitionRestDtoMetadata;
     /**
      * Multiple (`true`) objects per scope are permitted or a single (`false`) object per scope is permitted.
@@ -58,6 +64,9 @@ export interface SchemaDefinitionRestDto {
      * Only applicable when **multiObject** is set to `true`.
      */
     ordered?: boolean;
+    /**
+     * A list of schema's properties.
+     */
     properties: SchemaDefinitionRestDtoProperties;
     /**
      * Constraints limiting the values as a whole to be accepted in this configuration element.
@@ -71,8 +80,19 @@ export interface SchemaDefinitionRestDto {
      * The ID of the schema.
      */
     schemaId: string;
+    /**
+     * Table column definitions for use in the ui.
+     */
     tableColumns?: SchemaDefinitionRestDtoTableColumns;
+    /**
+     * A list of definitions of types.
+     *
+     *  A type is a complex property that contains its own set of subproperties.
+     */
     types: SchemaDefinitionRestDtoTypes;
+    /**
+     * Customization for UI elements
+     */
     uiCustomization?: UiCustomization;
     /**
      * The version of the schema.

package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts

@@ -23,6 +23,9 @@ export interface SchemaType {
      * An extended description and/or links to documentation.
      */
     documentation: string;
+    /**
+     * Definition of properties that can be persisted.
+     */
     properties: SchemaTypeProperties;
     /**
      * The pattern for the summary search(for example, "Alert after *X* minutes.") of the configuration in the UI.
@@ -32,6 +35,9 @@ export interface SchemaType {
      * The pattern for the summary (for example, "Alert after *X* minutes.") of the configuration in the UI.
      */
     summaryPattern: string;
+    /**
+     * Type of the reference type.
+     */
     type: SchemaTypeType;
     /**
      * The version of the type.

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary.d.ts

@@ -7,6 +7,9 @@ export interface SecurityProblemBulkMutingSummary {
      * Whether a mute state change for the given security problem was triggered by this request.
      */
     muteStateChangeTriggered: boolean;
+    /**
+     * Contains a reason, in case the requested operation was not executed.
+     */
     reason?: SecurityProblemBulkMutingSummaryReason;
     /**
      * The id of the security problem that was (un-)muted.

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts

@@ -22,6 +22,9 @@ export interface SecurityProblemDetails {
      * An affected entity is an entity where a vulnerable component runs.
      */
     affectedEntities?: string[];
+    /**
+     * The details of a code-level vulnerability.
+     */
     codeLevelVulnerabilityDetails?: CodeLevelVulnerabilityDetails;
     /**
      * A list of CVE IDs of the security problem.
@@ -35,6 +38,9 @@ export interface SecurityProblemDetails {
      * The display ID of the security problem.
      */
     displayId?: string;
+    /**
+     * A list of entry points and a flag which indicates whether this list was truncated or not.
+     */
     entryPoints?: EntryPoints;
     /**
      * An ordered (newest first) list of events of the security problem.
@@ -50,11 +56,17 @@ export interface SecurityProblemDetails {
      * The external vulnerability ID of the security problem.
      */
     externalVulnerabilityId?: string;
+    /**
+     * Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.
+     */
     filteredCounts?: FilteredCountsDto;
     /**
      * The timestamp of the first occurrence of the security problem.
      */
     firstSeenTimestamp?: number;
+    /**
+     * Globally calculated statistics about the security problem. No management zone information is taken into account.
+     */
     globalCounts?: GlobalCountsDto;
     /**
      * The timestamp when the security problem was last opened.
@@ -90,19 +102,43 @@ export interface SecurityProblemDetails {
      * A data asset is a service that has database access.
      */
     reachableDataAssets?: string[];
+    /**
+     * A list of related attacks of the security problem.
+     *
+     * Related attacks are attacks on the exposed security problem.
+     */
     relatedAttacks?: RelatedAttacksList;
+    /**
+     * A list of related container images.
+     */
     relatedContainerImages?: RelatedContainerList;
+    /**
+     * A list of related entities of the security problem.
+     *
+     * A related entity is a monitored entity that is directly or indirectly related to an *affected entity* (for example, it could be a host where an affected process runs).
+     *
+     * Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).
+     */
     relatedEntities?: RelatedEntitiesList;
     /**
      * Description of how to remediate the vulnerability.
      */
     remediationDescription?: string;
+    /**
+     * Risk assessment of a security problem.
+     */
     riskAssessment?: RiskAssessmentDetails;
     /**
      * The ID of the security problem.
      */
     securityProblemId?: string;
+    /**
+     * The status of the security problem.
+     */
     status?: SecurityProblemDetailsStatus;
+    /**
+     * The technology of the security problem.
+     */
     technology?: SecurityProblemDetailsTechnology;
     /**
      * The title of the security problem.
@@ -112,6 +148,9 @@ export interface SecurityProblemDetails {
      * The URL to the security problem details page.
      */
     url?: string;
+    /**
+     * The type of the vulnerability.
+     */
     vulnerabilityType?: SecurityProblemDetailsVulnerabilityType;
     /**
      * A list of vulnerable components of the security problem.

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-event.d.ts

@@ -5,8 +5,17 @@ import { SecurityProblemEventReason } from './security-problem-event-reason';
  * The event of a security problem.
  */
 export interface SecurityProblemEvent {
+    /**
+     * Metadata of the muted state of a security problem in relation to an event.
+     */
     muteState?: MuteState;
+    /**
+     * The reason of the event creation.
+     */
     reason?: SecurityProblemEventReason;
+    /**
+     * A snapshot of the risk assessment of a security problem.
+     */
     riskAssessmentSnapshot?: RiskAssessmentSnapshot;
     /**
      * The timestamp when the event occurred.

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts

@@ -7,5 +7,8 @@ export interface SecurityProblemMute {
      * A comment about the muting reason.
      */
     comment?: string;
+    /**
+     * The reason for muting a security problem.
+     */
     reason: SecurityProblemMuteReason;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts

@@ -7,5 +7,8 @@ export interface SecurityProblemUnmute {
      * A comment about the un-muting reason.
      */
     comment?: string;
+    /**
+     * The reason for un-muting a security problem.
+     */
     reason: SecurityProblemUnmuteReason;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem.d.ts

@@ -9,6 +9,9 @@ import { SecurityProblemVulnerabilityType } from './security-problem-vulnerabili
  * Parameters of a security problem
  */
 export interface SecurityProblem {
+    /**
+     * The details of a code-level vulnerability.
+     */
     codeLevelVulnerabilityDetails?: CodeLevelVulnerabilityDetails;
     /**
      * A list of CVE IDs of the security problem.
@@ -26,6 +29,9 @@ export interface SecurityProblem {
      * The timestamp of the first occurrence of the security problem.
      */
     firstSeenTimestamp?: number;
+    /**
+     * Globally calculated statistics about the security problem. No management zone information is taken into account.
+     */
     globalCounts?: GlobalCountsDto;
     /**
      * The timestamp when the security problem was last opened.
@@ -51,12 +57,21 @@ export interface SecurityProblem {
      * The package name of the security problem.
      */
     packageName?: string;
+    /**
+     * Risk assessment of a security problem.
+     */
     riskAssessment?: RiskAssessment;
     /**
      * The ID of the security problem.
      */
     securityProblemId?: string;
+    /**
+     * The status of the security problem.
+     */
     status?: SecurityProblemStatus;
+    /**
+     * The technology of the security problem.
+     */
     technology?: SecurityProblemTechnology;
     /**
      * The title of the security problem.
@@ -66,5 +81,8 @@ export interface SecurityProblem {
      * The URL to the security problem details page.
      */
     url?: string;
+    /**
+     * The type of the vulnerability.
+     */
     vulnerabilityType?: SecurityProblemVulnerabilityType;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts

@@ -7,6 +7,9 @@ export interface SecurityProblemsBulkMute {
      * A comment about the muting reason.
      */
     comment?: string;
+    /**
+     * The reason for muting the security problems.
+     */
     reason: SecurityProblemsBulkMuteReason;
     /**
      * The ids of the security problems to be muted.

package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute.d.ts

@@ -7,6 +7,9 @@ export interface SecurityProblemsBulkUnmute {
      * A comment about the un-muting reason.
      */
     comment?: string;
+    /**
+     * The reason for un-muting the security problems.
+     */
     reason: SecurityProblemsBulkUnmuteReason;
     /**
      * The ids of the security problems to be un-muted.

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.d.ts

@@ -1,4 +1,5 @@
 import { AnyValue } from './any-value';
+import { Identity } from './identity';
 import { ResourceContext } from './resource-context';
 /**
  * The response to a get by objectId request.
@@ -32,6 +33,13 @@ export interface SettingsObjectByObjectIdResponse {
      * The ID of the settings object.
      */
     objectId?: string;
+    /**
+     * An Identity describing either a user, a group, or the all-users group (applying to all users).
+     */
+    owner?: Identity;
+    /**
+     * The resource context, which contains additional permission information about the object.
+     */
     resourceContext?: ResourceContext;
     /**
      * The schema on which the object is based.