openlayer 0.16.0 → 0.17.0

data/lib/openlayer/resources/workspaces/invites.rb

@@ -30,7 +30,7 @@ module Openlayer
           )
         end
 
-        # Retrieve a list of invites in a workspace.
+        # List the invites in a workspace.
         #
         # @overload list(workspace_id, page: nil, per_page: nil, request_options: {})
         #

data/lib/openlayer/resources/workspaces.rb

@@ -9,7 +9,7 @@ module Openlayer
       # @return [Openlayer::Resources::Workspaces::APIKeys]
       attr_reader :api_keys
 
-      # Retrieve a workspace by its ID.
+      # Retrieve a workspace.
       #
       # @overload retrieve(workspace_id, request_options: {})
       #

data/lib/openlayer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openlayer
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/lib/openlayer.rb

@@ -158,6 +158,15 @@ require_relative "openlayer/models/workspace_retrieve_params"
 require_relative "openlayer/models/workspace_retrieve_response"
 require_relative "openlayer/models/workspaces/api_key_create_params"
 require_relative "openlayer/models/workspaces/api_key_create_response"
+require_relative "openlayer/models/workspaces/api_key_delete_params"
+require_relative "openlayer/models/workspaces/api_key_list_params"
+require_relative "openlayer/models/workspaces/api_key_list_response"
+require_relative "openlayer/models/workspaces/api_key_retrieve_params"
+require_relative "openlayer/models/workspaces/api_key_retrieve_response"
+require_relative "openlayer/models/workspaces/api_key_rotate_params"
+require_relative "openlayer/models/workspaces/api_key_rotate_response"
+require_relative "openlayer/models/workspaces/api_key_update_params"
+require_relative "openlayer/models/workspaces/api_key_update_response"
 require_relative "openlayer/models/workspaces/invite_create_params"
 require_relative "openlayer/models/workspaces/invite_create_response"
 require_relative "openlayer/models/workspaces/invite_list_params"

data/rbi/openlayer/models/background_task_retrieve_response.rbi

@@ -46,6 +46,9 @@ module Openlayer
       sig { returns(String) }
       attr_accessor :name
 
