openlayer 0.16.0 → 0.17.0

data/lib/openlayer/resources/governance/frameworks.rb

@@ -16,14 +16,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Governance::FrameworkCreateParams} for more details.
         #
-        # Create a custom governance framework in a workspace.
-        #
-        # Use this to track compliance against an internal policy, or against a standard
-        # Openlayer does not ship as a built-in framework. A new framework starts with no
-        # rules -- add them from the Openlayer app, or map an existing rule to it.
-        #
-        # A framework is created disabled unless you pass `enabled: true`. While it is
-        # disabled its rules are not evaluated and do not count towards compliance.
+        # Create a custom framework in a workspace.
         #
         # @overload create(workspace_id, name:, description: nil, enabled: nil, project_selector: nil, tags: nil, request_options: {})
         #
@@ -55,7 +48,7 @@ module Openlayer
           )
         end
 
-        # Retrieve a governance framework by its id.
+        # Retrieve a framework.
         #
         # @overload retrieve(framework_id, request_options: {})
         #
@@ -78,17 +71,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Governance::FrameworkUpdateParams} for more details.
         #
-        # Update a governance framework.
-        #
-        # The most common use is activating or deactivating a framework for the workspace
-        # by setting `enabled`. Rules of a disabled framework are not evaluated and do not
-        # count towards compliance.
-        #
-        # Frameworks that ship with Openlayer report `immutable: true`. For those, only
-        # `enabled`, `tags`, and `projectSelector` can be changed -- their name and
-        # definition are managed by Openlayer.
-        #
-        # Only the fields you send are changed.
+        # Update a framework.
         #
         # @overload update(framework_id, avatar: nil, description: nil, enabled: nil, extended_description: nil, href: nil, name: nil, project_selector: nil, tags: nil, request_options: {})
         #
@@ -129,12 +112,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Governance::FrameworkListParams} for more details.
         #
-        # List the governance frameworks in a workspace.
-        #
-        # A framework is a set of rules -- drawn from a regulation, a standard, or your
-        # own internal policy -- that Openlayer tracks compliance against. Use this
-        # endpoint to find the framework you want to report on, then read its rules and
-        # rule results.
+        # List the frameworks in a workspace.
         #
         # @overload list(workspace_id, asc: nil, completion_operator: nil, completion_value: nil, enabled: nil, include_rule_stats: nil, page: nil, per_page: nil, project_id: nil, search_query: nil, sort_column: nil, tags: nil, request_options: {})
         #
@@ -187,35 +165,16 @@ module Openlayer
           )
         end
 
-        # Export a framework's evidence and progress as an audit-ready zip archive.
-        #
-        # The archive holds every evidence file uploaded against the framework's
-        # evidence-based rules, a markdown report of the framework's progress and the
-        # status of all its rules (broken down by documentation section when the framework
-        # has documents), and CSV manifests of rules and evidence with SHA-256 checksums.
-        #
-        # Send `projectId` to export one project's compliance with the framework. Omit it
-        # for the workspace-wide view across every project in the framework, including
-        # workspace-scoped rules.
-        #
-        # The export runs as a background task, so this returns `202` immediately. To
-        # collect the archive:
-        #
-        # 1. Poll `GET /background-tasks/{taskId}` with the returned `taskResultId` until
-        #    `complete` is `true`.
-        # 2. Read `outputs.storageUri` off that task.
-        # 3. Exchange it for a download link at
-        #    `GET /storage/presigned-url?storageUri=<uri>`.
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::FrameworkExportParams} for more details.
         #
-        # Rate limited to 2 requests per minute per framework. Asking for an export while
-        # an identical one is still queued returns that task rather than starting a second
-        # one.
+        # Export a framework as an audit-ready zip archive.
         #
         # @overload export(framework_id, project_id: nil, request_options: {})
         #
         # @param framework_id [String] The framework id.
         #
-        # @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}, nil]
         #
@@ -233,11 +192,7 @@ module Openlayer
           )
         end
 
