shipeasy-sdk 3.8.0 → 4.0.0
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 +4 -4
- data/docs/skill/SKILL.md +7 -4
- data/lib/shipeasy/admin.rb +23 -20
- data/lib/shipeasy/sdk/see.rb +7 -5
- data/lib/shipeasy/sdk/version.rb +1 -1
- data/lib/shipeasy_admin/api/flags_api.rb +127 -214
- data/lib/shipeasy_admin/api/killswitch_api.rb +25 -525
- data/lib/shipeasy_admin/api/ops_api.rb +44 -351
- data/lib/shipeasy_admin/api_client.rb +2 -2
- data/lib/shipeasy_admin/api_error.rb +2 -2
- data/lib/shipeasy_admin/api_model_base.rb +2 -2
- data/lib/shipeasy_admin/configuration.rb +29 -2
- data/lib/shipeasy_admin/models/{set_killswitch_value_request.rb → add_to_gate_whitelist_request.rb} +37 -42
- data/lib/shipeasy_admin/models/create_public_bug_request.rb +464 -0
- data/lib/shipeasy_admin/models/create_public_feature_request_request.rb +407 -0
- data/lib/shipeasy_admin/models/{file_error_ticket_response.rb → create_public_ticket_response.rb} +22 -29
- data/lib/shipeasy_admin/models/env.rb +2 -2
- data/lib/shipeasy_admin/models/error.rb +41 -7
- data/lib/shipeasy_admin/models/error_code.rb +14 -3
- data/lib/shipeasy_admin/models/{get_experiment_timeseries_response_experiment.rb → gate_whitelist.rb} +51 -42
- data/lib/shipeasy_admin/models/gate_whitelist_attr.rb +40 -0
- data/lib/shipeasy_admin/models/killswitch_value.rb +2 -2
- data/lib/shipeasy_admin/models/notification_target.rb +2 -2
- data/lib/shipeasy_admin/models/notification_target_slack_channel.rb +2 -2
- data/lib/shipeasy_admin/models/ops_item_priority.rb +42 -0
- data/lib/shipeasy_admin/models/ops_item_status.rb +46 -0
- data/lib/shipeasy_admin/models/{discard_config_draft_request.rb → remove_from_gate_whitelist_request.rb} +34 -44
- data/lib/shipeasy_admin/models/{delete_alert_rule_response.rb → set_gate_whitelist_request.rb} +37 -25
- data/lib/shipeasy_admin/models/{set_killswitch_switch_request.rb → toggle_killswitch_request.rb} +30 -72
- data/lib/shipeasy_admin/models/{set_killswitch_value_response.rb → toggle_killswitch_response.rb} +100 -6
- data/lib/shipeasy_admin/version.rb +2 -2
- data/lib/shipeasy_admin.rb +14 -195
- metadata +13 -194
- data/lib/shipeasy_admin/api/alerts_api.rb +0 -352
- data/lib/shipeasy_admin/api/api_keys_api.rb +0 -229
- data/lib/shipeasy_admin/api/attributes_api.rb +0 -82
- data/lib/shipeasy_admin/api/configs_api.rb +0 -757
- data/lib/shipeasy_admin/api/connectors_api.rb +0 -497
- data/lib/shipeasy_admin/api/drafts_api.rb +0 -82
- data/lib/shipeasy_admin/api/errors_api.rb +0 -389
- data/lib/shipeasy_admin/api/events_api.rb +0 -438
- data/lib/shipeasy_admin/api/experiments_api.rb +0 -727
- data/lib/shipeasy_admin/api/keys_api.rb +0 -317
- data/lib/shipeasy_admin/api/metrics_api.rb +0 -281
- data/lib/shipeasy_admin/api/profiles_api.rb +0 -222
- data/lib/shipeasy_admin/api/projects_api.rb +0 -216
- data/lib/shipeasy_admin/api/universes_api.rb +0 -306
- data/lib/shipeasy_admin/models/approve_event_request.rb +0 -198
- data/lib/shipeasy_admin/models/approve_event_response.rb +0 -166
- data/lib/shipeasy_admin/models/claude_trigger_config.rb +0 -204
- data/lib/shipeasy_admin/models/connector_event.rb +0 -40
- data/lib/shipeasy_admin/models/connector_provider.rb +0 -45
- data/lib/shipeasy_admin/models/connector_record.rb +0 -468
- data/lib/shipeasy_admin/models/copilot_trigger_config.rb +0 -276
- data/lib/shipeasy_admin/models/create_alert_rule_request.rb +0 -383
- data/lib/shipeasy_admin/models/create_alert_rule_response.rb +0 -165
- data/lib/shipeasy_admin/models/create_claude_trigger_request.rb +0 -309
- data/lib/shipeasy_admin/models/create_config_request.rb +0 -291
- data/lib/shipeasy_admin/models/create_config_response.rb +0 -201
- data/lib/shipeasy_admin/models/create_connector_request.rb +0 -64
- data/lib/shipeasy_admin/models/create_connector_response.rb +0 -165
- data/lib/shipeasy_admin/models/create_copilot_trigger_request.rb +0 -316
- data/lib/shipeasy_admin/models/create_cursor_trigger_request.rb +0 -352
- data/lib/shipeasy_admin/models/create_event_request.rb +0 -236
- data/lib/shipeasy_admin/models/create_event_response.rb +0 -193
- data/lib/shipeasy_admin/models/create_experiment_request.rb +0 -807
- data/lib/shipeasy_admin/models/create_experiment_response.rb +0 -212
- data/lib/shipeasy_admin/models/create_gate_request.rb +0 -492
- data/lib/shipeasy_admin/models/create_gate_response.rb +0 -212
- data/lib/shipeasy_admin/models/create_i18n_profile_request.rb +0 -188
- data/lib/shipeasy_admin/models/create_i18n_profile_response.rb +0 -193
- data/lib/shipeasy_admin/models/create_jules_trigger_request.rb +0 -352
- data/lib/shipeasy_admin/models/create_key_request.rb +0 -297
- data/lib/shipeasy_admin/models/create_key_response.rb +0 -286
- data/lib/shipeasy_admin/models/create_killswitch_request.rb +0 -274
- data/lib/shipeasy_admin/models/create_killswitch_response.rb +0 -201
- data/lib/shipeasy_admin/models/create_metric_request.rb +0 -403
- data/lib/shipeasy_admin/models/create_metric_response.rb +0 -193
- data/lib/shipeasy_admin/models/create_o_auth_connector_request.rb +0 -273
- data/lib/shipeasy_admin/models/create_ops_item_request.rb +0 -287
- data/lib/shipeasy_admin/models/create_ops_item_response.rb +0 -177
- data/lib/shipeasy_admin/models/create_universe_request.rb +0 -272
- data/lib/shipeasy_admin/models/create_universe_response.rb +0 -212
- data/lib/shipeasy_admin/models/cursor_trigger_config.rb +0 -231
- data/lib/shipeasy_admin/models/delete_config_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_connector_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_event_response.rb +0 -189
- data/lib/shipeasy_admin/models/delete_experiment_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_gate_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_killswitch_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_metric_response.rb +0 -189
- data/lib/shipeasy_admin/models/delete_universe_response.rb +0 -188
- data/lib/shipeasy_admin/models/disable_gate_response.rb +0 -190
- data/lib/shipeasy_admin/models/discard_config_draft_response.rb +0 -188
- data/lib/shipeasy_admin/models/enable_gate_response.rb +0 -190
- data/lib/shipeasy_admin/models/error_record.rb +0 -597
- data/lib/shipeasy_admin/models/error_series_request.rb +0 -251
- data/lib/shipeasy_admin/models/error_series_response.rb +0 -195
- data/lib/shipeasy_admin/models/error_series_response_rows_inner.rb +0 -192
- data/lib/shipeasy_admin/models/experiment_inline_metric.rb +0 -337
- data/lib/shipeasy_admin/models/fire_connector_request.rb +0 -149
- data/lib/shipeasy_admin/models/fire_connector_response.rb +0 -176
- data/lib/shipeasy_admin/models/get_config_response.rb +0 -351
- data/lib/shipeasy_admin/models/get_current_project_response.rb +0 -606
- data/lib/shipeasy_admin/models/get_current_project_response_module_translations.rb +0 -104
- data/lib/shipeasy_admin/models/get_event_response.rb +0 -344
- data/lib/shipeasy_admin/models/get_experiment_response.rb +0 -688
- data/lib/shipeasy_admin/models/get_experiment_results_response.rb +0 -243
- data/lib/shipeasy_admin/models/get_experiment_results_response_experiment.rb +0 -248
- data/lib/shipeasy_admin/models/get_experiment_results_response_results_inner.rb +0 -252
- data/lib/shipeasy_admin/models/get_experiment_timeseries_response.rb +0 -192
- data/lib/shipeasy_admin/models/get_experiment_timeseries_response_series_inner.rb +0 -278
- data/lib/shipeasy_admin/models/get_killswitch_response.rb +0 -270
- data/lib/shipeasy_admin/models/get_metric_response.rb +0 -378
- data/lib/shipeasy_admin/models/get_ops_item_response.rb +0 -349
- data/lib/shipeasy_admin/models/jules_trigger_config.rb +0 -240
- data/lib/shipeasy_admin/models/key_record.rb +0 -353
- data/lib/shipeasy_admin/models/link_pr_to_ops_item_request.rb +0 -186
- data/lib/shipeasy_admin/models/link_pr_to_ops_item_response.rb +0 -166
- data/lib/shipeasy_admin/models/list_alert_rules_response_inner.rb +0 -478
- data/lib/shipeasy_admin/models/list_attributes_response_inner.rb +0 -176
- data/lib/shipeasy_admin/models/list_config_activity_response_inner.rb +0 -280
- data/lib/shipeasy_admin/models/list_configs_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_configs_response_data_inner.rb +0 -351
- data/lib/shipeasy_admin/models/list_configs_response_data_inner_drafts_value.rb +0 -237
- data/lib/shipeasy_admin/models/list_configs_response_data_inner_envs_value.rb +0 -237
- data/lib/shipeasy_admin/models/list_events_response_inner.rb +0 -344
- data/lib/shipeasy_admin/models/list_events_response_inner_properties_inner.rb +0 -259
- data/lib/shipeasy_admin/models/list_experiments_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_experiments_response_data_inner.rb +0 -688
- data/lib/shipeasy_admin/models/list_experiments_response_data_inner_groups_inner.rb +0 -241
- data/lib/shipeasy_admin/models/list_gates_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_gates_response_data_inner.rb +0 -395
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_enabled.rb +0 -104
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_rules_inner.rb +0 -238
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner.rb +0 -105
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of.rb +0 -358
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of1.rb +0 -331
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of_ramp.rb +0 -319
- data/lib/shipeasy_admin/models/list_i18n_drafts_response_inner.rb +0 -272
- data/lib/shipeasy_admin/models/list_i18n_keys_response.rb +0 -195
- data/lib/shipeasy_admin/models/list_i18n_keys_response_keys_inner.rb +0 -274
- data/lib/shipeasy_admin/models/list_i18n_profiles_response_inner.rb +0 -224
- data/lib/shipeasy_admin/models/list_keys_response.rb +0 -180
- data/lib/shipeasy_admin/models/list_killswitches_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_killswitches_response_data_inner.rb +0 -270
- data/lib/shipeasy_admin/models/list_killswitches_response_data_inner_envs_value.rb +0 -248
- data/lib/shipeasy_admin/models/list_metrics_response_inner.rb +0 -378
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir.rb +0 -288
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg.rb +0 -113
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of1.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of2.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of3.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of4.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of5.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of6.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of7.rb +0 -217
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of8.rb +0 -233
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9.rb +0 -240
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator.rb +0 -266
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator_filters_inner.rb +0 -264
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_group_by.rb +0 -228
- data/lib/shipeasy_admin/models/list_ops_items_response_inner.rb +0 -349
- data/lib/shipeasy_admin/models/list_slack_channels_response.rb +0 -195
- data/lib/shipeasy_admin/models/list_slack_channels_response_channels_inner.rb +0 -203
- data/lib/shipeasy_admin/models/list_universes_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_universes_response_data_inner.rb +0 -305
- data/lib/shipeasy_admin/models/notify_ops_request.rb +0 -261
- data/lib/shipeasy_admin/models/notify_ops_response.rb +0 -193
- data/lib/shipeasy_admin/models/publish_config_draft_request.rb +0 -187
- data/lib/shipeasy_admin/models/publish_config_draft_response.rb +0 -257
- data/lib/shipeasy_admin/models/publish_i18n_profile_response.rb +0 -391
- data/lib/shipeasy_admin/models/push_i18n_keys_request.rb +0 -195
- data/lib/shipeasy_admin/models/push_i18n_keys_request_keys_inner.rb +0 -192
- data/lib/shipeasy_admin/models/push_i18n_keys_response.rb +0 -251
- data/lib/shipeasy_admin/models/reanalyze_experiment_response.rb +0 -214
- data/lib/shipeasy_admin/models/revoke_key_response.rb +0 -216
- data/lib/shipeasy_admin/models/save_config_draft_request.rb +0 -199
- data/lib/shipeasy_admin/models/save_config_draft_response.rb +0 -283
- data/lib/shipeasy_admin/models/search_hit.rb +0 -284
- data/lib/shipeasy_admin/models/search_response.rb +0 -167
- data/lib/shipeasy_admin/models/set_experiment_metrics_request.rb +0 -168
- data/lib/shipeasy_admin/models/set_experiment_metrics_request_metrics_inner.rb +0 -216
- data/lib/shipeasy_admin/models/set_experiment_metrics_response.rb +0 -179
- data/lib/shipeasy_admin/models/set_experiment_metrics_response_metrics_inner.rb +0 -201
- data/lib/shipeasy_admin/models/set_experiment_status_request.rb +0 -190
- data/lib/shipeasy_admin/models/set_experiment_status_response.rb +0 -214
- data/lib/shipeasy_admin/models/set_i18n_label_request.rb +0 -213
- data/lib/shipeasy_admin/models/set_i18n_label_response.rb +0 -472
- data/lib/shipeasy_admin/models/set_killswitch_switch_response.rb +0 -285
- data/lib/shipeasy_admin/models/test_connector_response.rb +0 -189
- data/lib/shipeasy_admin/models/unset_killswitch_switch_request.rb +0 -234
- data/lib/shipeasy_admin/models/unset_killswitch_switch_response.rb +0 -286
- data/lib/shipeasy_admin/models/update_alert_rule_request.rb +0 -304
- data/lib/shipeasy_admin/models/update_alert_rule_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_config_request.rb +0 -198
- data/lib/shipeasy_admin/models/update_config_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_config_schema_request.rb +0 -168
- data/lib/shipeasy_admin/models/update_config_schema_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_connector_request.rb +0 -211
- data/lib/shipeasy_admin/models/update_connector_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_error_status_request.rb +0 -190
- data/lib/shipeasy_admin/models/update_event_request.rb +0 -198
- data/lib/shipeasy_admin/models/update_event_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_experiment_request.rb +0 -747
- data/lib/shipeasy_admin/models/update_experiment_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_gate_request.rb +0 -403
- data/lib/shipeasy_admin/models/update_gate_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_i18n_key_request.rb +0 -176
- data/lib/shipeasy_admin/models/update_i18n_key_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_killswitch_request.rb +0 -224
- data/lib/shipeasy_admin/models/update_killswitch_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_ops_item_request.rb +0 -205
- data/lib/shipeasy_admin/models/update_ops_item_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_universe_request.rb +0 -213
- data/lib/shipeasy_admin/models/update_universe_response.rb +0 -165
- data/lib/shipeasy_admin/models/upsert_project_request.rb +0 -222
- data/lib/shipeasy_admin/models/upsert_project_response.rb +0 -260
|
@@ -0,0 +1,407 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Shipeasy Admin API (server-SDK surface)
|
|
3
|
+
|
|
4
|
+
#The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Shipeasy::Admin::Generated
|
|
17
|
+
# Body for `POST /ops/feature-request`. The same feature-request fields as `CreateFeatureRequestRequest`, minus the `type` discriminator — the path already says what is being filed.
|
|
18
|
+
class CreatePublicFeatureRequestRequest < ApiModelBase
|
|
19
|
+
# One-line feature-request title (no leading/trailing whitespace).
|
|
20
|
+
attr_accessor :title
|
|
21
|
+
|
|
22
|
+
# What the feature is.
|
|
23
|
+
attr_accessor :description
|
|
24
|
+
|
|
25
|
+
# Why it's needed / the use case.
|
|
26
|
+
attr_accessor :use_case
|
|
27
|
+
|
|
28
|
+
# Initial triage priority, or `null`.
|
|
29
|
+
attr_accessor :priority
|
|
30
|
+
|
|
31
|
+
# Initial lifecycle status; defaults to `open` when omitted.
|
|
32
|
+
attr_accessor :status
|
|
33
|
+
|
|
34
|
+
# The `users.id` of the person to assign as owner at creation, or `null`.
|
|
35
|
+
attr_accessor :assignee_id
|
|
36
|
+
|
|
37
|
+
# Emails of teammates to subscribe to this item's Slack pings at creation.
|
|
38
|
+
attr_accessor :subscribers
|
|
39
|
+
|
|
40
|
+
# Tag names to attach at creation (get-or-created by name, deduped case-insensitively).
|
|
41
|
+
attr_accessor :tags
|
|
42
|
+
|
|
43
|
+
# Email of the reporter, or `null`.
|
|
44
|
+
attr_accessor :reporter_email
|
|
45
|
+
|
|
46
|
+
# URL of the page the request relates to, or `null`.
|
|
47
|
+
attr_accessor :page_url
|
|
48
|
+
|
|
49
|
+
# Reporter's user-agent string, or `null`.
|
|
50
|
+
attr_accessor :user_agent
|
|
51
|
+
|
|
52
|
+
# Arbitrary capture context, or `null`.
|
|
53
|
+
attr_accessor :context
|
|
54
|
+
|
|
55
|
+
# Where this request's completion notification lands.
|
|
56
|
+
attr_accessor :notify
|
|
57
|
+
|
|
58
|
+
class EnumAttributeValidator
|
|
59
|
+
attr_reader :datatype
|
|
60
|
+
attr_reader :allowable_values
|
|
61
|
+
|
|
62
|
+
def initialize(datatype, allowable_values)
|
|
63
|
+
@allowable_values = allowable_values.map do |value|
|
|
64
|
+
case datatype.to_s
|
|
65
|
+
when /Integer/i
|
|
66
|
+
value.to_i
|
|
67
|
+
when /Float/i
|
|
68
|
+
value.to_f
|
|
69
|
+
else
|
|
70
|
+
value
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def valid?(value)
|
|
76
|
+
!value || allowable_values.include?(value)
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
81
|
+
def self.attribute_map
|
|
82
|
+
{
|
|
83
|
+
:'title' => :'title',
|
|
84
|
+
:'description' => :'description',
|
|
85
|
+
:'use_case' => :'useCase',
|
|
86
|
+
:'priority' => :'priority',
|
|
87
|
+
:'status' => :'status',
|
|
88
|
+
:'assignee_id' => :'assigneeId',
|
|
89
|
+
:'subscribers' => :'subscribers',
|
|
90
|
+
:'tags' => :'tags',
|
|
91
|
+
:'reporter_email' => :'reporterEmail',
|
|
92
|
+
:'page_url' => :'pageUrl',
|
|
93
|
+
:'user_agent' => :'userAgent',
|
|
94
|
+
:'context' => :'context',
|
|
95
|
+
:'notify' => :'notify'
|
|
96
|
+
}
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# Returns attribute mapping this model knows about
|
|
100
|
+
def self.acceptable_attribute_map
|
|
101
|
+
attribute_map
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# Returns all the JSON keys this model knows about
|
|
105
|
+
def self.acceptable_attributes
|
|
106
|
+
acceptable_attribute_map.values
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Attribute type mapping.
|
|
110
|
+
def self.openapi_types
|
|
111
|
+
{
|
|
112
|
+
:'title' => :'String',
|
|
113
|
+
:'description' => :'String',
|
|
114
|
+
:'use_case' => :'String',
|
|
115
|
+
:'priority' => :'OpsItemPriority',
|
|
116
|
+
:'status' => :'OpsItemStatus',
|
|
117
|
+
:'assignee_id' => :'String',
|
|
118
|
+
:'subscribers' => :'Array<String>',
|
|
119
|
+
:'tags' => :'Array<String>',
|
|
120
|
+
:'reporter_email' => :'String',
|
|
121
|
+
:'page_url' => :'String',
|
|
122
|
+
:'user_agent' => :'String',
|
|
123
|
+
:'context' => :'Hash<String, Object>',
|
|
124
|
+
:'notify' => :'NotificationTarget'
|
|
125
|
+
}
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# List of attributes with nullable: true
|
|
129
|
+
def self.openapi_nullable
|
|
130
|
+
Set.new([
|
|
131
|
+
:'priority',
|
|
132
|
+
:'assignee_id',
|
|
133
|
+
:'reporter_email',
|
|
134
|
+
:'page_url',
|
|
135
|
+
:'user_agent',
|
|
136
|
+
:'context',
|
|
137
|
+
:'notify'
|
|
138
|
+
])
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Initializes the object
|
|
142
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
143
|
+
def initialize(attributes = {})
|
|
144
|
+
if (!attributes.is_a?(Hash))
|
|
145
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreatePublicFeatureRequestRequest` initialize method"
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
149
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
150
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
151
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
152
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreatePublicFeatureRequestRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
153
|
+
end
|
|
154
|
+
h[k.to_sym] = v
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
if attributes.key?(:'title')
|
|
158
|
+
self.title = attributes[:'title']
|
|
159
|
+
else
|
|
160
|
+
self.title = nil
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
if attributes.key?(:'description')
|
|
164
|
+
self.description = attributes[:'description']
|
|
165
|
+
else
|
|
166
|
+
self.description = ''
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
if attributes.key?(:'use_case')
|
|
170
|
+
self.use_case = attributes[:'use_case']
|
|
171
|
+
else
|
|
172
|
+
self.use_case = ''
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
if attributes.key?(:'priority')
|
|
176
|
+
self.priority = attributes[:'priority']
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
if attributes.key?(:'status')
|
|
180
|
+
self.status = attributes[:'status']
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
if attributes.key?(:'assignee_id')
|
|
184
|
+
self.assignee_id = attributes[:'assignee_id']
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
if attributes.key?(:'subscribers')
|
|
188
|
+
if (value = attributes[:'subscribers']).is_a?(Array)
|
|
189
|
+
self.subscribers = value
|
|
190
|
+
end
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
if attributes.key?(:'tags')
|
|
194
|
+
if (value = attributes[:'tags']).is_a?(Array)
|
|
195
|
+
self.tags = value
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
if attributes.key?(:'reporter_email')
|
|
200
|
+
self.reporter_email = attributes[:'reporter_email']
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
if attributes.key?(:'page_url')
|
|
204
|
+
self.page_url = attributes[:'page_url']
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
if attributes.key?(:'user_agent')
|
|
208
|
+
self.user_agent = attributes[:'user_agent']
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
if attributes.key?(:'context')
|
|
212
|
+
if (value = attributes[:'context']).is_a?(Hash)
|
|
213
|
+
self.context = value
|
|
214
|
+
end
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
if attributes.key?(:'notify')
|
|
218
|
+
self.notify = attributes[:'notify']
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
223
|
+
# @return Array for valid properties with the reasons
|
|
224
|
+
def list_invalid_properties
|
|
225
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
226
|
+
invalid_properties = Array.new
|
|
227
|
+
if @title.nil?
|
|
228
|
+
invalid_properties.push('invalid value for "title", title cannot be nil.')
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
if @title.to_s.length > 200
|
|
232
|
+
invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 200.')
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
if @title.to_s.length < 1
|
|
236
|
+
invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
pattern = Regexp.new(/^\S(.*\S)?$/)
|
|
240
|
+
if @title !~ pattern
|
|
241
|
+
invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
if !@description.nil? && @description.to_s.length > 8000
|
|
245
|
+
invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 8000.')
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
if !@use_case.nil? && @use_case.to_s.length > 8000
|
|
249
|
+
invalid_properties.push('invalid value for "use_case", the character length must be smaller than or equal to 8000.')
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
if !@user_agent.nil? && @user_agent.to_s.length > 500
|
|
253
|
+
invalid_properties.push('invalid value for "user_agent", the character length must be smaller than or equal to 500.')
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
invalid_properties
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Check to see if the all the properties in the model are valid
|
|
260
|
+
# @return true if the model is valid
|
|
261
|
+
def valid?
|
|
262
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
263
|
+
return false if @title.nil?
|
|
264
|
+
return false if @title.to_s.length > 200
|
|
265
|
+
return false if @title.to_s.length < 1
|
|
266
|
+
return false if @title !~ Regexp.new(/^\S(.*\S)?$/)
|
|
267
|
+
return false if !@description.nil? && @description.to_s.length > 8000
|
|
268
|
+
return false if !@use_case.nil? && @use_case.to_s.length > 8000
|
|
269
|
+
return false if !@user_agent.nil? && @user_agent.to_s.length > 500
|
|
270
|
+
true
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# Custom attribute writer method with validation
|
|
274
|
+
# @param [Object] title Value to be assigned
|
|
275
|
+
def title=(title)
|
|
276
|
+
if title.nil?
|
|
277
|
+
fail ArgumentError, 'title cannot be nil'
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
if title.to_s.length > 200
|
|
281
|
+
fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 200.'
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
if title.to_s.length < 1
|
|
285
|
+
fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
|
|
286
|
+
end
|
|
287
|
+
|
|
288
|
+
pattern = Regexp.new(/^\S(.*\S)?$/)
|
|
289
|
+
if title !~ pattern
|
|
290
|
+
fail ArgumentError, "invalid value for \"title\", must conform to the pattern #{pattern}."
|
|
291
|
+
end
|
|
292
|
+
|
|
293
|
+
@title = title
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
# Custom attribute writer method with validation
|
|
297
|
+
# @param [Object] description Value to be assigned
|
|
298
|
+
def description=(description)
|
|
299
|
+
if description.nil?
|
|
300
|
+
fail ArgumentError, 'description cannot be nil'
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
if description.to_s.length > 8000
|
|
304
|
+
fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 8000.'
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
@description = description
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
# Custom attribute writer method with validation
|
|
311
|
+
# @param [Object] use_case Value to be assigned
|
|
312
|
+
def use_case=(use_case)
|
|
313
|
+
if use_case.nil?
|
|
314
|
+
fail ArgumentError, 'use_case cannot be nil'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
if use_case.to_s.length > 8000
|
|
318
|
+
fail ArgumentError, 'invalid value for "use_case", the character length must be smaller than or equal to 8000.'
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
@use_case = use_case
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
# Custom attribute writer method with validation
|
|
325
|
+
# @param [Object] user_agent Value to be assigned
|
|
326
|
+
def user_agent=(user_agent)
|
|
327
|
+
if !user_agent.nil? && user_agent.to_s.length > 500
|
|
328
|
+
fail ArgumentError, 'invalid value for "user_agent", the character length must be smaller than or equal to 500.'
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
@user_agent = user_agent
|
|
332
|
+
end
|
|
333
|
+
|
|
334
|
+
# Checks equality by comparing each attribute.
|
|
335
|
+
# @param [Object] Object to be compared
|
|
336
|
+
def ==(o)
|
|
337
|
+
return true if self.equal?(o)
|
|
338
|
+
self.class == o.class &&
|
|
339
|
+
title == o.title &&
|
|
340
|
+
description == o.description &&
|
|
341
|
+
use_case == o.use_case &&
|
|
342
|
+
priority == o.priority &&
|
|
343
|
+
status == o.status &&
|
|
344
|
+
assignee_id == o.assignee_id &&
|
|
345
|
+
subscribers == o.subscribers &&
|
|
346
|
+
tags == o.tags &&
|
|
347
|
+
reporter_email == o.reporter_email &&
|
|
348
|
+
page_url == o.page_url &&
|
|
349
|
+
user_agent == o.user_agent &&
|
|
350
|
+
context == o.context &&
|
|
351
|
+
notify == o.notify
|
|
352
|
+
end
|
|
353
|
+
|
|
354
|
+
# @see the `==` method
|
|
355
|
+
# @param [Object] Object to be compared
|
|
356
|
+
def eql?(o)
|
|
357
|
+
self == o
|
|
358
|
+
end
|
|
359
|
+
|
|
360
|
+
# Calculates hash code according to all attributes.
|
|
361
|
+
# @return [Integer] Hash code
|
|
362
|
+
def hash
|
|
363
|
+
[title, description, use_case, priority, status, assignee_id, subscribers, tags, reporter_email, page_url, user_agent, context, notify].hash
|
|
364
|
+
end
|
|
365
|
+
|
|
366
|
+
# Builds the object from hash
|
|
367
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
368
|
+
# @return [Object] Returns the model itself
|
|
369
|
+
def self.build_from_hash(attributes)
|
|
370
|
+
return nil unless attributes.is_a?(Hash)
|
|
371
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
372
|
+
transformed_hash = {}
|
|
373
|
+
openapi_types.each_pair do |key, type|
|
|
374
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
375
|
+
transformed_hash["#{key}"] = nil
|
|
376
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
377
|
+
# check to ensure the input is an array given that the attribute
|
|
378
|
+
# is documented as an array but the input is not
|
|
379
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
380
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
381
|
+
end
|
|
382
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
383
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
384
|
+
end
|
|
385
|
+
end
|
|
386
|
+
new(transformed_hash)
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
# Returns the object in the form of hash
|
|
390
|
+
# @return [Hash] Returns the object in the form of hash
|
|
391
|
+
def to_hash
|
|
392
|
+
hash = {}
|
|
393
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
394
|
+
value = self.send(attr)
|
|
395
|
+
if value.nil?
|
|
396
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
397
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
hash[param] = _to_hash(value)
|
|
401
|
+
end
|
|
402
|
+
hash
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
end
|
data/lib/shipeasy_admin/models/{file_error_ticket_response.rb → create_public_ticket_response.rb}
RENAMED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#Shipeasy Admin API
|
|
2
|
+
#Shipeasy Admin API (server-SDK surface)
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 2.0.0
|
|
7
7
|
|
|
@@ -14,19 +14,23 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module Shipeasy::Admin::Generated
|
|
17
|
-
#
|
|
18
|
-
class
|
|
19
|
-
#
|
|
17
|
+
# Response for the public ticket intake. A fresh file returns `201` with `id` + `number`; a repeat of a report already tracked by an open ticket returns `200` with that ticket's `number` and `deduped: true`.
|
|
18
|
+
class CreatePublicTicketResponse < ApiModelBase
|
|
19
|
+
# The new item's id. Absent on a deduped response — nothing was created, so there is no new id to report.
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
22
|
-
#
|
|
22
|
+
# Per-project item number. On a deduped response this is the number of the OPEN ticket already tracking the report, which is what a caller should show the user either way.
|
|
23
23
|
attr_accessor :number
|
|
24
24
|
|
|
25
|
+
# `true` when an open ticket already tracked this report and nothing was filed (HTTP 200). Absent on a fresh file (HTTP 201).
|
|
26
|
+
attr_accessor :deduped
|
|
27
|
+
|
|
25
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
26
29
|
def self.attribute_map
|
|
27
30
|
{
|
|
28
31
|
:'id' => :'id',
|
|
29
|
-
:'number' => :'number'
|
|
32
|
+
:'number' => :'number',
|
|
33
|
+
:'deduped' => :'deduped'
|
|
30
34
|
}
|
|
31
35
|
end
|
|
32
36
|
|
|
@@ -44,7 +48,8 @@ module Shipeasy::Admin::Generated
|
|
|
44
48
|
def self.openapi_types
|
|
45
49
|
{
|
|
46
50
|
:'id' => :'String',
|
|
47
|
-
:'number' => :'Integer'
|
|
51
|
+
:'number' => :'Integer',
|
|
52
|
+
:'deduped' => :'Boolean'
|
|
48
53
|
}
|
|
49
54
|
end
|
|
50
55
|
|
|
@@ -58,22 +63,20 @@ module Shipeasy::Admin::Generated
|
|
|
58
63
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
59
64
|
def initialize(attributes = {})
|
|
60
65
|
if (!attributes.is_a?(Hash))
|
|
61
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::
|
|
66
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreatePublicTicketResponse` initialize method"
|
|
62
67
|
end
|
|
63
68
|
|
|
64
69
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
65
70
|
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
66
71
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
67
72
|
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
68
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::
|
|
73
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreatePublicTicketResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
69
74
|
end
|
|
70
75
|
h[k.to_sym] = v
|
|
71
76
|
}
|
|
72
77
|
|
|
73
78
|
if attributes.key?(:'id')
|
|
74
79
|
self.id = attributes[:'id']
|
|
75
|
-
else
|
|
76
|
-
self.id = nil
|
|
77
80
|
end
|
|
78
81
|
|
|
79
82
|
if attributes.key?(:'number')
|
|
@@ -81,6 +84,10 @@ module Shipeasy::Admin::Generated
|
|
|
81
84
|
else
|
|
82
85
|
self.number = nil
|
|
83
86
|
end
|
|
87
|
+
|
|
88
|
+
if attributes.key?(:'deduped')
|
|
89
|
+
self.deduped = attributes[:'deduped']
|
|
90
|
+
end
|
|
84
91
|
end
|
|
85
92
|
|
|
86
93
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -88,10 +95,6 @@ module Shipeasy::Admin::Generated
|
|
|
88
95
|
def list_invalid_properties
|
|
89
96
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
90
97
|
invalid_properties = Array.new
|
|
91
|
-
if @id.nil?
|
|
92
|
-
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
93
|
-
end
|
|
94
|
-
|
|
95
98
|
if @number.nil?
|
|
96
99
|
invalid_properties.push('invalid value for "number", number cannot be nil.')
|
|
97
100
|
end
|
|
@@ -103,21 +106,10 @@ module Shipeasy::Admin::Generated
|
|
|
103
106
|
# @return true if the model is valid
|
|
104
107
|
def valid?
|
|
105
108
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
106
|
-
return false if @id.nil?
|
|
107
109
|
return false if @number.nil?
|
|
108
110
|
true
|
|
109
111
|
end
|
|
110
112
|
|
|
111
|
-
# Custom attribute writer method with validation
|
|
112
|
-
# @param [Object] id Value to be assigned
|
|
113
|
-
def id=(id)
|
|
114
|
-
if id.nil?
|
|
115
|
-
fail ArgumentError, 'id cannot be nil'
|
|
116
|
-
end
|
|
117
|
-
|
|
118
|
-
@id = id
|
|
119
|
-
end
|
|
120
|
-
|
|
121
113
|
# Custom attribute writer method with validation
|
|
122
114
|
# @param [Object] number Value to be assigned
|
|
123
115
|
def number=(number)
|
|
@@ -134,7 +126,8 @@ module Shipeasy::Admin::Generated
|
|
|
134
126
|
return true if self.equal?(o)
|
|
135
127
|
self.class == o.class &&
|
|
136
128
|
id == o.id &&
|
|
137
|
-
number == o.number
|
|
129
|
+
number == o.number &&
|
|
130
|
+
deduped == o.deduped
|
|
138
131
|
end
|
|
139
132
|
|
|
140
133
|
# @see the `==` method
|
|
@@ -146,7 +139,7 @@ module Shipeasy::Admin::Generated
|
|
|
146
139
|
# Calculates hash code according to all attributes.
|
|
147
140
|
# @return [Integer] Hash code
|
|
148
141
|
def hash
|
|
149
|
-
[id, number].hash
|
|
142
|
+
[id, number, deduped].hash
|
|
150
143
|
end
|
|
151
144
|
|
|
152
145
|
# Builds the object from hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#Shipeasy Admin API
|
|
2
|
+
#Shipeasy Admin API (server-SDK surface)
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 2.0.0
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#Shipeasy Admin API
|
|
2
|
+
#Shipeasy Admin API (server-SDK surface)
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 2.0.0
|
|
7
7
|
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module Shipeasy::Admin::Generated
|
|
17
|
-
# Uniform error envelope returned by every admin endpoint on a non-2xx status. `error` is the human-readable message; `code` is the stable machine code (present whenever the failure maps to a catalogued `ErrorCode`); `detail` carries extra context (validation paths, conflicting field).
|
|
17
|
+
# Uniform error envelope returned by every admin endpoint on a non-2xx status. `error` is the human-readable message; `code` is the stable machine code (present whenever the failure maps to a catalogued `ErrorCode`); `detail` carries extra context (validation paths, conflicting field); `fields` maps each failing input field to its own message; `instructions` is optional actionable guidance for resolving the error; `schema` echoes back the expected JSON Schema when a value failed schema validation.
|
|
18
18
|
class Error < ApiModelBase
|
|
19
19
|
# Human-readable error message.
|
|
20
20
|
attr_accessor :error
|
|
@@ -24,6 +24,15 @@ module Shipeasy::Admin::Generated
|
|
|
24
24
|
# Extra context (validation details, conflicting field, referenced row).
|
|
25
25
|
attr_accessor :detail
|
|
26
26
|
|
|
27
|
+
# Per-field validation messages, keyed by the submitted field's path (dot-notation for nested fields, e.g. `groups.0.weight`). Present when structural validation failed on one or more specific input fields, so a client form can attach each message to its own input instead of collapsing everything into one banner.
|
|
28
|
+
attr_accessor :fields
|
|
29
|
+
|
|
30
|
+
# Actionable guidance for resolving this error — what to check or change next.
|
|
31
|
+
attr_accessor :instructions
|
|
32
|
+
|
|
33
|
+
# The expected JSON Schema (draft 2020-12) the submitted value must satisfy. Returned only when a value failed schema validation (e.g. a config `value` that does not match its config's saved schema), so the caller can correct the value and retry without re-fetching.
|
|
34
|
+
attr_accessor :schema
|
|
35
|
+
|
|
27
36
|
class EnumAttributeValidator
|
|
28
37
|
attr_reader :datatype
|
|
29
38
|
attr_reader :allowable_values
|
|
@@ -51,7 +60,10 @@ module Shipeasy::Admin::Generated
|
|
|
51
60
|
{
|
|
52
61
|
:'error' => :'error',
|
|
53
62
|
:'code' => :'code',
|
|
54
|
-
:'detail' => :'detail'
|
|
63
|
+
:'detail' => :'detail',
|
|
64
|
+
:'fields' => :'fields',
|
|
65
|
+
:'instructions' => :'instructions',
|
|
66
|
+
:'schema' => :'schema'
|
|
55
67
|
}
|
|
56
68
|
end
|
|
57
69
|
|
|
@@ -70,7 +82,10 @@ module Shipeasy::Admin::Generated
|
|
|
70
82
|
{
|
|
71
83
|
:'error' => :'String',
|
|
72
84
|
:'code' => :'ErrorCode',
|
|
73
|
-
:'detail' => :'String'
|
|
85
|
+
:'detail' => :'String',
|
|
86
|
+
:'fields' => :'Hash<String, String>',
|
|
87
|
+
:'instructions' => :'String',
|
|
88
|
+
:'schema' => :'Hash<String, Object>'
|
|
74
89
|
}
|
|
75
90
|
end
|
|
76
91
|
|
|
@@ -109,6 +124,22 @@ module Shipeasy::Admin::Generated
|
|
|
109
124
|
if attributes.key?(:'detail')
|
|
110
125
|
self.detail = attributes[:'detail']
|
|
111
126
|
end
|
|
127
|
+
|
|
128
|
+
if attributes.key?(:'fields')
|
|
129
|
+
if (value = attributes[:'fields']).is_a?(Hash)
|
|
130
|
+
self.fields = value
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
if attributes.key?(:'instructions')
|
|
135
|
+
self.instructions = attributes[:'instructions']
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
if attributes.key?(:'schema')
|
|
139
|
+
if (value = attributes[:'schema']).is_a?(Hash)
|
|
140
|
+
self.schema = value
|
|
141
|
+
end
|
|
142
|
+
end
|
|
112
143
|
end
|
|
113
144
|
|
|
114
145
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -148,7 +179,10 @@ module Shipeasy::Admin::Generated
|
|
|
148
179
|
self.class == o.class &&
|
|
149
180
|
error == o.error &&
|
|
150
181
|
code == o.code &&
|
|
151
|
-
detail == o.detail
|
|
182
|
+
detail == o.detail &&
|
|
183
|
+
fields == o.fields &&
|
|
184
|
+
instructions == o.instructions &&
|
|
185
|
+
schema == o.schema
|
|
152
186
|
end
|
|
153
187
|
|
|
154
188
|
# @see the `==` method
|
|
@@ -160,7 +194,7 @@ module Shipeasy::Admin::Generated
|
|
|
160
194
|
# Calculates hash code according to all attributes.
|
|
161
195
|
# @return [Integer] Hash code
|
|
162
196
|
def hash
|
|
163
|
-
[error, code, detail].hash
|
|
197
|
+
[error, code, detail, fields, instructions, schema].hash
|
|
164
198
|
end
|
|
165
199
|
|
|
166
200
|
# Builds the object from hash
|