openlayer 0.16.0 → 0.17.0

data/rbi/openlayer/models/governance/rule_update_response.rbi

@@ -17,7 +17,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::RuleUpdateResponse::Scope::TaggedSymbol
@@ -26,7 +27,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::RuleUpdateResponse::Type::TaggedSymbol
@@ -38,13 +40,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
 
@@ -59,7 +63,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(
@@ -70,7 +75,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
 
@@ -112,7 +118,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
 
@@ -173,6 +180,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,
@@ -225,33 +236,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`.
@@ -313,7 +331,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
 
@@ -349,7 +368,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
 
@@ -384,7 +404,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
 
@@ -615,11 +636,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::RuleUpdateResponse::Result::Status::TaggedSymbol
@@ -675,7 +698,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
 
@@ -723,6 +746,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,
@@ -758,11 +783,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:,
@@ -780,7 +807,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,
@@ -822,7 +849,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
 
@@ -897,7 +925,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(
@@ -924,7 +953,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
@@ -941,7 +971,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
 
@@ -1017,7 +1048,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(
@@ -1044,7 +1076,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
@@ -1061,7 +1094,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
 
@@ -1190,7 +1224,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
 
@@ -1198,6 +1232,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,
@@ -1219,7 +1255,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/inference_pipeline_retrieve_sessions_response.rbi

@@ -105,6 +105,8 @@ module Openlayer
         sig { returns(T::Array[String]) }
         attr_accessor :user_ids
 
+        # A session in an inference pipeline, with its activity stats: record counts,
+        # token usage, cost, latency, and its first and last records.
         sig do
           params(
             id: String,

data/rbi/openlayer/models/inference_pipeline_retrieve_users_response.rbi

@@ -85,6 +85,8 @@ module Openlayer
         sig { returns(Float) }
         attr_accessor :tokens
 
+        # A user who has interacted with an inference pipeline, with their activity stats:
+        # session and record counts, token usage, and cost.
         sig do
           params(
             id: String,

data/rbi/openlayer/models/storage/presigned_url_retrieve_params.rbi

@@ -15,7 +15,8 @@ module Openlayer
             )
           end
 
-        # The object's storage uri.
+        # The object's storage uri, for example `outputs.storageUri` from a framework
+        # export's background task.
         sig { returns(String) }
         attr_accessor :storage_uri
 
@@ -26,7 +27,8 @@ module Openlayer
           ).returns(T.attached_class)
         end
         def self.new(
-          # The object's storage uri.
+          # The object's storage uri, for example `outputs.storageUri` from a framework
+          # export's background task.
           storage_uri:,
           request_options: {}
         )

data/rbi/openlayer/models/workspaces/api_key_create_params.rbi

@@ -18,6 +18,15 @@ module Openlayer
         sig { returns(String) }
         attr_accessor :workspace_id
 
+        # When the key stops authenticating. `null` means the key never expires. Set when
+        # the key is created or rotated, and must be in the future. When the request is
+        # authenticated with an API key that expires, the result can't be later than that
+        # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+        # keep the current one. It can't be changed with an update; rotate the key
+        # instead.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
         # The API key name.
         sig { returns(T.nilable(String)) }
         attr_accessor :name
@@ -25,12 +34,20 @@ module Openlayer
         sig do
           params(
             workspace_id: String,
+            expires_at: T.nilable(Time),
             name: T.nilable(String),
             request_options: Openlayer::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           workspace_id:,
+          # When the key stops authenticating. `null` means the key never expires. Set when
+          # the key is created or rotated, and must be in the future. When the request is
+          # authenticated with an API key that expires, the result can't be later than that
+          # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+          # keep the current one. It can't be changed with an update; rotate the key
+          # instead.
+          expires_at: nil,
           # The API key name.
           name: nil,
           request_options: {}
@@ -41,6 +58,7 @@ module Openlayer
           override.returns(
             {
               workspace_id: String,
+              expires_at: T.nilable(Time),
               name: T.nilable(String),
               request_options: Openlayer::RequestOptions
             }

data/rbi/openlayer/models/workspaces/api_key_create_response.rbi

@@ -12,6 +12,15 @@ module Openlayer
             )
           end
 
+        # When the key stops authenticating. `null` means the key never expires. Set when
+        # the key is created or rotated, and must be in the future. When the request is
+        # authenticated with an API key that expires, the result can't be later than that
+        # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+        # keep the current one. It can't be changed with an update; rotate the key
+        # instead.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
         # The API key name.
         sig { returns(T.nilable(String)) }
         attr_accessor :name
@@ -32,10 +41,38 @@ module Openlayer
         sig { returns(Time) }
         attr_accessor :date_updated
 
-        # The API key value.
+        # An obfuscated hint of the API key value. When a key is created or rotated this
+        # also holds the full secret, for backward compatibility; prefer `secret`.
         sig { returns(String) }
         attr_accessor :secure_key
 
+        # The key's lifecycle state. `active`: the current secret authenticates.
+        # `rotating`: the key was rotated and the previous secret still authenticates
+        # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+        # authenticates, and the key can't be rotated.
+        sig do
+          returns(
+            Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # When the key was last rotated.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :last_rotated_at
+
+        # While `status` is `rotating`, when the previous secret stops authenticating.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :previous_key_expires_at
+
+        # The full API key. Only present in the response that creates or rotates the key,
+        # and never shown again.
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret
+
+        sig { params(secret: String).void }
+        attr_writer :secret
+
         sig do
           params(
             id: String,
@@ -43,7 +80,13 @@ module Openlayer
             date_last_used: T.nilable(Time),
             date_updated: Time,
             secure_key: String,
-            name: T.nilable(String)
+            status:
+              Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::OrSymbol,
+            expires_at: T.nilable(Time),
+            last_rotated_at: T.nilable(Time),
+            name: T.nilable(String),
+            previous_key_expires_at: T.nilable(Time),
+            secret: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -55,10 +98,30 @@ module Openlayer
           date_last_used:,
           # The API key last update date.
           date_updated:,
-          # The API key value.
+          # An obfuscated hint of the API key value. When a key is created or rotated this
+          # also holds the full secret, for backward compatibility; prefer `secret`.
           secure_key:,
+          # The key's lifecycle state. `active`: the current secret authenticates.
+          # `rotating`: the key was rotated and the previous secret still authenticates
+          # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+          # authenticates, and the key can't be rotated.
+          status:,
+          # When the key stops authenticating. `null` means the key never expires. Set when
+          # the key is created or rotated, and must be in the future. When the request is
+          # authenticated with an API key that expires, the result can't be later than that
+          # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+          # keep the current one. It can't be changed with an update; rotate the key
+          # instead.
+          expires_at: nil,
+          # When the key was last rotated.
+          last_rotated_at: nil,
           # The API key name.
-          name: nil
+          name: nil,
+          # While `status` is `rotating`, when the previous secret stops authenticating.
+          previous_key_expires_at: nil,
+          # The full API key. Only present in the response that creates or rotates the key,
+          # and never shown again.
+          secret: nil
         )
         end
 
@@ -70,12 +133,61 @@ module Openlayer
               date_last_used: T.nilable(Time),
               date_updated: Time,
               secure_key: String,
-              name: T.nilable(String)
+              status:
+                Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::TaggedSymbol,
+              expires_at: T.nilable(Time),
+              last_rotated_at: T.nilable(Time),
+              name: T.nilable(String),
+              previous_key_expires_at: T.nilable(Time),
+              secret: String
             }
           )
         end
         def to_hash
         end
+
+        # The key's lifecycle state. `active`: the current secret authenticates.
+        # `rotating`: the key was rotated and the previous secret still authenticates
+        # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+        # authenticates, and the key can't be rotated.
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Openlayer::Models::Workspaces::APIKeyCreateResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::TaggedSymbol
+            )
+          ROTATING =
+            T.let(
+              :rotating,
+              Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Models::Workspaces::APIKeyCreateResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/openlayer/models/workspaces/api_key_delete_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyDeleteParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Workspaces::APIKeyDeleteParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :workspace_id
+
+        sig { returns(String) }
+        attr_accessor :api_key_id
+
+        sig do
+          params(
+            workspace_id: String,
+            api_key_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(workspace_id:, api_key_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              workspace_id: String,
+              api_key_id: String,
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/workspaces/api_key_list_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyListParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Workspaces::APIKeyListParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :workspace_id
+
+        sig do
+          params(
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(workspace_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { workspace_id: String, request_options: Openlayer::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end