Skip to content

Commit e686c41

Browse files
feat(api): api update
1 parent ec67b44 commit e686c41

File tree

14 files changed

+361
-5
lines changed

14 files changed

+361
-5
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
configured_endpoints: 18
2-
openapi_spec_hash: 8cd3908ccce472dcb5480c14b290b460
2+
openapi_spec_hash: 539798fac79a1eeebf9ac4faa0492455
33
config_hash: 6dcf08c4324405f152d1da9fc11ab04a

lib/openlayer/models/projects/test_create_params.rb

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,16 @@ class TestCreateParams < Openlayer::Internal::Type::BaseModel
4444
# @return [Boolean, nil]
4545
optional :archived, Openlayer::Internal::Type::Boolean
4646

47+
# @!attribute default_to_all_pipelines
48+
# Whether to apply the test to all pipelines (data sources) or to a specific set
49+
# of pipelines. Only applies to tests that use production data.
50+
#
51+
# @return [Boolean, nil]
52+
optional :default_to_all_pipelines,
53+
Openlayer::Internal::Type::Boolean,
54+
api_name: :defaultToAllPipelines,
55+
nil?: true
56+
4757
# @!attribute delay_window
4858
# The delay window in seconds. Only applies to tests that use production data.
4959
#
@@ -57,6 +67,36 @@ class TestCreateParams < Openlayer::Internal::Type::BaseModel
5767
# @return [Float, nil]
5868
optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true
5969

70+
# @!attribute exclude_pipelines
71+
# Array of pipelines (data sources) to which the test should not be applied. Only
72+
# applies to tests that use production data.
73+
#
74+
# @return [Array<String>, nil]
75+
optional :exclude_pipelines,
76+
Openlayer::Internal::Type::ArrayOf[String],
77+
api_name: :excludePipelines,
78+
nil?: true
79+
80+
# @!attribute include_historical_data
81+
# Whether to include historical data in the test result. Only applies to tests
82+
# that use production data.
83+
#
84+
# @return [Boolean, nil]
85+
optional :include_historical_data,
86+
Openlayer::Internal::Type::Boolean,
87+
api_name: :includeHistoricalData,
88+
nil?: true
89+
90+
# @!attribute include_pipelines
91+
# Array of pipelines (data sources) to which the test should be applied. Only
92+
# applies to tests that use production data.
93+
#
94+
# @return [Array<String>, nil]
95+
optional :include_pipelines,
96+
Openlayer::Internal::Type::ArrayOf[String],
97+
api_name: :includePipelines,
98+
nil?: true
99+
60100
# @!attribute uses_ml_model
61101
# Whether the test uses an ML model.
62102
#
@@ -89,7 +129,7 @@ class TestCreateParams < Openlayer::Internal::Type::BaseModel
89129
Openlayer::Internal::Type::Boolean,
90130
api_name: :usesValidationDataset
91131

92-
# @!method initialize(description:, name:, subtype:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil, request_options: {})
132+
# @!method initialize(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: {})
93133
# Some parameter documentations has been truncated, see
94134
# {Openlayer::Models::Projects::TestCreateParams} for more details.
95135
#
@@ -105,10 +145,18 @@ class TestCreateParams < Openlayer::Internal::Type::BaseModel
105145
#
106146
# @param archived [Boolean] Whether the test is archived.
107147
#
148+
# @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
149+
#
108150
# @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
109151
#
110152
# @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
111153
#
154+
# @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
155+
#
156+
# @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
157+
#
158+
# @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
159+
#
112160
# @param uses_ml_model [Boolean] Whether the test uses an ML model.
113161
#
114162
# @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

lib/openlayer/models/projects/test_create_response.rb

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ class TestCreateResponse < Openlayer::Internal::Type::BaseModel
4141
# @return [Boolean, nil]
4242
optional :archived, Openlayer::Internal::Type::Boolean
4343

44+
# @!attribute default_to_all_pipelines
45+
# Whether to apply the test to all pipelines (data sources) or to a specific set
46+
# of pipelines. Only applies to tests that use production data.
47+
#
48+
# @return [Boolean, nil]
49+
optional :default_to_all_pipelines,
50+
Openlayer::Internal::Type::Boolean,
51+
api_name: :defaultToAllPipelines,
52+
nil?: true
53+
4454
# @!attribute delay_window
4555
# The delay window in seconds. Only applies to tests that use production data.
4656
#
@@ -54,6 +64,36 @@ class TestCreateResponse < Openlayer::Internal::Type::BaseModel
5464
# @return [Float, nil]
5565
optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true
5666

