smplkit 3.0.122 → 3.0.123

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 032aaefb0a2a4bddff31f0d49789a1acf9a13f6b13aec6a6ba2669fd8ab03ebf
-  data.tar.gz: a0dfadc1df2957115ce1aec553e1f6f4efd0c69a435014a10a3c2b9301746990
+  metadata.gz: 2e34faeddba61d519c038ddbdfa67a966428a8abde386af2faed155fd98dfb22
+  data.tar.gz: 3bfaa6bbe205fdc5a3e9427228e95545b1af057d8ff8c50f5e0dc0f8649e5131
 SHA512:
-  metadata.gz: 567080f84a1b30df90fa3a0d814a33bdb5424e3033f98529947cfe61832636120247c98d93057e653fa02e6c11af662aefadd4f311e003635aaeb4a76a2bdf37
-  data.tar.gz: 242f57632778e8e401cec809b834f96272f70488616b201567665b27d48514c0fa66aa35c67be0061a8af8dcba1979d0b8bf545661a62c348dfee7cc01b5cf41
+  metadata.gz: b99d22b368a343511b45936b3a6c113bd86550eea77076a68bde20782139f2cd1ebc659f5b0260475e87ce7f1d631b1149556106c4d02a0ad6d344d6acf9dd3c
+  data.tar.gz: d1c8337f22b5dc95791bfa5474fc288fbffc207b62058b7ad4465b86429246e39de6d871cbd3f7207f8122826bfc7bd5078b76becb5e20db60e0e3c08008c701

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb

@@ -25,9 +25,6 @@ module SmplkitGeneratedClient::Audit
     # Destination type.
     attr_accessor :forwarder_type
 
-    # Always false. Enablement is per-environment: a forwarder delivers in an environment only when `environments[<env>].enabled` is true. The base value is pinned false and cannot be set.
-    attr_accessor :enabled
-
     # When true, this forwarder also receives platform change events that smplkit records about your own resources (flag, configuration, and similar changes). Each such event is delivered through every environment this forwarder is enabled in, using that environment's resolved configuration. Defaults to false — platform change events are not forwarded unless you opt in. Independent of the per-environment `enabled` settings, since platform change events are not tied to a deployment environment.
     attr_accessor :forward_smplkit_events
 
@@ -40,10 +37,10 @@ module SmplkitGeneratedClient::Audit
     # Template applied to each event before delivery. The shape depends on ``transform_type``: for `JSONATA`, a string containing a JSONata expression. Omit to deliver the event JSON unchanged.
     attr_accessor :transform
 
-    # Base delivery configuration template. Shape is discriminated by ``forwarder_type``; today all destination types use ``HttpConfiguration``. Branded vendor types (everything except `http`) constrain the configuration against a per-vendor template — see `GET /api/v1/forwarder_types` for the URL pattern, fixed headers, and customer-supplied placeholders for each type. A per-environment override in `environments` replaces this template for that environment.
+    # Base delivery configuration template. Shape is discriminated by ``forwarder_type``; today all destination types deliver over HTTP. Branded vendor types (everything except `http`) constrain the configuration against a per-vendor template — see `GET /api/v1/forwarder_types` for the URL pattern, fixed headers, and customer-supplied placeholders for each type. A per-environment entry in `environments` overrides individual fields of this template for that environment; fields it omits are inherited from here.
     attr_accessor :configuration
 
-    # Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry sets `enabled` (whether the forwarder delivers in that environment) and an optional `configuration` override (omit to inherit the base `configuration`). A forwarder with no entry for an environment is disabled there. Every referenced environment must exist and be managed for the account.
+    # Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry is a sparse map of only the fields that differ in that environment: `enabled` (whether the forwarder delivers there) plus any of `url`, `method`, `success_status`, `tls_verify`, `ca_cert`, and individual headers as `headers.<name>` (e.g. `headers.Authorization`). Fields you omit are inherited from the base `configuration`; an entry never needs to repeat the whole configuration. A forwarder with no entry for an environment is disabled there. Every referenced environment must exist and be managed for the account.
     attr_accessor :environments
 
     # When the forwarder was created.
