openlayer 0.16.0 → 0.17.0

data/rbi/openlayer/resources/governance/rule_results.rbi

@@ -4,11 +4,7 @@ module Openlayer
   module Resources
     class Governance
       class RuleResults
-        # Retrieve a rule result by its id.
-        #
-        # Alongside the status, the response carries the evaluation and renewal dates that
-        # explain it: `dateLastEvaluated` and `dateOfNextEvaluation` for platform rules,
-        # `dateOfLatestEvidence` and `dateOfRenewal` for evidence rules.
+        # Retrieve a rule result.
         sig do
           params(
             rule_result_id: String,
@@ -22,13 +18,7 @@ module Openlayer
         )
         end
 
-        # Update a rule result. Only the fields you send are changed.
-        #
-        # Use this to assign an owner, or to exclude a single result from compliance
-        # without deactivating the rule everywhere. `deactivatedReason` is required when
-        # setting `deactivated` to `true`.
-        #
-        # A result's `status` is computed by Openlayer and cannot be set directly.
+        # Update a rule result.
         sig do
           params(
             rule_result_id: String,
@@ -55,20 +45,16 @@ module Openlayer
           blocked_by: nil,
           # Rule results that this one blocks.
           blocking: nil,
-          # 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: nil,
-          # Why the result was excluded.
+          # Why the result was excluded. Required when setting `deactivated` to `true`.
           deactivated_reason: nil,
           request_options: {}
         )
         end
 
-        # List rule results across a workspace.
-        #
-        # A rule result is the compliance status of one rule for one entity: a project for
-        # project-scoped rules, or the workspace itself for workspace-scoped rules. This
-        # is the endpoint to poll or export when you want your current compliance state,
-        # filtered to a framework, a project, or a status.
+        # List the rule results in a workspace.
         sig do
           params(
             workspace_id: String,
@@ -116,16 +102,7 @@ module Openlayer
         )
         end
 
