smplkit 1.0.25 → 1.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c5467982be79b924356216ec4b8a4158589ac70802cefbee82c819f5d390281d
4
- data.tar.gz: 93f707d0f9951956db82350eb298d4a14f42ccb2effca770da64f9084e6908d4
3
+ metadata.gz: 85fc65604b1b3374714d8834023aa65f658f08d275b484f05ab7bb4a3105f6ba
4
+ data.tar.gz: 72fad8395cc96a5e21b0501d888fd735060da7f7a8c0ca71f6a047b1d371cea5
5
5
  SHA512:
6
- metadata.gz: 50b0fd8883a16c7b2aff012f26c956a6b5c2f1e3501cb08a02b5641fa360eb1ca60cca85acb0290a141f416497be3a0f0c3a62ced5c6593a357667a149911dec
7
- data.tar.gz: 36731f5638835a9939bd712574377f4f6ad7279883ad535f430c986173322c1d30044f95f2b47225c67b85c8eb2d5212ca9e736c4d6f5989b05b8c7260c43d68
6
+ metadata.gz: 69264993f3f28149eeda7d424ce52559360e5e17a9e32f1db661f6e140fa1afec14b860bd914e8cc42d2d16bc63dd0a9eba65a22a1748afaa33d5b20cef9b807
7
+ data.tar.gz: 64ecdaa7dbab15ebe416b5af127b4a694a412eae6d8a25d0f55a741bd0caef45d375a769557f323e62eb911dac4940e6c7a29eda29d8d82b178de4662c3af1a9
@@ -217,7 +217,7 @@ module SmplkitGeneratedClient::Audit
217
217
  end
218
218
 
219
219
  # Get Forwarder
220
- # Retrieve a single forwarder by id. Returns 404 if no forwarder with that id exists in the caller's account, including if the forwarder is soft-deleted. Header values in the response are always redacted regardless of caller permission.
220
+ # Retrieve a single forwarder by id. Returns 404 if no forwarder with that id exists in the caller's account, including if the forwarder is soft-deleted. Header values in the response are returned in plaintext so callers can perform a GET-modify-PUT round-trip without re-entering secrets (ADR-014). The persisted ``forwarder_delivery.request`` log column is what keeps redaction; that read path is unaffected by this route.
221
221
  # @param forwarder_id [String]
222
222
  # @param [Hash] opts the optional parameters
223
223
  # @return [ForwarderResponse]
@@ -227,7 +227,7 @@ module SmplkitGeneratedClient::Audit
227
227
  end
228
228
 
229
229
  # Get Forwarder
230
- # Retrieve a single forwarder by id. Returns 404 if no forwarder with that id exists in the caller's account, including if the forwarder is soft-deleted. Header values in the response are always redacted regardless of caller permission.
230
+ # Retrieve a single forwarder by id. Returns 404 if no forwarder with that id exists in the caller's account, including if the forwarder is soft-deleted. Header values in the response are returned in plaintext so callers can perform a GET-modify-PUT round-trip without re-entering secrets (ADR-014). The persisted ``forwarder_delivery.request`` log column is what keeps redaction; that read path is unaffected by this route.
231
231
  # @param forwarder_id [String]
232
232
  # @param [Hash] opts the optional parameters
233
233
  # @return [Array<(ForwarderResponse, Integer, Hash)>] ForwarderResponse data, response status code and response headers
@@ -564,7 +564,7 @@ module SmplkitGeneratedClient::Audit
564
564
  end
565
565
 
566
566
  # Update Forwarder
567
- # Full-replace update. PUT semantics — every field is overwritten. The header values must be re-supplied; the GET path redacts them, but a PUT body that contains ``\"<redacted>\"`` would persist that literal. Customers must round-trip the actual secret back. This is the standard get-mutate-put pattern (see CLAUDE.md \"Updating Resources via the API\"); the SDK helpers track the un-redacted secret client-side so customers don't usually need to re-enter it.
567
+ # Full-replace update. PUT semantics — every field is overwritten. The GET path returns plaintext header values, so the standard get-mutate-put round-trip (ADR-014) preserves secrets without any extra work from the caller: GET, change one field, PUT the result.
568
568
  # @param forwarder_id [String]
569
569
  # @param forwarder_response [ForwarderResponse]
570
570
  # @param [Hash] opts the optional parameters
@@ -575,7 +575,7 @@ module SmplkitGeneratedClient::Audit
575
575
  end
576
576
 
577
577
  # Update Forwarder