-        # Get a compliance roll-up for a framework, one row per project it applies to.
-        #
-        # Each row counts the project's rule results by status, so you can report on where
-        # a framework is complete and where it is not without fetching every individual
-        # rule result.
+        # List a framework's compliance stats per project.
         #
         # @overload list_project_rule_stats(framework_id, asc: nil, page: nil, per_page: nil, sort_column: nil, request_options: {})
         #
@@ -270,9 +225,6 @@ module Openlayer
 
         # List the projects a framework applies to.
         #
-        # Which projects a framework covers is determined by its `projectSelector`. A
-        # framework with an empty selector applies to every project in the workspace.
-        #
         # @overload list_projects(framework_id, page: nil, per_page: nil, request_options: {})
         #
         # @param framework_id [String] The framework id.
@@ -298,11 +250,7 @@ module Openlayer
           )
         end
 
-        # List the rules that belong to a framework.
-        #
-        # To read the compliance status of these rules, use
-        # [List rule results](/api-reference/rest/governance/list-rule-results) with the
-        # `frameworkId` filter, or fetch the results of an individual rule.
+        # List the rules in a framework.
         #
         # @overload list_rules(framework_id, page: nil, per_page: nil, request_options: {})
         #

data/lib/openlayer/resources/governance/rule_results.rb

@@ -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.
         #
         # @overload retrieve(rule_result_id, request_options: {})
         #
