smplkit 2.0.10 → 2.0.11

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.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/lib/smplkit/_generated/config/lib/smplkit_config_client/api/configs_api.rb +28 -28
  3. data/lib/smplkit/_generated/config/lib/smplkit_config_client/api/usage_api.rb +4 -4
  4. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb +8 -0
  5. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_definition.rb +3 -1
  6. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_override.rb +1 -1
  7. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_list_response.rb +1 -0
  8. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_request.rb +165 -0
  9. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_resource.rb +1 -0
  10. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_response.rb +1 -0
  11. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/environment_override.rb +2 -1
  12. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/usage_attributes.rb +4 -0
  13. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/usage_list_response.rb +1 -0
  14. data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/usage_resource.rb +1 -0
  15. data/lib/smplkit/_generated/config/lib/smplkit_config_client.rb +1 -0
  16. data/lib/smplkit/_generated/config/spec/api/configs_api_spec.rb +7 -7
  17. data/lib/smplkit/_generated/config/spec/api/usage_api_spec.rb +2 -2
  18. data/lib/smplkit/_generated/config/spec/models/config_request_spec.rb +36 -0
  19. metadata +3 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 401feca02e6c8251cc6f4b29c9c282e018f95ebce9fb7279bb9c5ab692566749
4
- data.tar.gz: fbf60dda5f375e36b3b395310753292a4fd9cdbcdb842858138837af00389a0e
3
+ metadata.gz: 11d1397bb7c77eeb63a28eb21bf9aab0688feffe5e8df6339c363511713ac843
4
+ data.tar.gz: 8efcc6ad6061be18bbf48fb5993dffd693a9f2b1243a0b091fde72fbe46830c5
5
5
  SHA512:
6
- metadata.gz: bac81cd0fbf412dbc0c9eb8caec50c3372578d81750380d86a33adfb5266a02364b332b387e208ba909a0262962d0b78a45952fd8342c3e033311a835f36832b
7
- data.tar.gz: 71fe3d6cab4ddc813f0bc2cd5c77fa32922c426d50a6921868822087fade11fd2bc7757ae1ba94860d1bf1007267ebbeef38e1940dc6f8324efec390706ec0df
6
+ metadata.gz: 936f0a2efbad65c8a7904b18ed28e0508892bbd4d641e6ed7774eba0df22c1c64aabe7f24780e0f2f31e5303905b58c3464122bff83f7c18863e81a3fcfe3dca
7
+ data.tar.gz: a0ec336127cd5a0d72bc943d0dda7e5df277cc010d4e6641699136b8d8eaecdad0b3eeab94f6c4ac54f5117109930b90f07e3e5df99f86724385a042b6a4099b
@@ -20,27 +20,27 @@ module SmplkitGeneratedClient::Config
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Config
23
- # Create a new configuration. The caller provides the id (key) in the request body.
24
- # @param config_response [ConfigResponse]
23
+ # Create a config for this account. The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
24
+ # @param config_request [ConfigRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [ConfigResponse]
27
- def create_config(config_response, opts = {})
28
- data, _status_code, _headers = create_config_with_http_info(config_response, opts)
27
+ def create_config(config_request, opts = {})
28
+ data, _status_code, _headers = create_config_with_http_info(config_request, opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Create Config
33
- # Create a new configuration. The caller provides the id (key) in the request body.
34
- # @param config_response [ConfigResponse]
33
+ # Create a config for this account. The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
34
+ # @param config_request [ConfigRequest]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
37
- def create_config_with_http_info(config_response, opts = {})
37
+ def create_config_with_http_info(config_request, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: ConfigsApi.create_config ...'
40
40
  end
41
- # verify the required parameter 'config_response' is set
42
- if @api_client.config.client_side_validation && config_response.nil?
43
- fail ArgumentError, "Missing the required parameter 'config_response' when calling ConfigsApi.create_config"
41
+ # verify the required parameter 'config_request' is set
42
+ if @api_client.config.client_side_validation && config_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'config_request' when calling ConfigsApi.create_config"
44
44
  end
45
45
  # resource path
46
46
  local_var_path = '/api/v1/configs'
@@ -62,7 +62,7 @@ module SmplkitGeneratedClient::Config
62
62
  form_params = opts[:form_params] || {}
63
63
 
64
64
  # http body (model)
65
- post_body = opts[:debug_body] || @api_client.object_to_http_body(config_response)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(config_request)
66
66
 
67
67
  # return_type
68
68
  return_type = opts[:debug_return_type] || 'ConfigResponse'
@@ -88,7 +88,7 @@ module SmplkitGeneratedClient::Config
88
88
  end
89
89
 
90
90
  # Delete Config
91
- # Delete a configuration by its key.
91
+ # Delete a config by its key. A config that is referenced as `parent` by another config cannot be deleted; reparent or remove the parent reference on every child first. The `common` config cannot be deleted.
92
92
  # @param id [String]
93
93
  # @param [Hash] opts the optional parameters
94
94
  # @return [nil]
@@ -98,7 +98,7 @@ module SmplkitGeneratedClient::Config
98
98
  end
99
99
 
100
100
  # Delete Config
101
- # Delete a configuration by its key.
101
+ # Delete a config by its key. A config that is referenced as &#x60;parent&#x60; by another config cannot be deleted; reparent or remove the parent reference on every child first. The &#x60;common&#x60; config cannot be deleted.
102
102
  # @param id [String]
103
103
  # @param [Hash] opts the optional parameters
104
104
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -149,7 +149,7 @@ module SmplkitGeneratedClient::Config
149
149
  end
150
150
 
151
151
  # Get Config
152
- # Return a configuration by its key.
152
+ # Retrieve a single config by its key.
153
153
  # @param id [String]
154
154
  # @param [Hash] opts the optional parameters
155
155
  # @return [ConfigResponse]
@@ -159,7 +159,7 @@ module SmplkitGeneratedClient::Config
159
159
  end
160
160
 
161
161
  # Get Config
162
- # Return a configuration by its key.
162
+ # Retrieve a single config by its key.
163
163
  # @param id [String]
164
164
  # @param [Hash] opts the optional parameters
165
165
  # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
@@ -212,7 +212,7 @@ module SmplkitGeneratedClient::Config
212
212
  end
213
213
 
214
214
  # List Configs
215
- # List all configurations for the authenticated account.
215
+ # List configs for this account. Pass `filter[parent]=<parent_key>` to return only the direct children of a specific config.
216
216
  # @param [Hash] opts the optional parameters
217
217
  # @option opts [String] :filter_parent
218
218
  # @return [ConfigListResponse]
@@ -222,7 +222,7 @@ module SmplkitGeneratedClient::Config
222
222
  end
223
223
 
224
224
  # List Configs
225
- # List all configurations for the authenticated account.
225
+ # List configs for this account. Pass &#x60;filter[parent]&#x3D;&lt;parent_key&gt;&#x60; to return only the direct children of a specific config.
226
226
  # @param [Hash] opts the optional parameters
227
227
  # @option opts [String] :filter_parent
228
228
  # @return [Array<(ConfigListResponse, Integer, Hash)>] ConfigListResponse data, response status code and response headers
@@ -272,23 +272,23 @@ module SmplkitGeneratedClient::Config
272
272
  end
273
273
 
274
274
  # Update Config
275
- # Replace a configuration entirely.
275
+ # Replace a config entirely. Every writable field is overwritten.
276
276
  # @param id [String]
277
- # @param config_response [ConfigResponse]
277
+ # @param config_request [ConfigRequest]
278
278
  # @param [Hash] opts the optional parameters
279
279
  # @return [ConfigResponse]
280
- def update_config(id, config_response, opts = {})
281
- data, _status_code, _headers = update_config_with_http_info(id, config_response, opts)
280
+ def update_config(id, config_request, opts = {})
281
+ data, _status_code, _headers = update_config_with_http_info(id, config_request, opts)
282
282
  data
283
283
  end
284
284
 
285
285
  # Update Config
286
- # Replace a configuration entirely.
286
+ # Replace a config entirely. Every writable field is overwritten.
287
287
  # @param id [String]
288
- # @param config_response [ConfigResponse]
288
+ # @param config_request [ConfigRequest]
289
289
  # @param [Hash] opts the optional parameters
290
290
  # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
291
- def update_config_with_http_info(id, config_response, opts = {})
291
+ def update_config_with_http_info(id, config_request, opts = {})
292
292
  if @api_client.config.debugging
293
293
  @api_client.config.logger.debug 'Calling API: ConfigsApi.update_config ...'
294
294
  end
@@ -296,9 +296,9 @@ module SmplkitGeneratedClient::Config
296
296
  if @api_client.config.client_side_validation && id.nil?
297
297
  fail ArgumentError, "Missing the required parameter 'id' when calling ConfigsApi.update_config"
298
298
  end
299
- # verify the required parameter 'config_response' is set
300
- if @api_client.config.client_side_validation && config_response.nil?
301
- fail ArgumentError, "Missing the required parameter 'config_response' when calling ConfigsApi.update_config"
299
+ # verify the required parameter 'config_request' is set
300
+ if @api_client.config.client_side_validation && config_request.nil?
301
+ fail ArgumentError, "Missing the required parameter 'config_request' when calling ConfigsApi.update_config"
302
302
  end
303
303
  # resource path
304
304
  local_var_path = '/api/v1/configs/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -320,7 +320,7 @@ module SmplkitGeneratedClient::Config
320
320
  form_params = opts[:form_params] || {}
321
321
 
322
322
  # http body (model)
323
- post_body = opts[:debug_body] || @api_client.object_to_http_body(config_response)
323
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(config_request)
324
324
 
325
325
  # return_type
326
326
  return_type = opts[:debug_return_type] || 'ConfigResponse'
@@ -20,9 +20,9 @@ module SmplkitGeneratedClient::Config
20
20
  @api_client = api_client
21
21
  end
22
22
  # List Config Usage
23
- # Return current resource usage counts for the authenticated account.
23
+ # Report the current-period usage counters for this account.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [String] :filter_period
25
+ # @option opts [String] :filter_period Period to report. &#x60;current&#x60; is the only supported value.
26
26
  # @return [UsageListResponse]
27
27
  def list_config_usage(opts = {})
28
28
  data, _status_code, _headers = list_config_usage_with_http_info(opts)
@@ -30,9 +30,9 @@ module SmplkitGeneratedClient::Config
30
30
  end
31
31
 
32
32
  # List Config Usage
33
- # Return current resource usage counts for the authenticated account.
33
+ # Report the current-period usage counters for this account.
34
34
  # @param [Hash] opts the optional parameters
35
- # @option opts [String] :filter_period
35
+ # @option opts [String] :filter_period Period to report. &#x60;current&#x60; is the only supported value.
36
36
  # @return [Array<(UsageListResponse, Integer, Hash)>] UsageListResponse data, response status code and response headers
37
37
  def list_config_usage_with_http_info(opts = {})
38
38
  if @api_client.config.debugging
@@ -14,19 +14,27 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # A named bag of configuration items, optionally inheriting from another config. Items are typed key/value pairs (`STRING`, `NUMBER`, `BOOLEAN`, `JSON`). Configs may declare per-environment overrides for any item declared on the config itself or anywhere in its inheritance chain; resolving a config against an environment merges the chain top-down and then applies the matching overrides.
17
18
  class Config < ApiModelBase
19
+ # Human-readable name for the config.
18
20
  attr_accessor :name
19
21
 
22
+ # Optional human-readable description of what this config holds.
20
23
  attr_accessor :description
21
24
 
25
+ # Key of another config to inherit items from. Inherited items appear as if declared on this config; locally declared items with the same key shadow them. Omit or set to `null` for a standalone config with no parent.
22
26
  attr_accessor :parent
23
27
 
28
+ # Map of item keys to item definitions declared on this config. Keys must be unique within the config; declared types are immutable once set and must match any type declared for the same key on an ancestor.
24
29
  attr_accessor :items
25
30
 
31
+ # Map of environment keys to per-environment override sets. An environment override applies when this config is resolved against that environment.
26
32
  attr_accessor :environments
27
33
 
34
+ # When the config was created.
28
35
  attr_accessor :created_at
29
36
 
37
+ # When the config was last modified.
30
38
  attr_accessor :updated_at
31
39
 
32
40
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,12 +14,14 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
- # Schema for a single config item. ``value`` may be ``None`` to represent a cleared (typed but unset) slot e.g. after a type change that could not coerce the previous value. See ADR-024.
17
+ # Type-declared item within a config. Each item carries a value plus a declared type that constrains the value and any per-environment overrides for the same key.
18
18
  class ConfigItemDefinition < ApiModelBase
19
19
  attr_accessor :value
20
20
 
21
+ # Declared value type. Constrains the JSON shape of `value` and of every override of this key in the `environments` map.
21
22
  attr_accessor :type
22
23
 
24
+ # Optional human-readable explanation of what this item controls.
23
25
  attr_accessor :description
24
26
 
25
27
  class EnumAttributeValidator
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
- # Schema for an environment override value only, no type/description.
17
+ # Per-environment override of a single item value.
18
18
  class ConfigItemOverride < ApiModelBase
19
19
  attr_accessor :value
20
20
 
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # JSON:API collection response for configs.
17
18
  class ConfigListResponse < ApiModelBase
18
19
  attr_accessor :data
19
20
 
@@ -0,0 +1,165 @@
1
+ =begin
2
+ #smplkit Config API
3
+
4
+ #Configuration management API for smplkit.
5
+
6
+ The version of the OpenAPI document: 0.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module SmplkitGeneratedClient::Config
17
+ # JSON:API request envelope for creating or updating a config.
18
+ class ConfigRequest < ApiModelBase
19
+ attr_accessor :data
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'data' => :'data'
25
+ }
26
+ end
27
+
28
+ # Returns attribute mapping this model knows about
29
+ def self.acceptable_attribute_map
30
+ attribute_map
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ acceptable_attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'data' => :'ConfigResource'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Config::ConfigRequest` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ acceptable_attribute_map = self.class.acceptable_attribute_map
60
+ attributes = attributes.each_with_object({}) { |(k, v), h|
61
+ if (!acceptable_attribute_map.key?(k.to_sym))
62
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Config::ConfigRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
63
+ end
64
+ h[k.to_sym] = v
65
+ }
66
+
67
+ if attributes.key?(:'data')
68
+ self.data = attributes[:'data']
69
+ else
70
+ self.data = nil
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
78
+ invalid_properties = Array.new
79
+ if @data.nil?
80
+ invalid_properties.push('invalid value for "data", data cannot be nil.')
81
+ end
82
+
83
+ invalid_properties
84
+ end
85
+
86
+ # Check to see if the all the properties in the model are valid
87
+ # @return true if the model is valid
88
+ def valid?
89
+ warn '[DEPRECATED] the `valid?` method is obsolete'
90
+ return false if @data.nil?
91
+ true
92
+ end
93
+
94
+ # Custom attribute writer method with validation
95
+ # @param [Object] data Value to be assigned
96
+ def data=(data)
97
+ if data.nil?
98
+ fail ArgumentError, 'data cannot be nil'
99
+ end
100
+
101
+ @data = data
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ data == o.data
110
+ end
111
+
112
+ # @see the `==` method
113
+ # @param [Object] Object to be compared
114
+ def eql?(o)
115
+ self == o
116
+ end
117
+
118
+ # Calculates hash code according to all attributes.
119
+ # @return [Integer] Hash code
120
+ def hash
121
+ [data].hash
122
+ end
123
+
124
+ # Builds the object from hash
125
+ # @param [Hash] attributes Model attributes in the form of hash
126
+ # @return [Object] Returns the model itself
127
+ def self.build_from_hash(attributes)
128
+ return nil unless attributes.is_a?(Hash)
129
+ attributes = attributes.transform_keys(&:to_sym)
130
+ transformed_hash = {}
131
+ openapi_types.each_pair do |key, type|
132
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
133
+ transformed_hash["#{key}"] = nil
134
+ elsif type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[attribute_map[key]].is_a?(Array)
138
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
139
+ end
140
+ elsif !attributes[attribute_map[key]].nil?
141
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
142
+ end
143
+ end
144
+ new(transformed_hash)
145
+ end
146
+
147
+ # Returns the object in the form of hash
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_hash
150
+ hash = {}
151
+ self.class.attribute_map.each_pair do |attr, param|
152
+ value = self.send(attr)
153
+ if value.nil?
154
+ is_nullable = self.class.openapi_nullable.include?(attr)
155
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
156
+ end
157
+
158
+ hash[param] = _to_hash(value)
159
+ end
160
+ hash
161
+ end
162
+
163
+ end
164
+
165
+ end
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # JSON:API resource envelope for a config. `id` is the human-readable key for the config and must be supplied by the caller on create. It is unique within the account.
17
18
  class ConfigResource < ApiModelBase
18
19
  attr_accessor :id
19
20
 
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # JSON:API single-resource response envelope for a config.
17
18
  class ConfigResponse < ApiModelBase
18
19
  attr_accessor :data
19
20
 
@@ -14,8 +14,9 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
- # Schema for per-environment overrides.
17
+ # Per-environment override set for a config.
18
18
  class EnvironmentOverride < ApiModelBase
19
+ # Map of item keys to override values that apply when this environment is resolved. Each key must already be declared (with a type) on this config or one of its ancestors.
19
20
  attr_accessor :values
20
21
 
21
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,11 +14,15 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # Usage counter for a single metered limit.
17
18
  class UsageAttributes < ApiModelBase
19
+ # Identifier of the metered limit, e.g. `config.items` or `config.inheritance_depth`.
18
20
  attr_accessor :limit_key
19
21
 
22
+ # Period the counter covers. `current` is the only supported value.
20
23
  attr_accessor :period
21
24
 
25
+ # Count for the period.
22
26
  attr_accessor :value
23
27
 
24
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # JSON:API collection response for usage counters.
17
18
  class UsageListResponse < ApiModelBase
18
19
  attr_accessor :data
19
20
 
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Config
17
+ # JSON:API resource envelope for a usage counter.
17
18
  class UsageResource < ApiModelBase
18
19
  attr_accessor :id
19
20
 
@@ -22,6 +22,7 @@ require 'smplkit_config_client/models/config'
22
22
  require 'smplkit_config_client/models/config_item_definition'
23
23
  require 'smplkit_config_client/models/config_item_override'
24
24
  require 'smplkit_config_client/models/config_list_response'
25
+ require 'smplkit_config_client/models/config_request'
25
26
  require 'smplkit_config_client/models/config_resource'
26
27
  require 'smplkit_config_client/models/config_response'
27
28
  require 'smplkit_config_client/models/environment_override'
@@ -34,8 +34,8 @@ describe 'ConfigsApi' do
34
34
 
35
35
  # unit tests for create_config
36
36
  # Create Config
37
- # Create a new configuration. The caller provides the id (key) in the request body.
38
- # @param config_response
37
+ # Create a config for this account. The caller supplies the config&#39;s key as &#x60;data.id&#x60;. Keys are unique within an account and immutable for the lifetime of the config.
38
+ # @param config_request
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [ConfigResponse]
41
41
  describe 'create_config test' do
@@ -46,7 +46,7 @@ describe 'ConfigsApi' do
46
46
 
47
47
  # unit tests for delete_config
48
48
  # Delete Config
49
- # Delete a configuration by its key.
49
+ # Delete a config by its key. A config that is referenced as &#x60;parent&#x60; by another config cannot be deleted; reparent or remove the parent reference on every child first. The &#x60;common&#x60; config cannot be deleted.
50
50
  # @param id
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [nil]
@@ -58,7 +58,7 @@ describe 'ConfigsApi' do
58
58
 
59
59
  # unit tests for get_config
60
60
  # Get Config
61
- # Return a configuration by its key.
61
+ # Retrieve a single config by its key.
62
62
  # @param id
63
63
  # @param [Hash] opts the optional parameters
64
64
  # @return [ConfigResponse]
@@ -70,7 +70,7 @@ describe 'ConfigsApi' do
70
70
 
71
71
  # unit tests for list_configs
72
72
  # List Configs
73
- # List all configurations for the authenticated account.
73
+ # List configs for this account. Pass &#x60;filter[parent]&#x3D;&lt;parent_key&gt;&#x60; to return only the direct children of a specific config.
74
74
  # @param [Hash] opts the optional parameters
75
75
  # @option opts [String] :filter_parent
76
76
  # @return [ConfigListResponse]
@@ -82,9 +82,9 @@ describe 'ConfigsApi' do
82
82
 
83
83
  # unit tests for update_config
84
84
  # Update Config
85
- # Replace a configuration entirely.
85
+ # Replace a config entirely. Every writable field is overwritten.
86
86
  # @param id
87
- # @param config_response
87
+ # @param config_request
88
88
  # @param [Hash] opts the optional parameters
89
89
  # @return [ConfigResponse]
90
90
  describe 'update_config test' do
@@ -34,9 +34,9 @@ describe 'UsageApi' do
34
34
 
35
35
  # unit tests for list_config_usage
36
36
  # List Config Usage
37
- # Return current resource usage counts for the authenticated account.
37
+ # Report the current-period usage counters for this account.
38
38
  # @param [Hash] opts the optional parameters
39
- # @option opts [String] :filter_period
39
+ # @option opts [String] :filter_period Period to report. &#x60;current&#x60; is the only supported value.
40
40
  # @return [UsageListResponse]
41
41
  describe 'list_config_usage test' do
42
42
  it 'should work' do
@@ -0,0 +1,36 @@
1
+ =begin
2
+ #smplkit Config API
3
+
4
+ #Configuration management API for smplkit.
5
+
6
+ The version of the OpenAPI document: 0.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for SmplkitGeneratedClient::Config::ConfigRequest
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe SmplkitGeneratedClient::Config::ConfigRequest do
21
+ #let(:instance) { SmplkitGeneratedClient::Config::ConfigRequest.new }
22
+
23
+ describe 'test an instance of ConfigRequest' do
24
+ it 'should create an instance of ConfigRequest' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(SmplkitGeneratedClient::Config::ConfigRequest)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "data"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ end
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: 2.0.10
4
+ version: 2.0.11
5
5
  platform: ruby
6
6
  authors:
7
7
  - Smpl Solutions LLC
@@ -478,6 +478,7 @@ files:
478
478
  - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_definition.rb
479
479
  - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_override.rb
480
480
  - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_list_response.rb
481
+ - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_request.rb
481
482
  - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_resource.rb
482
483
  - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_response.rb
483
484
  - lib/smplkit/_generated/config/lib/smplkit_config_client/models/environment_override.rb
@@ -490,6 +491,7 @@ files:
490
491
  - lib/smplkit/_generated/config/spec/models/config_item_definition_spec.rb
491
492
  - lib/smplkit/_generated/config/spec/models/config_item_override_spec.rb
492
493
  - lib/smplkit/_generated/config/spec/models/config_list_response_spec.rb
494
+ - lib/smplkit/_generated/config/spec/models/config_request_spec.rb
493
495
  - lib/smplkit/_generated/config/spec/models/config_resource_spec.rb
494
496
  - lib/smplkit/_generated/config/spec/models/config_response_spec.rb
495
497
  - lib/smplkit/_generated/config/spec/models/config_spec.rb