@@ -86,7 +83,6 @@ module SmplkitGeneratedClient::Audit
         :'name' => :'name',
         :'description' => :'description',
         :'forwarder_type' => :'forwarder_type',
-        :'enabled' => :'enabled',
         :'forward_smplkit_events' => :'forward_smplkit_events',
         :'filter' => :'filter',
         :'transform_type' => :'transform_type',
@@ -116,13 +112,12 @@ module SmplkitGeneratedClient::Audit
         :'name' => :'String',
         :'description' => :'String',
         :'forwarder_type' => :'ForwarderType',
-        :'enabled' => :'Boolean',
         :'forward_smplkit_events' => :'Boolean',
         :'filter' => :'Hash<String, Object>',
         :'transform_type' => :'String',
         :'transform' => :'Object',
-        :'configuration' => :'HttpConfiguration',
-        :'environments' => :'Hash<String, ForwarderEnvironment>',
+        :'configuration' => :'ForwarderHttpConfiguration',
+        :'environments' => :'Hash<String, Hash<String, Object>>',
         :'created_at' => :'Time',
         :'updated_at' => :'Time',
         :'deleted_at' => :'Time',
@@ -176,12 +171,6 @@ module SmplkitGeneratedClient::Audit
         self.forwarder_type = nil
       end
 
-      if attributes.key?(:'enabled')
-        self.enabled = attributes[:'enabled']
-      else
-        self.enabled = false
-      end
-
       if attributes.key?(:'forward_smplkit_events')
         self.forward_smplkit_events = attributes[:'forward_smplkit_events']
       else
@@ -344,7 +333,6 @@ module SmplkitGeneratedClient::Audit
           name == o.name &&
           description == o.description &&
           forwarder_type == o.forwarder_type &&
-          enabled == o.enabled &&
           forward_smplkit_events == o.forward_smplkit_events &&
           filter == o.filter &&
           transform_type == o.transform_type &&
@@ -366,7 +354,7 @@ module SmplkitGeneratedClient::Audit
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, forwarder_type, enabled, forward_smplkit_events, filter, transform_type, transform, configuration, environments, created_at, updated_at, deleted_at, version].hash
+      [name, description, forwarder_type, forward_smplkit_events, filter, transform_type, transform, configuration, environments, created_at, updated_at, deleted_at, version].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/{http_configuration.rb → forwarder_http_configuration.rb}

@@ -14,15 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # HTTP request configuration for delivering a payload to a destination.  The shared base shape for any product that posts to a customer-supplied HTTP destination. Smpl Audit forwarders use it directly; Smpl Jobs extends it (adding ``body`` and ``timeout``). When other transports land (``FTP``, ``SQS``, …) their own configuration schemas will join this one as members of a discriminated union under a ``configuration`` field.
-  class HttpConfiguration < ApiModelBase
+  # HTTP request a forwarder makes to deliver an event.  Identical to the shared HTTP configuration except that ``headers`` is a name→value object so an individual header can be overridden per environment by its name.
+  class ForwarderHttpConfiguration < ApiModelBase
     # HTTP method used when delivering the request.
     attr_accessor :method
 
     # Destination URL. Must be an absolute `http://` or `https://` URL with a hostname (e.g. `https://siem.example.com/in`).
     attr_accessor :url
 
-    # HTTP headers attached to each request.
+    # HTTP headers attached to each delivery, as a name→value object (e.g. `{\"DD-API-KEY\": \"s3cr3t\"}`). A header is overridden in a specific environment by its name via a `headers.<name>` entry in that environment's overrides; header names match case-insensitively.
     attr_accessor :headers
 
     # HTTP response status that indicates success. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
