openlayer 0.16.0 → 0.17.0

data/rbi/openlayer/models/governance/frameworks/section_list_rules_response.rbi

@@ -60,7 +60,8 @@ module Openlayer
             attr_accessor :name
 
             # Whether the rule is evaluated once for the whole workspace, or once per project
-            # the rule's frameworks apply to.
+            # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+            # the rule is created.
             sig do
               returns(
                 Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::TaggedSymbol
@@ -69,7 +70,8 @@ module Openlayer
             attr_accessor :scope
 
             # `platform` rules are evaluated automatically from the state of your Openlayer
-            # workspace. `evidence` rules are satisfied by attaching evidence.
+            # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+            # rule is created.
             sig do
               returns(
                 Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::TaggedSymbol
@@ -81,13 +83,15 @@ module Openlayer
             sig { returns(T.nilable(String)) }
             attr_accessor :assignee_id
 
-            # Configuration for the platform check, when the automation takes parameters.
+            # Configuration for the platform check, when the automation takes parameters. Omit
+            # or `null` for evidence rules. Fixed once the rule is created.
             sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :automation_params
 
             # Which workspace signal a platform rule checks, for example
-            # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
-            # evidence rules.
+            # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
+            # platform rules; omit or `null` for evidence rules. Fixed once the rule is
+            # created.
             sig { returns(T.nilable(String)) }
             attr_accessor :automation_type
 
@@ -102,7 +106,8 @@ module Openlayer
             sig { returns(T.nilable(String)) }
             attr_accessor :description
 
-            # The kind of evidence that satisfies the rule. `null` for platform rules.
+            # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+            # `null` for platform rules. Fixed once the rule is created.
             sig do
               returns(
                 T.nilable(
@@ -113,7 +118,8 @@ module Openlayer
             attr_accessor :evidence_type
 
             # How often evidence must be renewed, in days. Once evidence is older than this,
-            # the rule result becomes `due_soon` and then `failing`.
+            # the rule result becomes `due_soon` and then `failing`. The window restarts
+            # whenever evidence is attached. Omit or `null` for platform rules.
             sig { returns(T.nilable(Integer)) }
             attr_accessor :renewal_cadence_days
 
@@ -155,7 +161,8 @@ module Openlayer
             end
             attr_writer :frameworks
 
-            # Whether the rule is managed by Openlayer and cannot be edited.
+            # Whether the rule is managed by Openlayer. These rules can't be renamed or
+            # deleted; set `deactivated` to exclude one from compliance instead.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :immutable
 
@@ -218,6 +225,10 @@ module Openlayer
             end
             attr_accessor :tags
 
+            # A single requirement Openlayer tracks. `platform` rules are evaluated
+            # automatically from the state of your workspace, and `evidence` rules are
+            # satisfied by attaching evidence. A rule can belong to several frameworks, or to
+            # none.
             sig do
               params(
                 id: String,
@@ -270,33 +281,40 @@ module Openlayer
               # The rule name.
               name:,
               # Whether the rule is evaluated once for the whole workspace, or once per project
-              # the rule's frameworks apply to.
+              # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+              # the rule is created.
               scope:,
               # `platform` rules are evaluated automatically from the state of your Openlayer
-              # workspace. `evidence` rules are satisfied by attaching evidence.
+              # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+              # rule is created.
               type:,
               # The id of the workspace the rule belongs to.
               workspace_id:,
               # The user responsible for satisfying the rule.
               assignee_id: nil,
-              # Configuration for the platform check, when the automation takes parameters.
+              # Configuration for the platform check, when the automation takes parameters. Omit
+              # or `null` for evidence rules. Fixed once the rule is created.
               automation_params: nil,
               # Which workspace signal a platform rule checks, for example
-              # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
-              # evidence rules.
+              # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
+              # platform rules; omit or `null` for evidence rules. Fixed once the rule is
+              # created.
               automation_type: nil,
               # Whether the rule is excluded from compliance calculations.
               deactivated: nil,
               # What the rule requires.
               description: nil,
-              # The kind of evidence that satisfies the rule. `null` for platform rules.
+              # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+              # `null` for platform rules. Fixed once the rule is created.
               evidence_type: nil,
               # The frameworks that include this rule.
               frameworks: nil,
-              # Whether the rule is managed by Openlayer and cannot be edited.
+              # Whether the rule is managed by Openlayer. These rules can't be renamed or
+              # deleted; set `deactivated` to exclude one from compliance instead.
               immutable: nil,
               # How often evidence must be renewed, in days. Once evidence is older than this,
-              # the rule result becomes `due_soon` and then `failing`.
+              # the rule result becomes `due_soon` and then `failing`. The window restarts
+              # whenever evidence is attached. Omit or `null` for platform rules.
               renewal_cadence_days: nil,
               # The rule's results, one per entity the rule is evaluated against. Only returned
               # when `includeResults` is `true`.
@@ -358,7 +376,8 @@ module Openlayer
             end
 
             # Whether the rule is evaluated once for the whole workspace, or once per project
-            # the rule's frameworks apply to.
+            # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+            # the rule is created.
             module Scope
               extend Openlayer::Internal::Type::Enum
 
@@ -394,7 +413,8 @@ module Openlayer
             end
 
             # `platform` rules are evaluated automatically from the state of your Openlayer
-            # workspace. `evidence` rules are satisfied by attaching evidence.
+            # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+            # rule is created.
             module Type
               extend Openlayer::Internal::Type::Enum
 
@@ -429,7 +449,8 @@ module Openlayer
               end
             end
 
-            # The kind of evidence that satisfies the rule. `null` for platform rules.
+            # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+            # `null` for platform rules. Fixed once the rule is created.
             module EvidenceType
               extend Openlayer::Internal::Type::Enum
 
@@ -660,11 +681,13 @@ module Openlayer
                   )
                 end
 
-              # Whether this result is excluded from compliance calculations.
+              # Whether this result is excluded from compliance calculations. Excludes just this
+              # result, without deactivating the rule everywhere.
               sig { returns(T::Boolean) }
               attr_accessor :deactivated
 
-              # The compliance status of the rule for this entity.
+              # The compliance status of the rule for this entity. Computed by Openlayer and
+              # can't be set directly.
               sig do
                 returns(
                   Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
@@ -720,7 +743,7 @@ module Openlayer
               end
               attr_writer :blocking
 
-              # Why the result was excluded.
+              # Why the result was excluded. Required when setting `deactivated` to `true`.
               sig { returns(T.nilable(String)) }
               attr_accessor :deactivated_reason
 
@@ -768,6 +791,8 @@ module Openlayer
               sig { returns(T.nilable(String)) }
               attr_accessor :project_id
 
+              # The compliance status of one rule for one entity: a project for project-scoped
+              # rules, or the workspace for workspace-scoped rules.
               sig do
                 params(
                   id: String,
@@ -803,11 +828,13 @@ module Openlayer
                 date_created:,
                 # The last update date.
                 date_updated:,
-                # Whether this result is excluded from compliance calculations.
+                # Whether this result is excluded from compliance calculations. Excludes just this
+                # result, without deactivating the rule everywhere.
                 deactivated:,
                 # The rule this result belongs to.
                 rule_id:,
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 status:,
                 # The id of the workspace the rule result belongs to.
                 workspace_id:,
@@ -825,7 +852,7 @@ module Openlayer
                 date_of_next_evaluation: nil,
                 # When the evidence must be renewed. Evidence rules with a renewal cadence only.
                 date_of_renewal: nil,
-                # Why the result was excluded.
+                # Why the result was excluded. Required when setting `deactivated` to `true`.
                 deactivated_reason: nil,
                 # The project this result was evaluated for. `null` for workspace-scoped rules.
                 project_id: nil,
@@ -867,7 +894,8 @@ module Openlayer
               def to_hash
               end
 
-              # The compliance status of the rule for this entity.
+              # The compliance status of the rule for this entity. Computed by Openlayer and
+              # can't be set directly.
               module Status
                 extend Openlayer::Internal::Type::Enum
 
@@ -942,7 +970,8 @@ module Openlayer
                 sig { params(id: String).void }
                 attr_writer :id
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 sig do
                   returns(
                     T.nilable(
@@ -969,7 +998,8 @@ module Openlayer
                 end
                 def self.new(
                   id: nil,
-                  # The compliance status of the rule for this entity.
+                  # The compliance status of the rule for this entity. Computed by Openlayer and
+                  # can't be set directly.
                   status: nil
                 )
                 end
@@ -986,7 +1016,8 @@ module Openlayer
                 def to_hash
                 end
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 module Status
                   extend Openlayer::Internal::Type::Enum
 
@@ -1062,7 +1093,8 @@ module Openlayer
                 sig { params(id: String).void }
                 attr_writer :id
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 sig do
                   returns(
                     T.nilable(
@@ -1089,7 +1121,8 @@ module Openlayer
                 end
                 def self.new(
                   id: nil,
-                  # The compliance status of the rule for this entity.
+                  # The compliance status of the rule for this entity. Computed by Openlayer and
+                  # can't be set directly.
                   status: nil
                 )
                 end
@@ -1106,7 +1139,8 @@ module Openlayer
                 def to_hash
                 end
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 module Status
                   extend Openlayer::Internal::Type::Enum
 
@@ -1237,7 +1271,7 @@ module Openlayer
               sig { returns(Time) }
               attr_accessor :date_updated
 
-              # Whether the tag is managed by Openlayer and cannot be edited or deleted.
+              # Whether the tag is managed by Openlayer. These tags can't be deleted.
               sig { returns(T::Boolean) }
               attr_accessor :immutable
 
@@ -1245,6 +1279,8 @@ module Openlayer
               sig { returns(String) }
               attr_accessor :workspace_id
 
+              # A label that groups rules across frameworks, for example by team or control
+              # family.
               sig do
                 params(
                   id: String,
@@ -1266,7 +1302,7 @@ module Openlayer
                 date_created:,
                 # The last update date.
                 date_updated:,
-                # Whether the tag is managed by Openlayer and cannot be edited or deleted.
+                # Whether the tag is managed by Openlayer. These tags can't be deleted.
                 immutable:,
                 # The tag name.
                 name:,

data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_response.rbi

@@ -60,7 +60,8 @@ module Openlayer
             attr_accessor :name
 
             # Whether the rule is evaluated once for the whole workspace, or once per project
-            # the rule's frameworks apply to.
+            # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+            # the rule is created.
             sig do
               returns(
                 Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Scope::TaggedSymbol
@@ -69,7 +70,8 @@ module Openlayer
             attr_accessor :scope
 
             # `platform` rules are evaluated automatically from the state of your Openlayer
-            # workspace. `evidence` rules are satisfied by attaching evidence.
+            # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+            # rule is created.
             sig do
               returns(
                 Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Type::TaggedSymbol
@@ -81,13 +83,15 @@ module Openlayer
             sig { returns(T.nilable(String)) }
             attr_accessor :assignee_id
 
-            # Configuration for the platform check, when the automation takes parameters.
+            # Configuration for the platform check, when the automation takes parameters. Omit
+            # or `null` for evidence rules. Fixed once the rule is created.
             sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :automation_params
 
             # Which workspace signal a platform rule checks, for example
-            # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
-            # evidence rules.
+            # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
+            # platform rules; omit or `null` for evidence rules. Fixed once the rule is
+            # created.
             sig { returns(T.nilable(String)) }
             attr_accessor :automation_type
 
@@ -102,7 +106,8 @@ module Openlayer
             sig { returns(T.nilable(String)) }
             attr_accessor :description
 
-            # The kind of evidence that satisfies the rule. `null` for platform rules.
+            # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+            # `null` for platform rules. Fixed once the rule is created.
             sig do
               returns(
                 T.nilable(
@@ -113,7 +118,8 @@ module Openlayer
             attr_accessor :evidence_type
 
             # How often evidence must be renewed, in days. Once evidence is older than this,
-            # the rule result becomes `due_soon` and then `failing`.
+            # the rule result becomes `due_soon` and then `failing`. The window restarts
+            # whenever evidence is attached. Omit or `null` for platform rules.
             sig { returns(T.nilable(Integer)) }
             attr_accessor :renewal_cadence_days
 
@@ -155,7 +161,8 @@ module Openlayer
             end
             attr_writer :frameworks
 
-            # Whether the rule is managed by Openlayer and cannot be edited.
+            # Whether the rule is managed by Openlayer. These rules can't be renamed or
+            # deleted; set `deactivated` to exclude one from compliance instead.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :immutable
 
@@ -218,6 +225,10 @@ module Openlayer
             end
             attr_accessor :tags
 
+            # A single requirement Openlayer tracks. `platform` rules are evaluated
+            # automatically from the state of your workspace, and `evidence` rules are
+            # satisfied by attaching evidence. A rule can belong to several frameworks, or to
+            # none.
             sig do
               params(
                 id: String,
@@ -270,33 +281,40 @@ module Openlayer
               # The rule name.
               name:,
               # Whether the rule is evaluated once for the whole workspace, or once per project
-              # the rule's frameworks apply to.
+              # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+              # the rule is created.
               scope:,
               # `platform` rules are evaluated automatically from the state of your Openlayer
-              # workspace. `evidence` rules are satisfied by attaching evidence.
+              # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+              # rule is created.
               type:,
               # The id of the workspace the rule belongs to.
               workspace_id:,
               # The user responsible for satisfying the rule.
               assignee_id: nil,
-              # Configuration for the platform check, when the automation takes parameters.
+              # Configuration for the platform check, when the automation takes parameters. Omit
+              # or `null` for evidence rules. Fixed once the rule is created.
               automation_params: nil,
               # Which workspace signal a platform rule checks, for example
-              # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
-              # evidence rules.
+              # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
+              # platform rules; omit or `null` for evidence rules. Fixed once the rule is
+              # created.
               automation_type: nil,
               # Whether the rule is excluded from compliance calculations.
               deactivated: nil,
               # What the rule requires.
               description: nil,
-              # The kind of evidence that satisfies the rule. `null` for platform rules.
+              # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+              # `null` for platform rules. Fixed once the rule is created.
               evidence_type: nil,
               # The frameworks that include this rule.
               frameworks: nil,
-              # Whether the rule is managed by Openlayer and cannot be edited.
+              # Whether the rule is managed by Openlayer. These rules can't be renamed or
+              # deleted; set `deactivated` to exclude one from compliance instead.
               immutable: nil,
               # How often evidence must be renewed, in days. Once evidence is older than this,
-              # the rule result becomes `due_soon` and then `failing`.
+              # the rule result becomes `due_soon` and then `failing`. The window restarts
+              # whenever evidence is attached. Omit or `null` for platform rules.
               renewal_cadence_days: nil,
               # The rule's results, one per entity the rule is evaluated against. Only returned
               # when `includeResults` is `true`.
@@ -358,7 +376,8 @@ module Openlayer
             end
 
             # Whether the rule is evaluated once for the whole workspace, or once per project
-            # the rule's frameworks apply to.
+            # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+            # the rule is created.
             module Scope
               extend Openlayer::Internal::Type::Enum
 
@@ -394,7 +413,8 @@ module Openlayer
             end
 
             # `platform` rules are evaluated automatically from the state of your Openlayer
-            # workspace. `evidence` rules are satisfied by attaching evidence.
+            # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+            # rule is created.
             module Type
               extend Openlayer::Internal::Type::Enum
 
@@ -429,7 +449,8 @@ module Openlayer
               end
             end
 
-            # The kind of evidence that satisfies the rule. `null` for platform rules.
+            # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+            # `null` for platform rules. Fixed once the rule is created.
             module EvidenceType
               extend Openlayer::Internal::Type::Enum
 
@@ -660,11 +681,13 @@ module Openlayer
                   )
                 end
 
-              # Whether this result is excluded from compliance calculations.
+              # Whether this result is excluded from compliance calculations. Excludes just this
+              # result, without deactivating the rule everywhere.
               sig { returns(T::Boolean) }
               attr_accessor :deactivated
 
-              # The compliance status of the rule for this entity.
+              # The compliance status of the rule for this entity. Computed by Openlayer and
+              # can't be set directly.
               sig do
                 returns(
                   Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Status::TaggedSymbol
@@ -720,7 +743,7 @@ module Openlayer
               end
               attr_writer :blocking
 
-              # Why the result was excluded.
+              # Why the result was excluded. Required when setting `deactivated` to `true`.
               sig { returns(T.nilable(String)) }
               attr_accessor :deactivated_reason
 
@@ -768,6 +791,8 @@ module Openlayer
               sig { returns(T.nilable(String)) }
               attr_accessor :project_id
 
+              # The compliance status of one rule for one entity: a project for project-scoped
+              # rules, or the workspace for workspace-scoped rules.
               sig do
                 params(
                   id: String,
@@ -803,11 +828,13 @@ module Openlayer
                 date_created:,
                 # The last update date.
                 date_updated:,
-                # Whether this result is excluded from compliance calculations.
+                # Whether this result is excluded from compliance calculations. Excludes just this
+                # result, without deactivating the rule everywhere.
                 deactivated:,
                 # The rule this result belongs to.
                 rule_id:,
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 status:,
                 # The id of the workspace the rule result belongs to.
                 workspace_id:,
@@ -825,7 +852,7 @@ module Openlayer
                 date_of_next_evaluation: nil,
                 # When the evidence must be renewed. Evidence rules with a renewal cadence only.
                 date_of_renewal: nil,
-                # Why the result was excluded.
+                # Why the result was excluded. Required when setting `deactivated` to `true`.
                 deactivated_reason: nil,
                 # The project this result was evaluated for. `null` for workspace-scoped rules.
                 project_id: nil,
@@ -867,7 +894,8 @@ module Openlayer
               def to_hash
               end
 
-              # The compliance status of the rule for this entity.
+              # The compliance status of the rule for this entity. Computed by Openlayer and
+              # can't be set directly.
               module Status
                 extend Openlayer::Internal::Type::Enum
 
@@ -942,7 +970,8 @@ module Openlayer
                 sig { params(id: String).void }
                 attr_writer :id
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 sig do
                   returns(
                     T.nilable(
@@ -969,7 +998,8 @@ module Openlayer
                 end
                 def self.new(
                   id: nil,
-                  # The compliance status of the rule for this entity.
+                  # The compliance status of the rule for this entity. Computed by Openlayer and
+                  # can't be set directly.
                   status: nil
                 )
                 end
@@ -986,7 +1016,8 @@ module Openlayer
                 def to_hash
                 end
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 module Status
                   extend Openlayer::Internal::Type::Enum
 
@@ -1062,7 +1093,8 @@ module Openlayer
                 sig { params(id: String).void }
                 attr_writer :id
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 sig do
                   returns(
                     T.nilable(
@@ -1089,7 +1121,8 @@ module Openlayer
                 end
                 def self.new(
                   id: nil,
-                  # The compliance status of the rule for this entity.
+                  # The compliance status of the rule for this entity. Computed by Openlayer and
+                  # can't be set directly.
                   status: nil
                 )
                 end
@@ -1106,7 +1139,8 @@ module Openlayer
                 def to_hash
                 end
 
-                # The compliance status of the rule for this entity.
+                # The compliance status of the rule for this entity. Computed by Openlayer and
+                # can't be set directly.
                 module Status
                   extend Openlayer::Internal::Type::Enum
 
@@ -1237,7 +1271,7 @@ module Openlayer
               sig { returns(Time) }
               attr_accessor :date_updated
 
-              # Whether the tag is managed by Openlayer and cannot be edited or deleted.
+              # Whether the tag is managed by Openlayer. These tags can't be deleted.
               sig { returns(T::Boolean) }
               attr_accessor :immutable
 
@@ -1245,6 +1279,8 @@ module Openlayer
               sig { returns(String) }
               attr_accessor :workspace_id
 
+              # A label that groups rules across frameworks, for example by team or control
+              # family.
               sig do
                 params(
                   id: String,
@@ -1266,7 +1302,7 @@ module Openlayer
                 date_created:,
                 # The last update date.
                 date_updated:,
-                # Whether the tag is managed by Openlayer and cannot be edited or deleted.
+                # Whether the tag is managed by Openlayer. These tags can't be deleted.
                 immutable:,
                 # The tag name.
                 name:,