Module: Shipeasy::Admin::Generated

Defined in:
lib/shipeasy_admin/version.rb,
lib/shipeasy_admin.rb,
lib/shipeasy_admin/api_error.rb,
lib/shipeasy_admin/api_client.rb,
lib/shipeasy_admin/models/env.rb,
lib/shipeasy_admin/api/ops_api.rb,
lib/shipeasy_admin/models/error.rb,
lib/shipeasy_admin/api/flags_api.rb,
lib/shipeasy_admin/configuration.rb,
lib/shipeasy_admin/api_model_base.rb,
lib/shipeasy_admin/models/error_code.rb,
lib/shipeasy_admin/api/killswitch_api.rb,
lib/shipeasy_admin/models/gate_whitelist.rb,
lib/shipeasy_admin/models/ops_item_status.rb,
lib/shipeasy_admin/models/killswitch_value.rb,
lib/shipeasy_admin/models/ops_item_priority.rb,
lib/shipeasy_admin/models/gate_whitelist_attr.rb,
lib/shipeasy_admin/models/notification_target.rb,
lib/shipeasy_admin/models/create_public_bug_request.rb,
lib/shipeasy_admin/models/toggle_killswitch_request.rb,
lib/shipeasy_admin/models/set_gate_whitelist_request.rb,
lib/shipeasy_admin/models/toggle_killswitch_response.rb,
lib/shipeasy_admin/models/add_to_gate_whitelist_request.rb,
lib/shipeasy_admin/models/create_public_ticket_response.rb,
lib/shipeasy_admin/models/notification_target_slack_channel.rb,
lib/shipeasy_admin/models/remove_from_gate_whitelist_request.rb,
lib/shipeasy_admin/models/create_public_feature_request_request.rb

Overview

#Shipeasy Admin API (server-SDK surface)

#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).

The version of the OpenAPI document: 2.0.0

Generated by: https://openapi-generator.tech Generator version: 7.23.0

Defined Under Namespace

Classes: AddToGateWhitelistRequest, ApiClient, ApiError, ApiModelBase, Configuration, CreatePublicBugRequest, CreatePublicFeatureRequestRequest, CreatePublicTicketResponse, Env, Error, ErrorCode, FlagsApi, GateWhitelist, GateWhitelistAttr, KillswitchApi, KillswitchValue, NotificationTarget, NotificationTargetSlackChannel, OpsApi, OpsItemPriority, OpsItemStatus, RemoveFromGateWhitelistRequest, SetGateWhitelistRequest, ToggleKillswitchRequest, ToggleKillswitchResponse

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block. Shipeasy::Admin::Generated.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



53
54
55
56
57
58
59
 
# File 'lib/shipeasy_admin.rb', line 53

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end