@@ -83,7 +83,7 @@ module SmplkitGeneratedClient::Audit
       {
         :'method' => :'String',
         :'url' => :'String',
-        :'headers' => :'Array<HttpHeader>',
+        :'headers' => :'Hash<String, String>',
         :'success_status' => :'String',
         :'tls_verify' => :'Boolean',
         :'ca_cert' => :'String'
@@ -101,14 +101,14 @@ module SmplkitGeneratedClient::Audit
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::HttpConfiguration` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::ForwarderHttpConfiguration` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::HttpConfiguration`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::ForwarderHttpConfiguration`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -126,7 +126,7 @@ module SmplkitGeneratedClient::Audit
       end
 
       if attributes.key?(:'headers')
-        if (value = attributes[:'headers']).is_a?(Array)
+        if (value = attributes[:'headers']).is_a?(Hash)
           self.headers = value
         end
       end

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_request.rb

@@ -22,7 +22,7 @@ module SmplkitGeneratedClient::Audit
     # Destination URL. Must be an absolute `http://` or `https://` URL with a hostname (e.g. `https://siem.example.com/in`).
     attr_accessor :url
 
-    # HTTP headers attached to the test request.
+    # HTTP headers attached to the test request, as a name→value object (e.g. `{\"Authorization\": \"Bearer s3cr3t\"}`).
     attr_accessor :headers
 
     # HTTP response status that indicates success. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
@@ -91,7 +91,7 @@ module SmplkitGeneratedClient::Audit
       {
         :'method' => :'String',
         :'url' => :'String',
-        :'headers' => :'Array<HttpHeader>',
+        :'headers' => :'Hash<String, String>',
         :'success_status' => :'String',
         :'timeout_ms' => :'Integer',
         :'tls_verify' => :'Boolean',
@@ -138,7 +138,7 @@ module SmplkitGeneratedClient::Audit
       end
 
       if attributes.key?(:'headers')
-        if (value = attributes[:'headers']).is_a?(Array)
+        if (value = attributes[:'headers']).is_a?(Hash)
           self.headers = value
         end
       end

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client.rb

@@ -49,7 +49,7 @@ require 'smplkit_audit_client/models/forwarder_delivery_list_meta'
 require 'smplkit_audit_client/models/forwarder_delivery_list_response'
 require 'smplkit_audit_client/models/forwarder_delivery_resource'
 require 'smplkit_audit_client/models/forwarder_delivery_response'
-require 'smplkit_audit_client/models/forwarder_environment'
+require 'smplkit_audit_client/models/forwarder_http_configuration'
 require 'smplkit_audit_client/models/forwarder_list_response'
 require 'smplkit_audit_client/models/forwarder_request'
 require 'smplkit_audit_client/models/forwarder_resource'
@@ -63,8 +63,6 @@ require 'smplkit_audit_client/models/forwarder_type_placeholder'
 require 'smplkit_audit_client/models/forwarder_type_resource'
 require 'smplkit_audit_client/models/forwarder_type_response'
 require 'smplkit_audit_client/models/forwarder_type_transform'
-require 'smplkit_audit_client/models/http_configuration'
-require 'smplkit_audit_client/models/http_header'
 require 'smplkit_audit_client/models/list_meta'
 require 'smplkit_audit_client/models/pagination_meta'
 require 'smplkit_audit_client/models/resource_type_attributes'

data/lib/smplkit/_generated/audit/spec/models/{http_configuration_spec.rb → forwarder_http_configuration_spec.rb}

@@ -14,16 +14,16 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SmplkitGeneratedClient::Audit::HttpConfiguration
+# Unit tests for SmplkitGeneratedClient::Audit::ForwarderHttpConfiguration
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe SmplkitGeneratedClient::Audit::HttpConfiguration do
-  #let(:instance) { SmplkitGeneratedClient::Audit::HttpConfiguration.new }
+describe SmplkitGeneratedClient::Audit::ForwarderHttpConfiguration do
+  #let(:instance) { SmplkitGeneratedClient::Audit::ForwarderHttpConfiguration.new }
 
-  describe 'test an instance of HttpConfiguration' do
-    it 'should create an instance of HttpConfiguration' do
+  describe 'test an instance of ForwarderHttpConfiguration' do
+    it 'should create an instance of ForwarderHttpConfiguration' do
       # uncomment below to test the instance creation
-      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::HttpConfiguration)
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::ForwarderHttpConfiguration)
     end
   end
 

data/lib/smplkit/_generated/audit/spec/models/forwarder_spec.rb

@@ -45,12 +45,6 @@ describe SmplkitGeneratedClient::Audit::Forwarder do
     end
   end
 
-  describe 'test attribute "enabled"' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   describe 'test attribute "forward_smplkit_events"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job.rb