578
- # Full-replace update. PUT semantics — every field is overwritten. The header values must be re-supplied; the GET path redacts them, but a PUT body that contains &#x60;&#x60;\&quot;&lt;redacted&gt;\&quot;&#x60;&#x60; would persist that literal. Customers must round-trip the actual secret back. This is the standard get-mutate-put pattern (see CLAUDE.md \&quot;Updating Resources via the API\&quot;); the SDK helpers track the un-redacted secret client-side so customers don&#39;t usually need to re-enter it.
578
+ # Full-replace update. PUT semantics — every field is overwritten. The GET path returns plaintext header values, so the standard get-mutate-put round-trip (ADR-014) preserves secrets without any extra work from the caller: GET, change one field, PUT the result.
579
579
  # @param forwarder_id [String]
580
580
  # @param forwarder_response [ForwarderResponse]
581
581
  # @param [Hash] opts the optional parameters
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
- # Public-facing event resource. Attribute set on POST /api/v1/events: - action (required) - resource_type (required) - resource_id (required) - occurred_at (optional; defaults to ``created_at``) - snapshot (optional) - data (optional; defaults to ``{}``) Attribute set on GET responses includes everything above plus the server-populated fields: ``created_at``, ``actor_type``, ``actor_id``, ``actor_label``, ``idempotency_key``.
17
+ # Public-facing event resource. Attribute set on POST /api/v1/events: - action (required) - resource_type (required) - resource_id (required) - occurred_at (optional; defaults to ``created_at``) - data (optional; defaults to ``{}``) There is no top-level ``snapshot`` attribute. Customers wishing to record a resource snapshot place it inside ``data`` -- smplkit's internal convention nests it at ``data.snapshot``, but customers may follow their own convention. Attribute set on GET responses includes everything above plus the server-populated fields: ``created_at``, ``actor_type``, ``actor_id``, ``actor_label``, ``idempotency_key``.
18
18
  class Event < ApiModelBase
19
19
  attr_accessor :action
20
20
 
@@ -24,8 +24,6 @@ module SmplkitGeneratedClient::Audit
24
24
 
25
25
  attr_accessor :occurred_at
26
26
 
27
- attr_accessor :snapshot
28
-
29
27
  attr_accessor :data
30
28
 
31
29
  # When true, this event is recorded normally but is not forwarded to any configured SIEM forwarder. A forwarder_delivery row with status=skipped_do_not_forward is recorded for each enabled forwarder so the skip is visible in the delivery log.
@@ -48,7 +46,6 @@ module SmplkitGeneratedClient::Audit
48
46
  :'resource_type' => :'resource_type',
49
47
  :'resource_id' => :'resource_id',
50
48
  :'occurred_at' => :'occurred_at',
51
- :'snapshot' => :'snapshot',
52
49
  :'data' => :'data',
53
50
  :'do_not_forward' => :'do_not_forward',
54
51
  :'created_at' => :'created_at',
@@ -76,7 +73,6 @@ module SmplkitGeneratedClient::Audit
76
73
  :'resource_type' => :'String',
77
74
  :'resource_id' => :'String',
78
75
  :'occurred_at' => :'Time',
79
- :'snapshot' => :'Hash<String, Object>',
80
76
  :'data' => :'Hash<String, Object>',
81
77
  :'do_not_forward' => :'Boolean',
82
78
  :'created_at' => :'Time',
@@ -91,7 +87,6 @@ module SmplkitGeneratedClient::Audit
91
87
  def self.openapi_nullable
