openlayer 0.16.0 → 0.17.0

data/rbi/openlayer/models/governance/rule_list_response.rbi

@@ -55,7 +55,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::RuleListResponse::Item::Scope::TaggedSymbol
@@ -64,7 +65,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::RuleListResponse::Item::Type::TaggedSymbol
@@ -76,13 +78,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
 
@@ -97,7 +101,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(
@@ -108,7 +113,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
 
@@ -150,7 +156,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
 
@@ -213,6 +220,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,
@@ -265,33 +276,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`.
@@ -353,7 +371,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
 
@@ -389,7 +408,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
 
@@ -424,7 +444,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
 
@@ -655,11 +676,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::RuleListResponse::Item::Result::Status::TaggedSymbol
@@ -715,7 +738,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
 
@@ -763,6 +786,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,
@@ -798,11 +823,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:,
@@ -820,7 +847,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,
@@ -862,7 +889,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
 
@@ -937,7 +965,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(
@@ -964,7 +993,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
@@ -981,7 +1011,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
 
@@ -1057,7 +1088,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(
@@ -1084,7 +1116,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
@@ -1101,7 +1134,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
 
@@ -1230,7 +1264,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
 
@@ -1238,6 +1272,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,
@@ -1259,7 +1295,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/rule_result_create_evidence_params.rbi

@@ -27,7 +27,8 @@ module Openlayer
         attr_accessor :name
 
         # Where the uploaded file is stored. Set when the rule's `evidenceType` is
-        # `document`.
+        # `document`. Upload the file first with `POST /storage/presigned-url` and send
+        # the storage URI it returns.
         sig { returns(T.nilable(String)) }
         attr_accessor :storage_uri
 
@@ -57,7 +58,8 @@ module Openlayer
           # The evidence name.
           name: nil,
           # Where the uploaded file is stored. Set when the rule's `evidenceType` is
-          # `document`.
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
           storage_uri: nil,
           # The evidence text. Set when the rule's `evidenceType` is `text`.
           text: nil,

data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi

@@ -21,7 +21,8 @@ module Openlayer
         attr_accessor :name
 
         # Where the uploaded file is stored. Set when the rule's `evidenceType` is
-        # `document`.
+        # `document`. Upload the file first with `POST /storage/presigned-url` and send
+        # the storage URI it returns.
         sig { returns(T.nilable(String)) }
         attr_accessor :storage_uri
 
@@ -49,6 +50,9 @@ module Openlayer
         sig { returns(Time) }
         attr_accessor :date_updated
 
+        # Evidence attached to a rule result to satisfy an evidence rule. Which field
+        # holds it depends on the rule's `evidenceType`: `storageUri` for a document,
+        # `text` for a written statement, or `url` for a link.
         sig do
           params(
             id: String,
@@ -76,7 +80,8 @@ module Openlayer
           # The evidence name.
           name: nil,
           # Where the uploaded file is stored. Set when the rule's `evidenceType` is
-          # `document`.
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
           storage_uri: nil,
           # The evidence text. Set when the rule's `evidenceType` is `text`.
           text: nil,

data/rbi/openlayer/models/governance/rule_result_list_evidence_response.rbi

@@ -63,7 +63,8 @@ module Openlayer
           attr_accessor :name
 
           # Where the uploaded file is stored. Set when the rule's `evidenceType` is
-          # `document`.
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
           sig { returns(T.nilable(String)) }
           attr_accessor :storage_uri
 
@@ -91,6 +92,9 @@ module Openlayer
           sig { returns(Time) }
           attr_accessor :date_updated
 
+          # Evidence attached to a rule result to satisfy an evidence rule. Which field
+          # holds it depends on the rule's `evidenceType`: `storageUri` for a document,
+          # `text` for a written statement, or `url` for a link.
           sig do
             params(
               id: String,
@@ -118,7 +122,8 @@ module Openlayer
             # The evidence name.
             name: nil,
             # Where the uploaded file is stored. Set when the rule's `evidenceType` is
-            # `document`.
+            # `document`. Upload the file first with `POST /storage/presigned-url` and send
+            # the storage URI it returns.
             storage_uri: nil,
             # The evidence text. Set when the rule's `evidenceType` is `text`.
             text: nil,

data/rbi/openlayer/models/governance/rule_result_list_response.rbi

@@ -54,11 +54,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::RuleResultListResponse::Item::Status::TaggedSymbol
@@ -114,7 +116,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
 
@@ -162,6 +164,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,
@@ -197,11 +201,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:,
@@ -219,7 +225,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,
@@ -261,7 +267,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
 
@@ -336,7 +343,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(
@@ -363,7 +371,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
@@ -380,7 +389,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
 
@@ -456,7 +466,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(
@@ -483,7 +494,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
@@ -500,7 +512,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
 

data/rbi/openlayer/models/governance/rule_result_retrieve_response.rbi

@@ -12,11 +12,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::RuleResultRetrieveResponse::Status::TaggedSymbol
@@ -72,7 +74,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
 
@@ -120,6 +122,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,
@@ -155,11 +159,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:,
@@ -177,7 +183,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,
@@ -219,7 +225,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
 
@@ -294,7 +301,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(
@@ -321,7 +329,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
@@ -338,7 +347,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
 
@@ -414,7 +424,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(
@@ -441,7 +452,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
@@ -458,7 +470,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