@@ -34,7 +34,7 @@ module SmplkitGeneratedClient::Jobs
     # The HTTP request to perform, including method, url, headers, body, and timeout.
     attr_accessor :configuration
 
-    # Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry sets `enabled` (whether the job is enabled — scheduled, for a recurring job, or triggerable, for a manual job — in that environment), an optional `schedule` override (a cron expression for recurring jobs; omit to inherit the base `schedule`), an optional `timezone` override (an IANA zone for recurring jobs; omit to inherit the base `timezone`, else UTC), and an optional `configuration` override (omit to inherit the base `configuration`); it also reports the read-only `next_run_at` for that environment. A job with no entry for an environment is disabled there. For a recurring or manual job, supply this map to choose where it runs. For a one-off job, the environment it is created in is recorded here automatically — name it with the `X-Smplkit-Environment` header. Every referenced environment must exist for the account.
+    # Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry is a flat, sparse overlay: only the leaves that differ from the base definition are present, and everything absent is inherited. Set `enabled` to `true` to run the job in that environment (the base is disabled everywhere; an environment with no entry, or an entry without `enabled: true`, does not run). Overridable leaves are `url`, `method`, `timeout`, `body`, `success_status`, `tls_verify`, `ca_cert`, `schedule` and `timezone` (recurring jobs only), `retry_policy` (the `id` of a retry policy, or `Default`), and an individual header as `headers.<name>` (e.g. `headers.Authorization`). On read, each entry also reports the read-only `next_run_at` for that environment (the next fire time, or `null`). For a recurring or manual job, supply this map to choose where it runs. For a one-off job, the environment it is created in is recorded here automatically — name it with the `X-Smplkit-Environment` header. Every referenced environment must exist for the account.
     attr_accessor :environments
 
     # How overlapping runs are handled. `ALLOW` (the only value today) permits them.
@@ -119,7 +119,7 @@ module SmplkitGeneratedClient::Jobs
         :'schedule' => :'String',
         :'timezone' => :'String',
         :'configuration' => :'JobHttpConfiguration',
-        :'environments' => :'Hash<String, JobEnvironment>',
+        :'environments' => :'Hash<String, Hash<String, Object>>',
         :'concurrency_policy' => :'String',
         :'retry_policy' => :'String',
         :'kind' => :'String',

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Jobs
-  # HTTP request a job performs when it fires.  Extends the shared forwarder configuration with the two fields a scheduled job needs beyond a forwarder.
+  # HTTP request a job performs when it fires.  Extends the shared forwarder configuration with the two fields a scheduled job needs beyond a forwarder, and represents headers as a name→value object so an individual header can be overridden per environment by its name.
   class JobHttpConfiguration < ApiModelBase
     # HTTP method used when delivering the request.
     attr_accessor :method
@@ -22,7 +22,7 @@ module SmplkitGeneratedClient::Jobs
     # Destination URL. Must be an absolute `http://` or `https://` URL with a hostname (e.g. `https://siem.example.com/in`).
     attr_accessor :url
 
-    # HTTP headers attached to each request.
+    # HTTP headers sent on each request, as a name→value object (e.g. `{\"Authorization\": \"Bearer s3cr3t\"}`). A header is overridden per environment by its name via a `headers.<name>` entry in that environment's overrides; header names match case-insensitively.
     attr_accessor :headers
 
     # HTTP response status that indicates success. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