67+
# @!attribute exclude_pipelines
68+
# Array of pipelines (data sources) to which the test should not be applied. Only
69+
# applies to tests that use production data.
70+
#
71+
# @return [Array<String>, nil]
72+
optional :exclude_pipelines,
73+
Openlayer::Internal::Type::ArrayOf[String],
74+
api_name: :excludePipelines,
75+
nil?: true
76+
77+
# @!attribute include_historical_data
78+
# Whether to include historical data in the test result. Only applies to tests
79+
# that use production data.
80+
#
81+
# @return [Boolean, nil]
82+
optional :include_historical_data,
83+
Openlayer::Internal::Type::Boolean,
84+
api_name: :includeHistoricalData,
85+
nil?: true
86+
87+
# @!attribute include_pipelines
88+
# Array of pipelines (data sources) to which the test should be applied. Only
89+
# applies to tests that use production data.
90+
#
91+
# @return [Array<String>, nil]
92+
optional :include_pipelines,
93+
Openlayer::Internal::Type::ArrayOf[String],
94+
api_name: :includePipelines,
95+
nil?: true
96+
5797
# @!attribute uses_ml_model
5898
# Whether the test uses an ML model.
5999
#
@@ -142,7 +182,7 @@ class TestCreateResponse < Openlayer::Internal::Type::BaseModel
142182
required :suggested, Openlayer::Internal::Type::Boolean
143183
end
144184

145-
# @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil)
185+
# @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, 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)
146186
# Some parameter documentations has been truncated, see
147187
# {Openlayer::Models::Projects::TestCreateResponse} for more details.
148188
#
@@ -176,10 +216,18 @@ class TestCreateResponse < Openlayer::Internal::Type::BaseModel
176216
#
177217
# @param archived [Boolean] Whether the test is archived.
178218
#
219+
# @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
220+
#
179221
# @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
180222
#
181223
# @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
182224
#
225+
# @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
226+
#
227+
# @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
228+
#
229+
# @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
230+
#
183231
# @param uses_ml_model [Boolean] Whether the test uses an ML model.
184232
#
185233
# @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

lib/openlayer/models/projects/test_list_response.rb

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ class Item < Openlayer::Internal::Type::BaseModel
5151
# @return [Boolean, nil]
5252
optional :archived, Openlayer::Internal::Type::Boolean
5353

54+
# @!attribute default_to_all_pipelines
55+
# Whether to apply the test to all pipelines (data sources) or to a specific set
56+
# of pipelines. Only applies to tests that use production data.
57+
#
58+
# @return [Boolean, nil]
59+
optional :default_to_all_pipelines,
60+
Openlayer::Internal::Type::Boolean,
61+
api_name: :defaultToAllPipelines,
62+
nil?: true
63+
5464
# @!attribute delay_window
5565
# The delay window in seconds. Only applies to tests that use production data.
5666
#
@@ -64,6 +74,36 @@ class Item < Openlayer::Internal::Type::BaseModel
6474
# @return [Float, nil]
6575
optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true
6676

77+
# @!attribute exclude_pipelines
78+
# Array of pipelines (data sources) to which the test should not be applied. Only
79+
# applies to tests that use production data.
80+
#
81+
# @return [Array<String>, nil]
82+
optional :exclude_pipelines,
83+
Openlayer::Internal::Type::ArrayOf[String],
84+
api_name: :excludePipelines,
85+
nil?: true
86+
87+
# @!attribute include_historical_data
88+
# Whether to include historical data in the test result. Only applies to tests
89+
# that use production data.
90+
#
91+
# @return [Boolean, nil]
92+
optional :include_historical_data,
93+
Openlayer::Internal::Type::Boolean,
94+
api_name: :includeHistoricalData,
95+
nil?: true
96+
97+
# @!attribute include_pipelines
98+
# Array of pipelines (data sources) to which the test should be applied. Only
99+
# applies to tests that use production data.
100+
#
101+
# @return [Array<String>, nil]
102+
optional :include_pipelines,
103+
Openlayer::Internal::Type::ArrayOf[String],
104+
api_name: :includePipelines,
105+
nil?: true
106+
67107
# @!attribute uses_ml_model
68108
# Whether the test uses an ML model.
69109
#
@@ -154,7 +194,7 @@ class Item < Openlayer::Internal::Type::BaseModel
154194
required :suggested, Openlayer::Internal::Type::Boolean
155195
end
156196

157-
# @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil)
197+
# @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, 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)
158198
# Some parameter documentations has been truncated, see
159199
# {Openlayer::Models::Projects::TestListResponse::Item} for more details.
160200
#
@@ -188,10 +228,18 @@ class Item < Openlayer::Internal::Type::BaseModel
188228
#
189229
# @param archived [Boolean] Whether the test is archived.
190230
#
231+
# @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
232+
#
191233
# @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
192234
#
193235
# @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
194236
#
237+
# @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
238+
#
239+
# @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
240+
#
241+
# @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
242+
#
195243
# @param uses_ml_model [Boolean] Whether the test uses an ML model.
196244
#
197245
# @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

lib/openlayer/resources/projects/tests.rb

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class Tests
99
#
1010
# Create a test.
1111
#
12-
# @overload create(project_id, description:, name:, subtype:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil, request_options: {})
12+
# @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: {})
1313
#
1414
# @param project_id [String] The project id.
1515
#
@@ -25,10 +25,18 @@ class Tests
2525
#
2626
# @param archived [Boolean] Whether the test is archived.
2727
#
28+
# @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
29+
#
2830
# @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
2931
#
3032
# @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
3133
#
34+
# @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
35+
#
36+
# @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
37+
#
38+
# @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
39+
#
3240
# @param uses_ml_model [Boolean] Whether the test uses an ML model.
3341
#
3442
# @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

0 commit comments

Comments
 (0)