92
88
  Set.new([
93
89
  :'occurred_at',
94
- :'snapshot',
95
90
  :'created_at',
96
91
  :'actor_type',
97
92
  :'actor_id',
@@ -138,12 +133,6 @@ module SmplkitGeneratedClient::Audit
138
133
  self.occurred_at = attributes[:'occurred_at']
139
134
  end
140
135
 
141
- if attributes.key?(:'snapshot')
142
- if (value = attributes[:'snapshot']).is_a?(Hash)
143
- self.snapshot = value
144
- end
145
- end
146
-
147
136
  if attributes.key?(:'data')
148
137
  if (value = attributes[:'data']).is_a?(Hash)
149
138
  self.data = value
@@ -273,7 +262,6 @@ module SmplkitGeneratedClient::Audit
273
262
  resource_type == o.resource_type &&
274
263
  resource_id == o.resource_id &&
275
264
  occurred_at == o.occurred_at &&
276
- snapshot == o.snapshot &&
277
265
  data == o.data &&
278
266
  do_not_forward == o.do_not_forward &&
279
267
  created_at == o.created_at &&
@@ -292,7 +280,7 @@ module SmplkitGeneratedClient::Audit
292
280
  # Calculates hash code according to all attributes.
293
281
  # @return [Integer] Hash code
294
282
  def hash
295
- [action, resource_type, resource_id, occurred_at, snapshot, data, do_not_forward, created_at, actor_type, actor_id, actor_label, idempotency_key].hash
283
+ [action, resource_type, resource_id, occurred_at, data, do_not_forward, created_at, actor_type, actor_id, actor_label, idempotency_key].hash
296
284
  end
297
285
 
298
286
  # Builds the object from hash
@@ -70,7 +70,7 @@ describe 'ForwardersApi' do
70
70
 
71
71
  # unit tests for get_forwarder
72
72
  # Get Forwarder
73
- # Retrieve a single forwarder by id. Returns 404 if no forwarder with that id exists in the caller&#39;s account, including if the forwarder is soft-deleted. Header values in the response are always redacted regardless of caller permission.
73
+ # Retrieve a single forwarder by id. Returns 404 if no forwarder with that id exists in the caller&#39;s account, including if the forwarder is soft-deleted. Header values in the response are returned in plaintext so callers can perform a GET-modify-PUT round-trip without re-entering secrets (ADR-014). The persisted &#x60;&#x60;forwarder_delivery.request&#x60;&#x60; log column is what keeps redaction; that read path is unaffected by this route.
74
74
  # @param forwarder_id
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @return [ForwarderResponse]
@@ -138,7 +138,7 @@ describe 'ForwardersApi' do
138
138
 
139
139
  # unit tests for update_forwarder
140
140
  # Update Forwarder
141
- # Full-replace update. PUT semantics — every field is overwritten. The header values must be re-supplied; the GET path redacts them, but a PUT body that contains &#x60;&#x60;\&quot;&lt;redacted&gt;\&quot;&#x60;&#x60; would persist that literal. Customers must round-trip the actual secret back. This is the standard get-mutate-put pattern (see CLAUDE.md \&quot;Updating Resources via the API\&quot;); the SDK helpers track the un-redacted secret client-side so customers don&#39;t usually need to re-enter it.
141
+ # Full-replace update. PUT semantics — every field is overwritten. The GET path returns plaintext header values, so the standard get-mutate-put round-trip (ADR-014) preserves secrets without any extra work from the caller: GET, change one field, PUT the result.
142
142
  # @param forwarder_id
143
143
  # @param forwarder_response
144
144
  # @param [Hash] opts the optional parameters
@@ -51,12 +51,6 @@ describe SmplkitGeneratedClient::Audit::Event do
51
51
  end
52
52
  end
53
53
 
54
- describe 'test attribute "snapshot"' do
55
- it 'should work' do
56
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
- end
58
- end
59
-
60
54
  describe 'test attribute "data"' do
61
55
  it 'should work' do
62
56
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -19,7 +19,7 @@ module Smplkit
19
19
  # with +smpl.+ are rejected by the server with a 403 (the buffer
20
20
  # logs and drops permanent failures).
21
21
  def record(action:, resource_type:, resource_id:,
22
- occurred_at: nil, snapshot: nil, data: nil, idempotency_key: nil,
22
+ occurred_at: nil, data: nil, idempotency_key: nil,
23
23
  do_not_forward: false)
24
24
  raise ArgumentError, "action is required" if action.nil? || action.to_s.empty?
25
25
  raise ArgumentError, "resource_type is required" if resource_type.nil? || resource_type.to_s.empty?
@@ -45,7 +45,6 @@ module Smplkit
45
45
  resource_type: resource_type,
46
46
  resource_id: resource_id,
47
47
  occurred_at: normalized_occurred_at,
48
- snapshot: snapshot,
49
48
  data: data || {},
50
49
  do_not_forward: do_not_forward
51
50
  )
@@ -119,7 +118,7 @@ module Smplkit
119
118
  :id, :action, :resource_type, :resource_id,
120
119
  :occurred_at, :created_at,
121
120
  :actor_type, :actor_id, :actor_label,
122
- :snapshot, :data, :idempotency_key, :do_not_forward,
121
+ :data, :idempotency_key, :do_not_forward,
123
122
  keyword_init: true
124
123
  ) do
125
124
  def self.from_resource(resource)
@@ -134,7 +133,6 @@ module Smplkit
134
133
  actor_type: attrs.actor_type,
135
134
  actor_id: attrs.actor_id,
136
135
  actor_label: attrs.actor_label,
137
- snapshot: attrs.snapshot,
138
136
  data: attrs.data || {},
139
137
  idempotency_key: attrs.idempotency_key,
140
138
  do_not_forward: attrs.do_not_forward || false
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: smplkit
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.25
4
+ version: 1.0.27
5
5
  platform: ruby
6
6
  authors:
7
7
  - Smpl Solutions LLC