Skip to content

Latest commit

 

History

History
58 lines (52 loc) · 3.75 KB

FeatureFlag.md

File metadata and controls

58 lines (52 loc) · 3.75 KB

LaunchDarklyApi::FeatureFlag

Properties

Name Type Description Notes
name String A human-friendly name for the feature flag
kind String Kind of feature flag
description String Description of the feature flag [optional]
key String A unique key used to reference the flag in your code
_version Integer Version of the feature flag
creation_date Integer
include_in_snippet Boolean Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK [optional]
client_side_availability ClientSideAvailability [optional]
variations Array<Variation> An array of possible variations for the flag
temporary Boolean Whether the flag is a temporary flag
tags Array<String> Tags for the feature flag
_links Hash<String, Link>
maintainer_id String Associated maintainerId for the feature flag [optional]
_maintainer MemberSummary [optional]
goal_ids Array<String> [optional]
experiments ExperimentInfoRep
custom_properties Hash<String, CustomProperty>
archived Boolean Boolean indicating if the feature flag is archived
archived_date Integer [optional]
defaults Defaults [optional]
environments Hash<String, FeatureFlagConfig>

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::FeatureFlag.new(
  name: My Flag,
  kind: boolean,
  description: This flag controls the example widgets,
  key: my-flag,
  _version: 1,
  creation_date: null,
  include_in_snippet: true,
  client_side_availability: null,
  variations: [{&quot;_id&quot;:&quot;e432f62b-55f6-49dd-a02f-eb24acf39d05&quot;,&quot;value&quot;:true},{&quot;_id&quot;:&quot;a00bf58d-d252-476c-b915-15a74becacb4&quot;,&quot;value&quot;:false}],
  temporary: true,
  tags: [&quot;example-tag&quot;],
  _links: {&quot;parent&quot;:{&quot;href&quot;:&quot;/api/v2/flags/my-project&quot;,&quot;type&quot;:&quot;application/json&quot;},&quot;self&quot;:{&quot;href&quot;:&quot;/api/v2/flags/my-project/my-flag&quot;,&quot;type&quot;:&quot;application/json&quot;}},
  maintainer_id: 569f183514f4432160000007,
  _maintainer: null,
  goal_ids: [],
  experiments: null,
  custom_properties: null,
  archived: false,
  archived_date: null,
  defaults: null,
  environments: {&quot;my-environment&quot;:{&quot;_environmentName&quot;:&quot;My Environment&quot;,&quot;_site&quot;:{&quot;href&quot;:&quot;/default/my-environment/features/client-side-flag&quot;,&quot;type&quot;:&quot;text/html&quot;},&quot;_summary&quot;:{&quot;prerequisites&quot;:0,&quot;variations&quot;:{&quot;0&quot;:{&quot;isFallthrough&quot;:true,&quot;nullRules&quot;:0,&quot;rules&quot;:0,&quot;targets&quot;:0},&quot;1&quot;:{&quot;isOff&quot;:true,&quot;nullRules&quot;:0,&quot;rules&quot;:0,&quot;targets&quot;:0}}},&quot;archived&quot;:false,&quot;fallthrough&quot;:{&quot;variation&quot;:0},&quot;lastModified&quot;:1627071171347,&quot;offVariation&quot;:1,&quot;on&quot;:false,&quot;prerequisites&quot;:[],&quot;rules&quot;:[],&quot;salt&quot;:&quot;61eddeadbeef4da1facecafe3a60a397&quot;,&quot;sel&quot;:&quot;810edeadbeef4844facecafe438f2999492&quot;,&quot;targets&quot;:[],&quot;trackEvents&quot;:false,&quot;trackEventsFallthrough&quot;:false,&quot;version&quot;:1}}
)