@@ -28,13 +24,10 @@ 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`.
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::RuleResultUpdateParams} for more details.
         #
-        # A result's `status` is computed by Openlayer and cannot be set directly.
+        # Update a rule result.
         #
         # @overload update(rule_result_id, assignee_id: nil, blocked_by: nil, blocking: nil, deactivated: nil, deactivated_reason: nil, request_options: {})
         #
@@ -46,9 +39,9 @@ module Openlayer
         #
         # @param blocking [Array<Openlayer::Models::Governance::RuleResultUpdateParams::Blocking>] Rule results that this one blocks.
         #
-        # @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 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 request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -66,12 +59,7 @@ module Openlayer
           )
         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.
         #
         # @overload list(workspace_id, enabled_framework_only: nil, framework_id: nil, include_unframed: nil, page: nil, per_page: nil, project_id: nil, rule_id: nil, scope: nil, search_query: nil, status: nil, type: nil, request_options: {})
         #
@@ -128,16 +116,7 @@ module Openlayer
         # {Openlayer::Models::Governance::RuleResultCreateEvidenceParams} for more
         # details.
         #
-        # 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.
         #
         # @overload create_evidence(rule_result_id, description: nil, name: nil, storage_uri: nil, text: nil, url: nil, request_options: {})
         #
@@ -171,10 +150,6 @@ module Openlayer
 
         # 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.
-        #
         # @overload list_evidence(rule_result_id, page: nil, per_page: nil, request_options: {})
         #
         # @param rule_result_id [String] The rule result id.

data/lib/openlayer/resources/governance/rule_stats.rb

@@ -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.
         #
         # @overload retrieve(workspace_id, framework_id: nil, project_id: nil, request_options: {})
         #

data/lib/openlayer/resources/governance/rule_tags.rb

@@ -6,10 +6,6 @@ module Openlayer
       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).
-        #
         # @overload list(workspace_id, page: nil, per_page: nil, request_options: {})
         #
         # @param workspace_id [String] The workspace id.

data/lib/openlayer/resources/governance/rules.rb

@@ -7,19 +7,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Governance::RuleCreateParams} for more details.
         #
-        # 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.
         #
         # @overload create(workspace_id, name:, scope:, type:, assignee_id: nil, automation_params: nil, automation_type: nil, deactivated: nil, description: nil, evidence_type: nil, renewal_cadence_days: nil, tag_ids: nil, request_options: {})
         #
@@ -33,7 +21,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
         #
@@ -41,7 +29,7 @@ module Openlayer
         #
         # @param description [String, nil] What the rule requires.
         #
-        # @param evidence_type [Symbol, Openlayer::Models::Governance::RuleCreateParams::EvidenceType, nil] The kind of evidence that satisfies the rule. `null` for platform rules.
+        # @param evidence_type [Symbol, Openlayer::Models::Governance::RuleCreateParams::EvidenceType, nil] The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
         #
         # @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
         #
@@ -63,8 +51,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.
         #
         # @overload retrieve(rule_id, request_options: {})
         #
@@ -87,12 +74,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Governance::RuleUpdateParams} for more details.
         #
-        # 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.
         #
         # @overload update(rule_id, assignee_id: nil, deactivated: nil, description: nil, name: nil, renewal_cadence_days: nil, tag_ids: nil, request_options: {})
         #
@@ -129,16 +111,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Governance::RuleListParams} for more details.
         #
-        # 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.
         #
         # @overload list(workspace_id, asc: nil, assignee_id: nil, deactivated: nil, enabled_framework_only: nil, framework_id: nil, group: nil, include_results: nil, include_unframed: nil, page: nil, per_page: nil, project_id: nil, scope: nil, search_query: nil, sort_by: nil, status: nil, tags: nil, type: nil, request_options: {})
         #
@@ -205,11 +178,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.
         #
         # @overload delete(rule_id, request_options: {})
         #

data/lib/openlayer/resources/inference_pipelines/rows.rb

@@ -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.
         #
         # @overload retrieve(inference_id, inference_pipeline_id:, request_options: {})
         #
@@ -31,7 +31,7 @@ module Openlayer
           )
         end
 
-        # Update an inference data point in an inference pipeline.
+        # Update a row in an inference pipeline.
         #
         # @overload update(inference_pipeline_id, inference_id:, row:, config: nil, request_options: {})
         #
@@ -62,7 +62,7 @@ module Openlayer
           )
         end
 
-        # A list of rows for an inference pipeline.
+        # List the rows in an inference pipeline.
         #
         # @overload list(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
         #
@@ -109,8 +109,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.
         #
         # @overload delete(inference_id, inference_pipeline_id:, request_options: {})
         #

data/lib/openlayer/resources/inference_pipelines.rb

@@ -12,7 +12,7 @@ module Openlayer
       # @return [Openlayer::Resources::InferencePipelines::TestResults]
       attr_reader :test_results
 
-      # Retrieve inference pipeline.
+      # Retrieve an inference pipeline.
       #
       # @overload retrieve(inference_pipeline_id, expand: nil, request_options: {})
       #
@@ -40,7 +40,7 @@ module Openlayer
       # Some parameter documentations has been truncated, see
       # {Openlayer::Models::InferencePipelineUpdateParams} for more details.
       #
-      # Update inference pipeline.
+      # Update an inference pipeline.
       #
       # @overload update(inference_pipeline_id, description: nil, name: nil, reference_dataset_uri: nil, request_options: {})
       #
@@ -68,7 +68,7 @@ module Openlayer
         )
       end
 
-      # Delete inference pipeline.
+      # Delete an inference pipeline.
       #
       # @overload delete(inference_pipeline_id, request_options: {})
       #
@@ -88,12 +88,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.
       #
       # @overload retrieve_sessions(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
       #
@@ -140,11 +135,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.
       #
       # @overload retrieve_users(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
       #

data/lib/openlayer/resources/projects/tests.rb

@@ -7,7 +7,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Projects::TestCreateParams} for more details.
         #
-        # Create a test.
+        # Create a test in a project.
         #
         # @overload create(project_id, description:, name:, subtype:, thresholds:, type:, archived: nil, default_to_all_pipelines: nil, delay_window: nil, evaluation_window: nil, exclude_pipelines: nil, include_historical_data: nil, include_pipelines: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil, request_options: {})
         #
@@ -63,7 +63,7 @@ module Openlayer
           )
         end
 
-        # Update tests.
+        # Update tests in a project.
         #
         # @overload update(project_id, payloads:, request_options: {})
         #
@@ -90,7 +90,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Projects::TestListParams} for more details.
         #
-        # List tests under a project.
+        # List the tests in a project.
         #
         # @overload list(project_id, include_archived: nil, origin_version_id: nil, page: nil, per_page: nil, suggested: nil, type: nil, uses_production_data: nil, request_options: {})
         #

data/lib/openlayer/resources/storage/presigned_url.rb

@@ -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.
         #
         # @overload create(object_name:, request_options: {})
         #
@@ -27,20 +27,14 @@ module Openlayer
           )
         end
 
-        # Exchange a `storageUri` for a short-lived presigned url you can download the
-        # object from.
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Storage::PresignedURLRetrieveParams} for more details.
         #
-        # 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.
         #
         # @overload retrieve(storage_uri:, request_options: {})
         #
-        # @param storage_uri [String] The object's storage uri.
+        # @param storage_uri [String] The object's storage uri, for example `outputs.storageUri` from a framework expo
         #
         # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openlayer/resources/tests.rb

@@ -6,10 +6,7 @@ module Openlayer
       # Some parameter documentations has been truncated, see
       # {Openlayer::Models::TestEvaluateParams} for more details.
       #
-      # 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.
       #
       # @overload evaluate(test_id, end_timestamp:, start_timestamp:, inference_pipeline_id: nil, overwrite_results: nil, request_options: {})
       #

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

@@ -4,12 +4,17 @@ module Openlayer
   module Resources
     class Workspaces
       class APIKeys
-        # Create a new API key in a workspace.
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Workspaces::APIKeyCreateParams} for more details.
         #
-        # @overload create(workspace_id, name: nil, request_options: {})
+        # Create a new API key.
+        #
+        # @overload create(workspace_id, expires_at: nil, name: nil, request_options: {})
         #
         # @param workspace_id [String] The workspace id.
         #
+        # @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
+        #
         # @param name [String, nil] The API key name.
         #
         # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -28,6 +33,145 @@ module Openlayer
           )
         end
 
+        # Retrieve an API key.
+        #
+        # @overload retrieve(api_key_id, workspace_id:, request_options: {})
+        #
+        # @param api_key_id [String] The API key id.
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyRetrieveResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyRetrieveParams
+        def retrieve(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyRetrieveParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/api-keys/%2$s", workspace_id, api_key_id],
+            model: Openlayer::Models::Workspaces::APIKeyRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Rename an API key.
+        #
+        # @overload update(api_key_id, workspace_id:, name: nil, request_options: {})
+        #
+        # @param api_key_id [String] Path param: The API key id.
+        #
+        # @param workspace_id [String] Path param: The workspace id.
+        #
+        # @param name [String, nil] Body param: The API key name.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyUpdateResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyUpdateParams
+        def update(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyUpdateParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["workspaces/%1$s/api-keys/%2$s", workspace_id, api_key_id],
+            body: parsed,
+            model: Openlayer::Models::Workspaces::APIKeyUpdateResponse,
+            options: options
+          )
+        end
+
+        # List your API keys in a workspace.
+        #
+        # @overload list(workspace_id, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Openlayer::Models::Workspaces::APIKeyListResponseItem>]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyListParams
+        def list(workspace_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/api-keys", workspace_id],
+            model: Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Workspaces::APIKeyListResponseItem],
+            options: params[:request_options]
+          )
+        end
+
+        # Delete an API key.
+        #
+        # @overload delete(api_key_id, workspace_id:, request_options: {})
+        #
+        # @param api_key_id [String] The API key id.
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyDeleteParams
+        def delete(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyDeleteParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["workspaces/%1$s/api-keys/%2$s", workspace_id, api_key_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Workspaces::APIKeyRotateParams} for more details.
+        #
+        # Replace an API key's secret.
+        #
+        # @overload rotate(api_key_id, workspace_id:, expires_at: nil, grace_period_hours: nil, request_options: {})
+        #
+        # @param api_key_id [String] Path param: The API key id.
+        #
+        # @param workspace_id [String] Path param: The workspace id.
+        #
+        # @param expires_at [Time, nil] Body param: When the key stops authenticating. `null` means the key never expire
+        #
+        # @param grace_period_hours [Integer] Body param: Hours the previous secret keeps authenticating. The default of 0 ret
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyRotateResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyRotateParams
+        def rotate(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyRotateParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["workspaces/%1$s/api-keys/%2$s/rotate", workspace_id, api_key_id],
+            body: parsed,
+            model: Openlayer::Models::Workspaces::APIKeyRotateResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Openlayer::Client]