+      # A job queued by an endpoint that can't answer within one request, such as a
+      # framework export. Poll it until `complete` is `true`, then read what it produced
+      # from `outputs`.
       sig do
         params(
           id: String,

data/rbi/openlayer/models/governance/framework_create_response.rbi

@@ -104,7 +104,8 @@ module Openlayer
         sig { returns(T.nilable(String)) }
         attr_accessor :creator_id
 
-        # Whether the framework definition is managed by Openlayer and cannot be edited.
+        # Whether the framework definition is managed by Openlayer. For these frameworks
+        # only `enabled`, `tags`, and `projectSelector` can be changed.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :immutable
 
@@ -131,6 +132,9 @@ module Openlayer
         end
         attr_writer :rule_stats
 
+        # A set of rules, drawn from a regulation, a standard, or your own internal
+        # policy, that Openlayer tracks compliance against. Openlayer ships built-in
+        # frameworks, and you can create your own.
         sig do
           params(
             id: String,
@@ -188,7 +192,8 @@ module Openlayer
           extended_description: nil,
           # A link to the external standard or regulation the framework is based on.
           href: nil,
-          # Whether the framework definition is managed by Openlayer and cannot be edited.
+          # Whether the framework definition is managed by Openlayer. For these frameworks
+          # only `enabled`, `tags`, and `projectSelector` can be changed.
           immutable: nil,
           # Determines which projects the framework applies to. An empty or `null` `match`
           # array applies the framework to every project in the workspace.

data/rbi/openlayer/models/governance/framework_export_params.rbi

@@ -18,7 +18,9 @@ module Openlayer
         sig { returns(String) }
         attr_accessor :framework_id
 
-        # Scope the export to this project. It must belong to the framework.
+        # Scope the export to this project. It must belong to the framework. Omit it for
+        # the workspace-wide view across every project in the framework, including
+        # workspace-scoped rules.
         sig { returns(T.nilable(String)) }
         attr_accessor :project_id
 
@@ -31,7 +33,9 @@ module Openlayer
         end
         def self.new(
           framework_id:,
-          # Scope the export to this project. It must belong to the framework.
+          # Scope the export to this project. It must belong to the framework. Omit it for
+          # the workspace-wide view across every project in the framework, including
+          # workspace-scoped rules.
           project_id: nil,
           request_options: {}
         )

data/rbi/openlayer/models/governance/framework_list_project_rule_stats_response.rbi

@@ -116,6 +116,7 @@ module Openlayer
           end
           attr_writer :by_rule_type
 
+          # One project's rule result counts by status, for a single framework.
           sig do
             params(
               project_id: String,

data/rbi/openlayer/models/governance/framework_list_response.rbi

@@ -144,7 +144,8 @@ module Openlayer
           sig { returns(T.nilable(String)) }
           attr_accessor :creator_id
 
-          # Whether the framework definition is managed by Openlayer and cannot be edited.
+          # Whether the framework definition is managed by Openlayer. For these frameworks
+          # only `enabled`, `tags`, and `projectSelector` can be changed.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :immutable
 
@@ -171,6 +172,9 @@ module Openlayer
           end
           attr_writer :rule_stats
 
+          # A set of rules, drawn from a regulation, a standard, or your own internal
+          # policy, that Openlayer tracks compliance against. Openlayer ships built-in
+          # frameworks, and you can create your own.
           sig do
             params(
               id: String,
@@ -228,7 +232,8 @@ module Openlayer
             extended_description: nil,
             # A link to the external standard or regulation the framework is based on.
             href: nil,
-            # Whether the framework definition is managed by Openlayer and cannot be edited.
+            # Whether the framework definition is managed by Openlayer. For these frameworks
+            # only `enabled`, `tags`, and `projectSelector` can be changed.
             immutable: nil,
             # Determines which projects the framework applies to. An empty or `null` `match`
             # array applies the framework to every project in the workspace.

data/rbi/openlayer/models/governance/framework_list_rules_response.rbi

@@ -59,7 +59,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::FrameworkListRulesResponse::Item::Scope::TaggedSymbol
@@ -68,7 +69,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::FrameworkListRulesResponse::Item::Type::TaggedSymbol
@@ -80,13 +82,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
 
@@ -101,7 +105,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(
@@ -112,7 +117,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
 
@@ -154,7 +160,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
 
@@ -217,6 +224,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,
@@ -269,33 +280,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`.
@@ -357,7 +375,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
 
@@ -393,7 +412,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
 
@@ -428,7 +448,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
 
@@ -659,11 +680,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::FrameworkListRulesResponse::Item::Result::Status::TaggedSymbol
@@ -719,7 +742,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
 
@@ -767,6 +790,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,
@@ -802,11 +827,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:,
@@ -824,7 +851,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,
@@ -866,7 +893,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
 
@@ -941,7 +969,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(
@@ -968,7 +997,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
@@ -985,7 +1015,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
 
@@ -1061,7 +1092,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(
@@ -1088,7 +1120,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
@@ -1105,7 +1138,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
 
@@ -1234,7 +1268,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
 
@@ -1242,6 +1276,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,
@@ -1263,7 +1299,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/framework_retrieve_response.rbi

@@ -104,7 +104,8 @@ module Openlayer
         sig { returns(T.nilable(String)) }
         attr_accessor :creator_id
 
-        # Whether the framework definition is managed by Openlayer and cannot be edited.
+        # Whether the framework definition is managed by Openlayer. For these frameworks
+        # only `enabled`, `tags`, and `projectSelector` can be changed.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :immutable
 
@@ -131,6 +132,9 @@ module Openlayer
         end
         attr_writer :rule_stats
 
+        # A set of rules, drawn from a regulation, a standard, or your own internal
+        # policy, that Openlayer tracks compliance against. Openlayer ships built-in
+        # frameworks, and you can create your own.
         sig do
           params(
             id: String,
@@ -188,7 +192,8 @@ module Openlayer
           extended_description: nil,
           # A link to the external standard or regulation the framework is based on.
           href: nil,
-          # Whether the framework definition is managed by Openlayer and cannot be edited.
+          # Whether the framework definition is managed by Openlayer. For these frameworks
+          # only `enabled`, `tags`, and `projectSelector` can be changed.
           immutable: nil,
           # Determines which projects the framework applies to. An empty or `null` `match`
           # array applies the framework to every project in the workspace.

data/rbi/openlayer/models/governance/framework_update_response.rbi

@@ -104,7 +104,8 @@ module Openlayer
         sig { returns(T.nilable(String)) }
         attr_accessor :creator_id
 
-        # Whether the framework definition is managed by Openlayer and cannot be edited.
+        # Whether the framework definition is managed by Openlayer. For these frameworks
+        # only `enabled`, `tags`, and `projectSelector` can be changed.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :immutable
 
@@ -131,6 +132,9 @@ module Openlayer
         end
         attr_writer :rule_stats
 
+        # A set of rules, drawn from a regulation, a standard, or your own internal
+        # policy, that Openlayer tracks compliance against. Openlayer ships built-in
+        # frameworks, and you can create your own.
         sig do
           params(
             id: String,
@@ -188,7 +192,8 @@ module Openlayer
           extended_description: nil,
           # A link to the external standard or regulation the framework is based on.
           href: nil,
-          # Whether the framework definition is managed by Openlayer and cannot be edited.
+          # Whether the framework definition is managed by Openlayer. For these frameworks
+          # only `enabled`, `tags`, and `projectSelector` can be changed.
           immutable: nil,
           # Determines which projects the framework applies to. An empty or `null` `match`
           # array applies the framework to every project in the workspace.