-        # Attach evidence to a rule result, satisfying an evidence rule.
-        #
-        # Send the field that matches the rule's `evidenceType`: `storageUri` for an
-        # uploaded document, `text` for a written statement, or `url` for a link.
-        #
-        # For a document, upload the file first with `POST /storage/presigned-url` and
-        # send the resulting storage URI as `storageUri`.
-        #
-        # Attaching evidence re-evaluates the rule result. If the rule sets
-        # `renewalCadenceDays`, the renewal window restarts from this evidence.
+        # Attach evidence to a rule result.
         sig do
           params(
             rule_result_id: String,
@@ -147,7 +124,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,
@@ -158,10 +136,6 @@ module Openlayer
         end
 
         # List the evidence attached to a rule result.
-        #
-        # Which field carries the evidence depends on the rule's `evidenceType`:
-        # `storageUri` for uploaded documents, `text` for written statements, and `url`
-        # for links.
         sig do
           params(
             rule_result_id: String,

data/rbi/openlayer/resources/governance/rule_stats.rbi

@@ -4,11 +4,7 @@ module Openlayer
   module Resources
     class Governance
       class RuleStats
-        # Get a compliance roll-up for a workspace: how many rules exist, and how many of
-        # their results are passing, failing, pending, or due for renewal.
-        #
-        # Counts respect the filters you pass, so `frameworkId` gives you a single
-        # framework's overall compliance and `projectId` gives you a single project's.
+        # Get compliance statistics for a workspace.
         sig do
           params(
             workspace_id: String,

data/rbi/openlayer/resources/governance/rule_tags.rbi

@@ -5,10 +5,6 @@ module Openlayer
     class Governance
       class RuleTags
         # List the rule tags in a workspace.
-        #
-        # Tags group rules across frameworks, for example by team or by control family.
-        # Use the ids returned here with the `tags` filter on
-        # [List rules](/api-reference/rest/governance/list-rules).
         sig do
           params(
             workspace_id: String,

data/rbi/openlayer/resources/governance/rules.rbi

@@ -4,19 +4,7 @@ module Openlayer
   module Resources
     class Governance
       class Rules
-        # Create a governance rule in a workspace.
-        #
-        # A rule is one requirement. Its `type` decides how it is satisfied, and the two
-        # types accept different fields:
-        #
-        # - `platform` rules are evaluated automatically from the state of your workspace.
-        #   Set `automationType` to the signal to check. Their `scope` must be `project`,
-        #   and `evidenceType` and `renewalCadenceDays` must be omitted or `null`.
-        # - `evidence` rules are satisfied by attaching evidence. Set `evidenceType` to
-        #   the kind of evidence that satisfies them. `automationType` and
-        #   `automationParams` must be omitted or `null`.
-        #
-        # A new rule belongs to no framework. Map it to one from the Openlayer app.
+        # Create a rule in a workspace.
         sig do
           params(
             workspace_id: String,
@@ -43,27 +31,33 @@ 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 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,
           # 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 ids of the rule tags to associate with the rule. Replaces the rule's tags.
           # Read them back from `tags`, and list the tags available in the workspace with
@@ -73,8 +67,7 @@ module Openlayer
         )
         end
 
-        # Retrieve a governance rule by its id, including the frameworks it belongs to and
-        # its tags.
+        # Retrieve a rule with its frameworks and tags.
         sig do
           params(
             rule_id: String,
@@ -88,12 +81,7 @@ module Openlayer
         )
         end
 
-        # Update a governance rule. Only the fields you send are changed.
-        #
-        # Rules that ship with Openlayer report `immutable: true` and cannot be edited.
-        #
-        # A rule's `scope`, `type`, `evidenceType`, and automation are fixed once it
-        # exists -- create a new rule instead of converting one.
+        # Update a rule.
         sig do
           params(
             rule_id: String,
@@ -118,7 +106,8 @@ module Openlayer
           # The rule name.
           name: 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 ids of the rule tags to associate with the rule. Replaces the rule's tags.
           # Read them back from `tags`, and list the tags available in the workspace with
@@ -128,16 +117,7 @@ module Openlayer
         )
         end
 
-        # List the governance rules in a workspace.
-        #
-        # A rule is a single requirement Openlayer tracks. `platform` rules are evaluated
-        # automatically from the state of your workspace; `evidence` rules are satisfied
-        # by attaching evidence. A rule can belong to several frameworks at once, and
-        # rules that belong to none are returned too unless you pass
-        # `includeUnframed=false`.
-        #
-        # Pass `includeResults=true` to get each rule's compliance results inline instead
-        # of fetching them separately.
+        # List the rules in a workspace.
         sig do
           params(
             workspace_id: String,
@@ -205,11 +185,7 @@ module Openlayer
         )
         end
 
-        # Delete a governance rule and its rule results.
-        #
-        # Only rules you created can be deleted. Rules that ship with Openlayer report
-        # `immutable: true` and cannot be deleted -- exclude one from compliance by
-        # setting `deactivated` with `PUT /rules/{ruleId}` instead.
+        # Delete a rule and its results.
         sig do
           params(
             rule_id: String,

data/rbi/openlayer/resources/inference_pipelines/rows.rbi

@@ -4,7 +4,7 @@ module Openlayer
   module Resources
     class InferencePipelines
       class Rows
-        # Fetch a single inference pipeline row by inference ID, including OTel steps.
+        # Retrieve a row by inference ID, including OTel steps.
         sig do
           params(
             inference_id: String,
@@ -20,7 +20,7 @@ module Openlayer
         )
         end
 
-        # Update an inference data point in an inference pipeline.
+        # Update a row in an inference pipeline.
         sig do
           params(
             inference_pipeline_id: String,
@@ -46,7 +46,7 @@ module Openlayer
         )
         end
 
-        # A list of rows for an inference pipeline.
+        # List the rows in an inference pipeline.
         sig do
           params(
             inference_pipeline_id: String,
@@ -102,8 +102,7 @@ module Openlayer
         )
         end
 
-        # Delete a single inference pipeline row by inference ID. Only project admins can
-        # perform this action.
+        # Delete a row by inference ID.
         sig do
           params(
             inference_id: String,

data/rbi/openlayer/resources/inference_pipelines.rbi

@@ -12,7 +12,7 @@ module Openlayer
       sig { returns(Openlayer::Resources::InferencePipelines::TestResults) }
       attr_reader :test_results
 
-      # Retrieve inference pipeline.
+      # Retrieve an inference pipeline.
       sig do
         params(
           inference_pipeline_id: String,
@@ -32,7 +32,7 @@ module Openlayer
       )
       end
 
-      # Update inference pipeline.
+      # Update an inference pipeline.
       sig do
         params(
           inference_pipeline_id: String,
@@ -56,7 +56,7 @@ module Openlayer
       )
       end
 
-      # Delete inference pipeline.
+      # Delete an inference pipeline.
       sig do
         params(
           inference_pipeline_id: String,
@@ -70,12 +70,7 @@ module Openlayer
       )
       end
 
-      # Get aggregated session data for an inference pipeline with pagination and
-      # metadata.
-      #
-      # Returns a list of sessions for the inference pipeline, including activity
-      # statistics such as record counts, token usage, cost, latency, and the first and
-      # last records.
+      # List the sessions in an inference pipeline, with their stats.
       sig do
         params(
           inference_pipeline_id: String,
@@ -131,11 +126,7 @@ module Openlayer
       )
       end
 
-      # Get aggregated user data for an inference pipeline with pagination and metadata.
-      #
-      # Returns a list of users who have interacted with the inference pipeline,
-      # including their activity statistics such as session counts, record counts, token
-      # usage, and costs.
+      # List the users of an inference pipeline, with their stats.
       sig do
         params(
           inference_pipeline_id: String,

data/rbi/openlayer/resources/projects/tests.rbi

@@ -4,7 +4,7 @@ module Openlayer
   module Resources
     class Projects
       class Tests
-        # Create a test.
+        # Create a test in a project.
         sig do
           params(
             project_id: String,
@@ -76,7 +76,7 @@ module Openlayer
         )
         end
 
-        # Update tests.
+        # Update tests in a project.
         sig do
           params(
             project_id: String,
@@ -93,7 +93,7 @@ module Openlayer
         )
         end
 
-        # List tests under a project.
+        # List the tests in a project.
         sig do
           params(
             project_id: String,

data/rbi/openlayer/resources/storage/presigned_url.rbi

@@ -4,7 +4,7 @@ module Openlayer
   module Resources
     class Storage
       class PresignedURL
-        # Retrieve a presigned url to post storage artifacts.
+        # Get a presigned url to upload a file.
         sig do
           params(
             object_name: String,
@@ -18,16 +18,7 @@ module Openlayer
         )
         end
 
-        # Exchange a `storageUri` for a short-lived presigned url you can download the
-        # object from.
-        #
-        # Use it to collect anything the platform stored on your behalf -- for example the
-        # archive a framework export leaves behind, whose `storageUri` comes back in the
-        # background task's `outputs`.
-        #
-        # The workspace is taken from the API key, so there is nothing else to send. The
-        # url is only issued for objects your workspace owns, and `404` covers both "no
-        # such object" and "not yours".
+        # Get a short-lived download url for a stored object.
         sig do
           params(
             storage_uri: String,
@@ -35,7 +26,8 @@ module Openlayer
           ).returns(Openlayer::Models::Storage::PresignedURLRetrieveResponse)
         end
         def retrieve(
-          # 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/resources/tests.rbi

@@ -3,10 +3,7 @@
 module Openlayer
   module Resources
     class Tests
-      # Triggers one-off evaluation of a specific monitoring test for a custom timestamp
-      # range. This allows evaluating tests for historical data or custom time periods
-      # outside the regular evaluation window schedule. It also allows overwriting the
-      # existing test results.
+      # Evaluate a test over a custom time range.
       sig do
         params(
           test_id: String,

data/rbi/openlayer/resources/workspaces/api_keys.rbi

@@ -4,10 +4,11 @@ module Openlayer
   module Resources
     class Workspaces
       class APIKeys
-        # Create a new API key in a workspace.
+        # Create a new API key.
         sig do
           params(
             workspace_id: String,
+            expires_at: T.nilable(Time),
             name: T.nilable(String),
             request_options: Openlayer::RequestOptions::OrHash
           ).returns(Openlayer::Models::Workspaces::APIKeyCreateResponse)
@@ -15,12 +16,120 @@ module Openlayer
         def create(
           # The workspace id.
           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: {}
         )
         end
 
+        # Retrieve an API key.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Workspaces::APIKeyRetrieveResponse)
+        end
+        def retrieve(
+          # The API key id.
+          api_key_id,
+          # The workspace id.
+          workspace_id:,
+          request_options: {}
+        )
+        end
+
+        # Rename an API key.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            name: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Workspaces::APIKeyUpdateResponse)
+        end
+        def update(
+          # Path param: The API key id.
+          api_key_id,
+          # Path param: The workspace id.
+          workspace_id:,
+          # Body param: The API key name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # List your API keys in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(
+            T::Array[Openlayer::Models::Workspaces::APIKeyListResponseItem]
+          )
+        end
+        def list(
+          # The workspace id.
+          workspace_id,
+          request_options: {}
+        )
+        end
+
+        # Delete an API key.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # The API key id.
+          api_key_id,
+          # The workspace id.
+          workspace_id:,
+          request_options: {}
+        )
+        end
+
+        # Replace an API key's secret.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            expires_at: T.nilable(Time),
+            grace_period_hours: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Workspaces::APIKeyRotateResponse)
+        end
+        def rotate(
+          # Path param: The API key id.
+          api_key_id,
+          # Path param: The workspace id.
+          workspace_id:,
+          # Body param: 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,
+          # Body param: Hours the previous secret keeps authenticating. The default of 0
+          # retires it immediately. It never outlives `expiresAt`. Only one previous secret
+          # is kept, so rotating again during a grace period retires the older one
+          # immediately.
+          grace_period_hours: nil,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Openlayer::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/openlayer/resources/workspaces/invites.rbi

@@ -23,7 +23,7 @@ module Openlayer
         )
         end
 
-        # Retrieve a list of invites in a workspace.
+        # List the invites in a workspace.
         sig do
           params(
             workspace_id: String,

data/rbi/openlayer/resources/workspaces.rbi

@@ -9,7 +9,7 @@ module Openlayer
       sig { returns(Openlayer::Resources::Workspaces::APIKeys) }
       attr_reader :api_keys
 
-      # Retrieve a workspace by its ID.
+      # Retrieve a workspace.
       sig do
         params(
           workspace_id: String,

data/sig/openlayer/models/workspaces/api_key_create_params.rbs

@@ -2,7 +2,7 @@ module Openlayer
   module Models
     module Workspaces
       type api_key_create_params =
-        { workspace_id: String, name: String? }
+        { workspace_id: String, expires_at: Time?, name: String? }
         & Openlayer::Internal::Type::request_parameters
 
       class APIKeyCreateParams < Openlayer::Internal::Type::BaseModel
@@ -11,16 +11,20 @@ module Openlayer
 
         attr_accessor workspace_id: String
 
+        attr_accessor expires_at: Time?
+
         attr_accessor name: String?
 
         def initialize: (
           workspace_id: String,
+          ?expires_at: Time?,
           ?name: String?,
           ?request_options: Openlayer::request_opts
         ) -> void
 
         def to_hash: -> {
           workspace_id: String,
+          expires_at: Time?,
           name: String?,
           request_options: Openlayer::RequestOptions
         }

data/sig/openlayer/models/workspaces/api_key_create_response.rbs

@@ -8,10 +8,17 @@ module Openlayer
           date_last_used: Time?,
           date_updated: Time,
           secure_key: String,
-          name: String?
+          status: Openlayer::Models::Workspaces::APIKeyCreateResponse::status,
+          expires_at: Time?,
+          last_rotated_at: Time?,
+          name: String?,
+          previous_key_expires_at: Time?,
+          secret: String
         }
 
       class APIKeyCreateResponse < Openlayer::Internal::Type::BaseModel
+        attr_accessor expires_at: Time?
+
         attr_accessor name: String?
 
         attr_accessor id: String
@@ -24,13 +31,28 @@ module Openlayer
 
         attr_accessor secure_key: String
 
+        attr_accessor status: Openlayer::Models::Workspaces::APIKeyCreateResponse::status
+
+        attr_accessor last_rotated_at: Time?
+
+        attr_accessor previous_key_expires_at: Time?
+
+        attr_reader secret: String?
+
+        def secret=: (String) -> String
+
         def initialize: (
           id: String,
           date_created: Time,
           date_last_used: Time?,
           date_updated: Time,
           secure_key: String,
-          ?name: String?
+          status: Openlayer::Models::Workspaces::APIKeyCreateResponse::status,
+          ?expires_at: Time?,
+          ?last_rotated_at: Time?,
+          ?name: String?,
+          ?previous_key_expires_at: Time?,
+          ?secret: String
         ) -> void
 
         def to_hash: -> {
@@ -39,8 +61,25 @@ module Openlayer
           date_last_used: Time?,
           date_updated: Time,
           secure_key: String,
-          name: String?
+          status: Openlayer::Models::Workspaces::APIKeyCreateResponse::status,
+          expires_at: Time?,
+          last_rotated_at: Time?,
+          name: String?,
+          previous_key_expires_at: Time?,
+          secret: String
         }
+
+        type status = :active | :rotating | :expired
+
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          ACTIVE: :active
+          ROTATING: :rotating
+          EXPIRED: :expired
+
+          def self?.values: -> ::Array[Openlayer::Models::Workspaces::APIKeyCreateResponse::status]
+        end
       end
     end
   end