@@ -91,7 +91,7 @@ module SmplkitGeneratedClient::Jobs
       {
         :'method' => :'String',
         :'url' => :'String',
-        :'headers' => :'Array<HttpHeader>',
+        :'headers' => :'Hash<String, String>',
         :'success_status' => :'String',
         :'tls_verify' => :'Boolean',
         :'ca_cert' => :'String',
@@ -137,7 +137,7 @@ module SmplkitGeneratedClient::Jobs
       end
 
       if attributes.key?(:'headers')
-        if (value = attributes[:'headers']).is_a?(Array)
+        if (value = attributes[:'headers']).is_a?(Hash)
           self.headers = value
         end
       end

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client.rb

@@ -20,11 +20,9 @@ require 'smplkit_jobs_client/configuration'
 # Models
 require 'smplkit_jobs_client/models/error'
 require 'smplkit_jobs_client/models/error_response'
-require 'smplkit_jobs_client/models/http_header'
 require 'smplkit_jobs_client/models/job'
 require 'smplkit_jobs_client/models/job_create_request'
 require 'smplkit_jobs_client/models/job_create_resource'
-require 'smplkit_jobs_client/models/job_environment'
 require 'smplkit_jobs_client/models/job_http_configuration'
 require 'smplkit_jobs_client/models/job_list_response'
 require 'smplkit_jobs_client/models/job_request'

data/lib/smplkit/audit/forwarders.rb

@@ -38,13 +38,15 @@ module Smplkit
       #   returned in plaintext on reads, so a get-mutate-put round-trip
       #   preserves them without re-entering secrets.
       # @param environments [Hash{String => Smplkit::Audit::ForwarderEnvironment, Hash}, nil]
-      #   Per-environment overrides keyed by environment key (e.g.
+      #   Per-environment sparse overrides keyed by environment key (e.g.
       #   +"production"+). A forwarder delivers in an environment only when that
       #   environment's entry has +enabled: true+. Values may be
-      #   {Smplkit::Audit::ForwarderEnvironment} instances or plain hashes
-      #   (+{ enabled: true }+, optionally with a +:configuration+
-      #   {Smplkit::Audit::HttpConfiguration} override). Omit to create a
-      #   forwarder that delivers nowhere until enabled per environment.
+      #   {Smplkit::Audit::ForwarderEnvironment} instances or plain hashes of its
+      #   constructor kwargs (+{ enabled: true }+, optionally with request leaves
+      #   like +:url+ and a +:headers+ name→value map); each entry overrides only
+      #   the leaves it sets, inheriting the base +configuration+ for the rest.
+      #   Omit to create a forwarder that delivers nowhere until enabled per
+      #   environment.
       # @param description [String, nil] Optional free-text description.
       # @param forward_smplkit_events [Boolean] When +true+, the forwarder also
       #   receives platform change events that smplkit records about the
@@ -162,34 +164,26 @@ module Smplkit
       # Coerce a caller's +environments+ map to wrapper instances.
       #
       # Accepts either {Smplkit::Audit::ForwarderEnvironment} values or plain
-      # hashes (+{ enabled: true, configuration: HttpConfiguration.new(...) }+)
-      # so callers can use the lightweight hash form without importing the model.
+      # hashes of its constructor kwargs (+{ enabled: true, url: "https://...",
+      # headers: { "DD-API-KEY" => "x" } }+) so callers can use the lightweight
+      # hash form without importing the model. Both symbol- and string-keyed
+      # hashes work.
       def normalize_environments(environments)
         return {} if environments.nil? || environments.empty?
 
         environments.each_with_object({}) do |(env_key, value), out|
-          out[env_key.to_s] = if value.is_a?(ForwarderEnvironment)
-                                value
-                              else
-                                ForwarderEnvironment.new(
-                                  enabled: value[:enabled] || value["enabled"] || false,
-                                  configuration: value[:configuration] || value["configuration"]
-                                )
-                              end
+          out[env_key.to_s] =
+            value.is_a?(ForwarderEnvironment) ? value : ForwarderEnvironment.new(**value.transform_keys(&:to_sym))
         end
       end
 
-      # Convert the wrapper +environments+ map to the generated model hash.
-      #
-      # Per-environment +configuration+ overrides are sent as full
-      # {Smplkit::Audit::HttpConfiguration} payloads (plaintext headers in),
-      # mirroring the base configuration's round-trip semantics.
+      # Convert the wrapper +environments+ map to the flat per-environment overlay
+      # the generated +Forwarder+ model carries (ADR-056). Each value is the
+      # environment's sparse leaf-path overlay: +enabled+ plus only the leaves it
+      # overrides, with each header as a +headers.<name>+ leaf.
       def environments_to_wire(environments)
         (environments || {}).each_with_object({}) do |(env_key, env), out|
-          out[env_key.to_s] = SmplkitGeneratedClient::Audit::ForwarderEnvironment.new(
-            enabled: env.enabled,
-            configuration: env.configuration.nil? ? nil : HttpConfiguration.to_wire(env.configuration)
-          )
+          out[env_key.to_s] = env.to_payload
         end
       end