Skip to content

Latest commit

 

History

History
48 lines (42 loc) · 2.69 KB

FeatureFlagBody.md

File metadata and controls

48 lines (42 loc) · 2.69 KB

LaunchDarklyApi::FeatureFlagBody

Properties

Name Type Description Notes
name String A human-friendly name for the feature flag
key String A unique key used to reference the flag in your code
description String Description of the feature flag. Defaults to an empty string. [optional]
include_in_snippet Boolean Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK. Defaults to <code>false</code>. [optional]
client_side_availability ClientSideAvailabilityPost [optional]
variations Array<Variation> An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of <code>true</code> and <code>false</code> will be used. [optional]
temporary Boolean Whether the flag is a temporary flag. Defaults to <code>true</code>. [optional]
tags Array<String> Tags for the feature flag. Defaults to an empty array. [optional]
custom_properties Hash<String, CustomProperty> [optional]
defaults Defaults [optional]
purpose String Purpose of the flag [optional]
migration_settings MigrationSettingsPost [optional]
maintainer_id String The ID of the member who maintains this feature flag [optional]
maintainer_team_key String The key of the team that maintains this feature flag [optional]
initial_prerequisites Array<FlagPrerequisitePost> Initial set of prerequisite flags for all environments [optional]
is_flag_on Boolean Whether to automatically turn the flag on across all environments at creation. Defaults to <code>false</code>. [optional]

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::FeatureFlagBody.new(
  name: My flag,
  key: flag-key-123abc,
  description: This flag controls the example widgets,
  include_in_snippet: null,
  client_side_availability: null,
  variations: [{&quot;value&quot;:true},{&quot;value&quot;:false}],
  temporary: false,
  tags: [&quot;example-tag&quot;],
  custom_properties: null,
  defaults: null,
  purpose: migration,
  migration_settings: null,
  maintainer_id: 12ab3c45de678910fgh12345,
  maintainer_team_key: team-1,
  initial_prerequisites: null,
  is_flag_on: null
)