openlayer 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0933f3fa1e05be26e6dcc831a8facff8bfa464bda977ceebf98b4b169fe1a62f'
-  data.tar.gz: 190e3cfd879021c37d835aab1448a24492088858c30d897cae7d0952af9c69e1
+  metadata.gz: 2ac438403047aa9c292d52d027dc66f0ca9009a4e74ebaf3abbb2db1963a5a8b
+  data.tar.gz: f530da24caa96bd4f1beb2408287e8aa5166420fea825ded92fe154eaf966cf1
 SHA512:
-  metadata.gz: 9e99803e0f0670f51ac111ccea8ae4ef6bd00b023d67627533c6ac3c617de58040fc94555849181e626cb0cc563408128a4ef98c0df42e11053b0ecb9340845d
-  data.tar.gz: 956452b2ecdf1ffc9afca07ca8d6ae30f7a87f125b9c19bcf370e83722f4a3ceb6d8e913e00334e23440cd277b5e5b075f8e53f6283df7a9505b417399c7eee5
+  metadata.gz: 3876dfc88d12ed40790acc2791f941892ace0daff2f80882006135e3cf2825b61fceae3ddf1add5b7a33b9dd6b38c5fef1dc4ad5245c75a06299633582a8afde
+  data.tar.gz: 5ed411de93e33097db1e41e0949372407543c705e2bf8654c98778f5c3ea8fe65051301f86e05918b520c7b743452cea9e5935a8146960312a39e334078e504f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.17.0](https://github.com/openlayer-ai/openlayer-ruby/compare/v0.16.0...v0.17.0) (2026-09-29)
+
+
+### Features
+
+* **api:** add API key CRUD, expiry, and rotation ([9ab4992](https://github.com/openlayer-ai/openlayer-ruby/commit/9ab4992fe14b456c70122b9f66c8b86679634122))
+* **api:** add API key CRUD, expiry, and rotation ([17edb02](https://github.com/openlayer-ai/openlayer-ruby/commit/17edb02ed93a58b224a2e5553992e9d090f6734a))
+
+
+### Chores
+
+* **stlc:** seal custom-code tracking files ([caa6cfb](https://github.com/openlayer-ai/openlayer-ruby/commit/caa6cfbef8534d5dc57e89b2d96815b52ab750c0))
+* **stlc:** seal custom-code tracking files ([47a9897](https://github.com/openlayer-ai/openlayer-ruby/commit/47a9897f0d4d0ff8465f3a30fe2bce7ddfe6b390))
+
 ## [0.16.0](https://github.com/openlayer-ai/openlayer-ruby/compare/v0.15.0...v0.16.0) (2026-09-21)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openlayer", "~> 0.16.0"
+gem "openlayer", "~> 0.17.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openlayer/models/background_task_retrieve_response.rb

@@ -61,6 +61,10 @@ module Openlayer
       #   Some parameter documentations has been truncated, see
       #   {Openlayer::Models::BackgroundTaskRetrieveResponse} for more details.
       #
+      #   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`.
+      #
       #   @param id [String] The background task id.
       #
       #   @param complete [Boolean] Whether the task has finished. Check this before reading `outputs`.

data/lib/openlayer/models/governance/framework_create_response.rb

@@ -101,7 +101,8 @@ module Openlayer
           optional :creator_id, String, api_name: :creatorId, nil?: true
 
           # @!attribute immutable
-          #   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.
           #
           #   @return [Boolean, nil]
           optional :immutable, Openlayer::Internal::Type::Boolean
@@ -121,6 +122,10 @@ module Openlayer
         #   Some parameter documentations has been truncated, see
         #   {Openlayer::Models::Governance::FrameworkCreateResponse} for more details.
         #
+        #   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.
+        #
         #   @param id [String] The framework id.
         #
         #   @param date_created [Time] The creation date.
@@ -148,7 +153,7 @@ module Openlayer
         #
         #   @param href [String, nil] A link to the external standard or regulation the framework is based on.
         #
-        #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer and cannot be edited.
+        #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer. For these frameworks o
         #
         #   @param project_selector [Openlayer::Models::Governance::FrameworkCreateResponse::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
         #

data/lib/openlayer/models/governance/framework_export_params.rb

@@ -14,15 +14,20 @@ module Openlayer
         required :framework_id, String
 
         # @!attribute project_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.
         #
         #   @return [String, nil]
         optional :project_id, String, api_name: :projectId, nil?: true
 
         # @!method initialize(framework_id:, project_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Openlayer::Models::Governance::FrameworkExportParams} for more details.
+        #
         #   @param framework_id [String]
         #
-        #   @param project_id [String, nil] Scope the export to this project. It must belong to the framework.
+        #   @param project_id [String, nil] Scope the export to this project. It must belong to the framework. Omit it for t
         #
         #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb

@@ -90,6 +90,8 @@ module Openlayer
                    api_name: :byRuleType
 
           # @!method initialize(project_id:, project_name:, task_type:, total:, total_due_soon:, total_error:, total_failing:, total_passing:, total_pending:, total_running:, total_skipped:, by_rule_type: nil)
+          #   One project's rule result counts by status, for a single framework.
+          #
           #   @param project_id [String] The project id.
           #
           #   @param project_name [String] The project name.

data/lib/openlayer/models/governance/framework_list_response.rb

@@ -111,7 +111,8 @@ module Openlayer
             optional :creator_id, String, api_name: :creatorId, nil?: true
 
             # @!attribute immutable
-            #   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.
             #
             #   @return [Boolean, nil]
             optional :immutable, Openlayer::Internal::Type::Boolean
@@ -131,6 +132,10 @@ module Openlayer
           #   Some parameter documentations has been truncated, see
           #   {Openlayer::Models::Governance::FrameworkListResponse::Item} for more details.
           #
+          #   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.
+          #
           #   @param id [String] The framework id.
           #
           #   @param date_created [Time] The creation date.
@@ -158,7 +163,7 @@ module Openlayer
           #
           #   @param href [String, nil] A link to the external standard or regulation the framework is based on.
           #
-          #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer and cannot be edited.
+          #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer. For these frameworks o
           #
           #   @param project_selector [Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
           #

data/lib/openlayer/models/governance/framework_list_rules_response.rb

@@ -23,14 +23,16 @@ module Openlayer
 
           # @!attribute scope
           #   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.
           #
           #   @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Scope]
           required :scope, enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Scope }
 
           # @!attribute type
           #   `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.
           #
           #   @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Type]
           required :type, enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Type }
@@ -42,7 +44,8 @@ module Openlayer
           optional :assignee_id, String, api_name: :assigneeId, nil?: true
 
           # @!attribute automation_params
-          #   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.
           #
           #   @return [Hash{Symbol=>Object}, nil]
           optional :automation_params,
@@ -52,8 +55,9 @@ module Openlayer
 
           # @!attribute automation_type
           #   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.
           #
           #   @return [String, nil]
           optional :automation_type, String, api_name: :automationType, nil?: true
@@ -71,7 +75,8 @@ module Openlayer
           optional :description, String, nil?: true
 
           # @!attribute evidence_type
-          #   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.
           #
           #   @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::EvidenceType, nil]
           optional :evidence_type,
@@ -81,7 +86,8 @@ module Openlayer
 
           # @!attribute renewal_cadence_days
           #   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.
           #
           #   @return [Integer, nil]
           optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true
@@ -119,7 +125,8 @@ module Openlayer
                      -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework] }
 
             # @!attribute immutable
-            #   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.
             #
             #   @return [Boolean, nil]
             optional :immutable, Openlayer::Internal::Type::Boolean
@@ -156,6 +163,11 @@ module Openlayer
           #   {Openlayer::Models::Governance::FrameworkListRulesResponse::Item} for more
           #   details.
           #
+          #   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.
+          #
           #   @param id [String] The rule id.
           #
           #   @param date_created [Time] The creation date.
@@ -172,7 +184,7 @@ module Openlayer
           #
           #   @param assignee_id [String, nil] The user responsible for satisfying the rule.
           #
-          #   @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters.
+          #   @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters. Omit
           #
           #   @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
           #
@@ -180,11 +192,11 @@ module Openlayer
           #
           #   @param description [String, nil] What the rule requires.
           #
-          #   @param evidence_type [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::EvidenceType, nil] The kind of evidence that satisfies the rule. `null` for platform rules.
+          #   @param evidence_type [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::EvidenceType, nil] The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
           #
           #   @param frameworks [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework>] The frameworks that include this rule.
           #
-          #   @param immutable [Boolean] Whether the rule is managed by Openlayer and cannot be edited.
+          #   @param immutable [Boolean] Whether the rule is managed by Openlayer. These rules can't be renamed or delete
           #
           #   @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
           #
@@ -195,7 +207,8 @@ module Openlayer
           #   @param tags [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Tag>, nil] The rule tags associated with the rule.
 
           # 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.
           #
           # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#scope
           module Scope
@@ -209,7 +222,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.
           #
           # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#type
           module Type
@@ -222,7 +236,8 @@ module Openlayer
             #   @return [Array<Symbol>]
           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.
           #
           # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#evidence_type
           module EvidenceType
@@ -326,13 +341,15 @@ module Openlayer
 
           class Result < Openlayer::Internal::Type::BaseModel
             # @!attribute deactivated
-            #   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.
             #
             #   @return [Boolean]
             required :deactivated, Openlayer::Internal::Type::Boolean
 
             # @!attribute status
-            #   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.
             #
             #   @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Status]
             required :status,
@@ -360,7 +377,7 @@ module Openlayer
                      -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking] }
 
             # @!attribute deactivated_reason
-            #   Why the result was excluded.
+            #   Why the result was excluded. Required when setting `deactivated` to `true`.
             #
             #   @return [String, nil]
             optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
@@ -434,17 +451,24 @@ module Openlayer
             end
 
             # @!method initialize(id:, date_created:, date_updated:, deactivated:, rule_id:, status:, workspace_id:, assignee_id: nil, blocked_by: nil, blocking: nil, date_last_evaluated: nil, date_of_latest_evidence: nil, date_of_next_evaluation: nil, date_of_renewal: nil, deactivated_reason: nil, project_id: nil, status_message: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result} for
+            #   more details.
+            #
+            #   The compliance status of one rule for one entity: a project for project-scoped
+            #   rules, or the workspace for workspace-scoped rules.
+            #
             #   @param id [String] The rule result id.
             #
             #   @param date_created [Time] The creation date.
             #
             #   @param date_updated [Time] The last update date.
             #
-            #   @param deactivated [Boolean] Whether this result is excluded from compliance calculations.
+            #   @param deactivated [Boolean] Whether this result is excluded from compliance calculations. Excludes just this
             #
             #   @param rule_id [String] The rule this result belongs to.
             #
-            #   @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Status] The compliance status of the rule for this entity.
+            #   @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
             #
             #   @param workspace_id [String] The id of the workspace the rule result belongs to.
             #
@@ -462,13 +486,14 @@ module Openlayer
             #
             #   @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
             #
-            #   @param deactivated_reason [String, nil] Why the result was excluded.
+            #   @param deactivated_reason [String, nil] Why the result was excluded. Required when setting `deactivated` to `true`.
             #
             #   @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
             #
             #   @param status_message [String, nil] A human-readable explanation of the status.
 
-            # 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.
             #
             # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result#status
             module Status
@@ -493,18 +518,24 @@ module Openlayer
               optional :id, String
 
               # @!attribute status
-              #   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.
               #
               #   @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status, nil]
               optional :status,
                        enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status }
 
               # @!method initialize(id: nil, status: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy}
+              #   for more details.
+              #
               #   @param id [String]
               #
-              #   @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status] The compliance status of the rule for this entity.
+              #   @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
 
-              # 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.
               #
               # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy#status
               module Status
@@ -530,18 +561,24 @@ module Openlayer
               optional :id, String
 
               # @!attribute status
-              #   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.
               #
               #   @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status, nil]
               optional :status,
                        enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status }
 
               # @!method initialize(id: nil, status: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking}
+              #   for more details.
+              #
               #   @param id [String]
               #
-              #   @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status] The compliance status of the rule for this entity.
+              #   @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
 
-              # 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.
               #
               # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking#status
               module Status
@@ -620,7 +657,7 @@ module Openlayer
               required :date_updated, Time, api_name: :dateUpdated
 
               # @!attribute immutable
-              #   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.
               #
               #   @return [Boolean]
               required :immutable, Openlayer::Internal::Type::Boolean
@@ -633,6 +670,9 @@ module Openlayer
             end
 
             # @!method initialize(id:, creator_id:, date_created:, date_updated:, immutable:, name:, workspace_id:, color: nil)
+            #   A label that groups rules across frameworks, for example by team or control
+            #   family.
+            #
             #   @param id [String] The rule tag id.
             #
             #   @param creator_id [String, nil] The user who created the tag. `null` for tags that ship with Openlayer.
@@ -641,7 +681,7 @@ module Openlayer
             #
             #   @param date_updated [Time] The last update date.
             #
-            #   @param immutable [Boolean] Whether the tag is managed by Openlayer and cannot be edited or deleted.
+            #   @param immutable [Boolean] Whether the tag is managed by Openlayer. These tags can't be deleted.
             #
             #   @param name [String] The tag name.
             #

data/lib/openlayer/models/governance/framework_retrieve_response.rb

@@ -101,7 +101,8 @@ module Openlayer
           optional :creator_id, String, api_name: :creatorId, nil?: true
 
           # @!attribute immutable
-          #   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.
           #
           #   @return [Boolean, nil]
           optional :immutable, Openlayer::Internal::Type::Boolean
@@ -121,6 +122,10 @@ module Openlayer
         #   Some parameter documentations has been truncated, see
         #   {Openlayer::Models::Governance::FrameworkRetrieveResponse} for more details.
         #
+        #   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.
+        #
         #   @param id [String] The framework id.
         #
         #   @param date_created [Time] The creation date.
@@ -148,7 +153,7 @@ module Openlayer
         #
         #   @param href [String, nil] A link to the external standard or regulation the framework is based on.
         #
-        #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer and cannot be edited.
+        #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer. For these frameworks o
         #
         #   @param project_selector [Openlayer::Models::Governance::FrameworkRetrieveResponse::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
         #

data/lib/openlayer/models/governance/framework_update_response.rb

@@ -101,7 +101,8 @@ module Openlayer
           optional :creator_id, String, api_name: :creatorId, nil?: true
 
           # @!attribute immutable
-          #   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.
           #
           #   @return [Boolean, nil]
           optional :immutable, Openlayer::Internal::Type::Boolean
@@ -121,6 +122,10 @@ module Openlayer
         #   Some parameter documentations has been truncated, see
         #   {Openlayer::Models::Governance::FrameworkUpdateResponse} for more details.
         #
+        #   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.
+        #
         #   @param id [String] The framework id.
         #
         #   @param date_created [Time] The creation date.
@@ -148,7 +153,7 @@ module Openlayer
         #
         #   @param href [String, nil] A link to the external standard or regulation the framework is based on.
         #
-        #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer and cannot be edited.
+        #   @param immutable [Boolean] Whether the framework definition is managed by Openlayer. For these frameworks o
         #
         #   @param project_selector [Openlayer::Models::Governance::FrameworkUpdateResponse::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
         #