launchdarkly_api 2.0.3 → 2.0.10

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.
Files changed (171) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +83 -92
  3. data/docs/CustomProperties.md +7 -0
  4. data/docs/CustomProperty.md +9 -0
  5. data/docs/CustomPropertyValues.md +7 -0
  6. data/docs/Environment.md +1 -0
  7. data/docs/{EnvironmentBody.md → EnvironmentPost.md} +1 -1
  8. data/docs/EnvironmentsApi.md +2 -2
  9. data/docs/FeatureFlag.md +2 -0
  10. data/docs/FeatureFlagBody.md +1 -0
  11. data/docs/FeatureFlagConfig.md +1 -0
  12. data/docs/FeatureFlagStatus.md +1 -1
  13. data/docs/FeatureFlagsApi.md +8 -3
  14. data/docs/Project.md +1 -0
  15. data/docs/ProjectBody.md +1 -0
  16. data/docs/Rule.md +1 -0
  17. data/docs/UserFlagSettings.md +1 -1
  18. data/launchdarkly_api.gemspec +2 -2
  19. data/lib/launchdarkly_api.rb +5 -2
  20. data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
  21. data/lib/launchdarkly_api/api/custom_roles_api.rb +1 -1
  22. data/lib/launchdarkly_api/api/environments_api.rb +1 -1
  23. data/lib/launchdarkly_api/api/feature_flags_api.rb +10 -6
  24. data/lib/launchdarkly_api/api/projects_api.rb +1 -1
  25. data/lib/launchdarkly_api/api/root_api.rb +1 -1
  26. data/lib/launchdarkly_api/api/team_members_api.rb +1 -1
  27. data/lib/launchdarkly_api/api/user_segments_api.rb +1 -1
  28. data/lib/launchdarkly_api/api/user_settings_api.rb +1 -1
  29. data/lib/launchdarkly_api/api/users_api.rb +1 -1
  30. data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
  31. data/lib/launchdarkly_api/api_client.rb +1 -1
  32. data/lib/launchdarkly_api/api_error.rb +1 -1
  33. data/lib/launchdarkly_api/configuration.rb +1 -1
  34. data/lib/launchdarkly_api/models/action.rb +1 -1
  35. data/lib/launchdarkly_api/models/actions.rb +1 -1
  36. data/lib/launchdarkly_api/models/audit_log_entries.rb +1 -1
  37. data/lib/launchdarkly_api/models/audit_log_entry.rb +1 -1
  38. data/lib/launchdarkly_api/models/audit_log_entry_target.rb +1 -1
  39. data/lib/launchdarkly_api/models/clause.rb +1 -1
  40. data/lib/launchdarkly_api/models/custom_properties.rb +179 -0
  41. data/lib/launchdarkly_api/models/custom_property.rb +203 -0
  42. data/lib/launchdarkly_api/models/custom_property_values.rb +179 -0
  43. data/lib/launchdarkly_api/models/custom_role.rb +1 -1
  44. data/lib/launchdarkly_api/models/custom_role_body.rb +1 -1
  45. data/lib/launchdarkly_api/models/custom_role_key_or_id.rb +1 -1
  46. data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
  47. data/lib/launchdarkly_api/models/environment.rb +17 -5
  48. data/lib/launchdarkly_api/models/{environment_body.rb → environment_post.rb} +2 -2
  49. data/lib/launchdarkly_api/models/fallthrough.rb +1 -1
  50. data/lib/launchdarkly_api/models/feature_flag.rb +20 -2
  51. data/lib/launchdarkly_api/models/feature_flag_body.rb +12 -2
  52. data/lib/launchdarkly_api/models/feature_flag_config.rb +13 -2
  53. data/lib/launchdarkly_api/models/feature_flag_status.rb +2 -2
  54. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
  55. data/lib/launchdarkly_api/models/feature_flags.rb +1 -1
  56. data/lib/launchdarkly_api/models/id.rb +1 -1
  57. data/lib/launchdarkly_api/models/link.rb +1 -1
  58. data/lib/launchdarkly_api/models/links.rb +1 -1
  59. data/lib/launchdarkly_api/models/member.rb +1 -1
  60. data/lib/launchdarkly_api/models/members.rb +1 -1
  61. data/lib/launchdarkly_api/models/members_body.rb +1 -1
  62. data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
  63. data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
  64. data/lib/launchdarkly_api/models/policy.rb +1 -1
  65. data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
  66. data/lib/launchdarkly_api/models/project.rb +17 -5
  67. data/lib/launchdarkly_api/models/project_body.rb +16 -5
  68. data/lib/launchdarkly_api/models/projects.rb +1 -1
  69. data/lib/launchdarkly_api/models/resource.rb +1 -1
  70. data/lib/launchdarkly_api/models/resources.rb +1 -1
  71. data/lib/launchdarkly_api/models/role.rb +1 -1
  72. data/lib/launchdarkly_api/models/rollout.rb +1 -1
  73. data/lib/launchdarkly_api/models/rule.rb +11 -2
  74. data/lib/launchdarkly_api/models/statement.rb +1 -1
  75. data/lib/launchdarkly_api/models/statements.rb +1 -1
  76. data/lib/launchdarkly_api/models/target.rb +1 -1
  77. data/lib/launchdarkly_api/models/user.rb +1 -1
  78. data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
  79. data/lib/launchdarkly_api/models/user_flag_settings.rb +5 -3
  80. data/lib/launchdarkly_api/models/user_record.rb +1 -1
  81. data/lib/launchdarkly_api/models/user_segment.rb +1 -1
  82. data/lib/launchdarkly_api/models/user_segment_body.rb +1 -1
  83. data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
  84. data/lib/launchdarkly_api/models/user_segments.rb +1 -1
  85. data/lib/launchdarkly_api/models/user_settings_body.rb +1 -1
  86. data/lib/launchdarkly_api/models/users.rb +1 -1
  87. data/lib/launchdarkly_api/models/variation.rb +1 -1
  88. data/lib/launchdarkly_api/models/webhook.rb +1 -1
  89. data/lib/launchdarkly_api/models/webhook_body.rb +1 -1
  90. data/lib/launchdarkly_api/models/webhooks.rb +1 -1
  91. data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
  92. data/lib/launchdarkly_api/version.rb +2 -2
  93. data/openapi.yml +2082 -0
  94. data/spec/api/audit_log_api_spec.rb +1 -1
  95. data/spec/api/custom_roles_api_spec.rb +1 -1
  96. data/spec/api/environments_api_spec.rb +1 -1
  97. data/spec/api/feature_flags_api_spec.rb +3 -2
  98. data/spec/api/projects_api_spec.rb +1 -1
  99. data/spec/api/root_api_spec.rb +1 -1
  100. data/spec/api/team_members_api_spec.rb +1 -1
  101. data/spec/api/user_segments_api_spec.rb +1 -1
  102. data/spec/api/user_settings_api_spec.rb +1 -1
  103. data/spec/api/users_api_spec.rb +1 -1
  104. data/spec/api/webhooks_api_spec.rb +1 -1
  105. data/spec/api_client_spec.rb +1 -1
  106. data/spec/configuration_spec.rb +1 -1
  107. data/spec/models/action_spec.rb +1 -1
  108. data/spec/models/actions_spec.rb +1 -1
  109. data/spec/models/audit_log_entries_spec.rb +1 -1
  110. data/spec/models/audit_log_entry_spec.rb +1 -1
  111. data/spec/models/audit_log_entry_target_spec.rb +1 -1
  112. data/spec/models/clause_spec.rb +1 -1
  113. data/spec/models/custom_properties_spec.rb +36 -0
  114. data/spec/models/custom_property_spec.rb +48 -0
  115. data/spec/models/custom_property_values_spec.rb +36 -0
  116. data/spec/models/custom_role_body_spec.rb +1 -1
  117. data/spec/models/custom_role_key_or_id_spec.rb +1 -1
  118. data/spec/models/custom_role_spec.rb +1 -1
  119. data/spec/models/custom_roles_spec.rb +1 -1
  120. data/spec/models/{environment_body_spec.rb → environment_post_spec.rb} +7 -7
  121. data/spec/models/environment_spec.rb +7 -1
  122. data/spec/models/fallthrough_spec.rb +1 -1
  123. data/spec/models/feature_flag_body_spec.rb +7 -1
  124. data/spec/models/feature_flag_config_spec.rb +7 -1
  125. data/spec/models/feature_flag_spec.rb +13 -1
  126. data/spec/models/feature_flag_status_spec.rb +1 -1
  127. data/spec/models/feature_flag_statuses_spec.rb +1 -1
  128. data/spec/models/feature_flags_spec.rb +1 -1
  129. data/spec/models/id_spec.rb +1 -1
  130. data/spec/models/link_spec.rb +1 -1
  131. data/spec/models/links_spec.rb +1 -1
  132. data/spec/models/member_spec.rb +1 -1
  133. data/spec/models/members_body_spec.rb +1 -1
  134. data/spec/models/members_spec.rb +1 -1
  135. data/spec/models/patch_comment_spec.rb +1 -1
  136. data/spec/models/patch_operation_spec.rb +1 -1
  137. data/spec/models/policy_spec.rb +1 -1
  138. data/spec/models/prerequisite_spec.rb +1 -1
  139. data/spec/models/project_body_spec.rb +7 -1
  140. data/spec/models/project_spec.rb +7 -1
  141. data/spec/models/projects_spec.rb +1 -1
  142. data/spec/models/resource_spec.rb +1 -1
  143. data/spec/models/resources_spec.rb +1 -1
  144. data/spec/models/role_spec.rb +1 -1
  145. data/spec/models/rollout_spec.rb +1 -1
  146. data/spec/models/rule_spec.rb +7 -1
  147. data/spec/models/statement_spec.rb +1 -1
  148. data/spec/models/statements_spec.rb +1 -1
  149. data/spec/models/target_spec.rb +1 -1
  150. data/spec/models/user_flag_setting_spec.rb +1 -1
  151. data/spec/models/user_flag_settings_spec.rb +1 -1
  152. data/spec/models/user_record_spec.rb +1 -1
  153. data/spec/models/user_segment_body_spec.rb +1 -1
  154. data/spec/models/user_segment_rule_spec.rb +1 -1
  155. data/spec/models/user_segment_spec.rb +1 -1
  156. data/spec/models/user_segments_spec.rb +1 -1
  157. data/spec/models/user_settings_body_spec.rb +1 -1
  158. data/spec/models/user_spec.rb +1 -1
  159. data/spec/models/users_spec.rb +1 -1
  160. data/spec/models/variation_spec.rb +1 -1
  161. data/spec/models/webhook_body_spec.rb +1 -1
  162. data/spec/models/webhook_spec.rb +1 -1
  163. data/spec/models/webhooks_spec.rb +1 -1
  164. data/spec/models/weighted_variation_spec.rb +1 -1
  165. data/spec/spec_helper.rb +1 -1
  166. metadata +69 -61
  167. data/Gemfile.lock +0 -69
  168. data/launchdarkly_api-2.0.2.gem +0 -0
  169. data/lib/.DS_Store +0 -0
  170. data/lib/swagger_client/.DS_Store +0 -0
  171. data/test.rb +0 -50
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -15,6 +15,8 @@ require 'date'
15
15
  module LaunchDarklyApi
16
16
 
17
17
  class Rule
18
+ attr_accessor :_id
19
+
18
20
  attr_accessor :variation
19
21
 
20
22
  attr_accessor :rollout
@@ -25,6 +27,7 @@ module LaunchDarklyApi
25
27
  # Attribute mapping from ruby-style variable name to JSON key.
26
28
  def self.attribute_map
27
29
  {
30
+ :'_id' => :'_id',
28
31
  :'variation' => :'variation',
29
32
  :'rollout' => :'rollout',
30
33
  :'clauses' => :'clauses'
@@ -34,6 +37,7 @@ module LaunchDarklyApi
34
37
  # Attribute type mapping.
35
38
  def self.swagger_types
36
39
  {
40
+ :'_id' => :'String',
37
41
  :'variation' => :'Integer',
38
42
  :'rollout' => :'Rollout',
39
43
  :'clauses' => :'Array<Clause>'
@@ -48,6 +52,10 @@ module LaunchDarklyApi
48
52
  # convert string to symbol for hash key
49
53
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
50
54
 
55
+ if attributes.has_key?(:'_id')
56
+ self._id = attributes[:'_id']
57
+ end
58
+
51
59
  if attributes.has_key?(:'variation')
52
60
  self.variation = attributes[:'variation']
53
61
  end
@@ -82,6 +90,7 @@ module LaunchDarklyApi
82
90
  def ==(o)
83
91
  return true if self.equal?(o)
84
92
  self.class == o.class &&
93
+ _id == o._id &&
85
94
  variation == o.variation &&
86
95
  rollout == o.rollout &&
87
96
  clauses == o.clauses
@@ -96,7 +105,7 @@ module LaunchDarklyApi
96
105
  # Calculates hash code according to all attributes.
97
106
  # @return [Fixnum] Hash code
98
107
  def hash
99
- [variation, rollout, clauses].hash
108
+ [_id, variation, rollout, clauses].hash
100
109
  end
101
110
 
102
111
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -32,7 +32,7 @@ module LaunchDarklyApi
32
32
  def self.swagger_types
33
33
  {
34
34
  :'_links' => :'Links',
35
- :'items' => :'Object'
35
+ :'items' => :'Hash<String, UserFlagSetting>'
36
36
  }
37
37
  end
38
38
 
@@ -49,7 +49,9 @@ module LaunchDarklyApi
49
49
  end
50
50
 
51
51
  if attributes.has_key?(:'items')
52
- self.items = attributes[:'items']
52
+ if (value = attributes[:'items']).is_a?(Hash)
53
+ self.items = value
54
+ end
53
55
  end
54
56
 
55
57
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Build custom integrations with the LaunchDarkly REST API
5
5
 
6
- OpenAPI spec version: 2.0.3
6
+ OpenAPI spec version: 2.0.10
7
7
  Contact: support@launchdarkly.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.1
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
11
11
  =end
12
12
 
13
13
  module LaunchDarklyApi
14
- VERSION = "2.0.3"
14
+ VERSION = "2.0.10"
15
15
  end
data/openapi.yml ADDED
@@ -0,0 +1,2082 @@
1
+ swagger: '2.0'
2
+ info:
3
+ title: LaunchDarkly REST API
4
+ description: Build custom integrations with the LaunchDarkly REST API
5
+ termsOfService: 'https://launchdarkly.com/terms'
6
+ contact:
7
+ name: LaunchDarkly Support
8
+ url: 'https://support.launchdarkly.com'
9
+ email: support@launchdarkly.com
10
+ license:
11
+ name: Apache 2.0
12
+ url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
13
+ version: 2.0.10
14
+ host: app.launchdarkly.com
15
+ basePath: /api/v2
16
+ schemes:
17
+ - https
18
+ consumes:
19
+ - application/json
20
+ produces:
21
+ - application/json
22
+ securityDefinitions:
23
+ Token:
24
+ type: apiKey
25
+ name: Authorization
26
+ in: header
27
+ description: 'https://app.launchdarkly.com/settings#/tokens'
28
+ security:
29
+ - Token: []
30
+ paths:
31
+ /projects:
32
+ get:
33
+ summary: Returns a list of all projects in the account.
34
+ operationId: getProjects
35
+ responses:
36
+ '200':
37
+ description: Projects response
38
+ schema:
39
+ $ref: '#/definitions/Projects'
40
+ '401':
41
+ $ref: '#/responses/Standard401'
42
+ tags:
43
+ - Projects
44
+ post:
45
+ summary: Create a new project with the given key and name.
46
+ operationId: postProject
47
+ parameters:
48
+ - $ref: '#/parameters/ProjectPostRequest'
49
+ responses:
50
+ '201':
51
+ $ref: '#/responses/Standard201'
52
+ '400':
53
+ $ref: '#/responses/Standard400'
54
+ '401':
55
+ $ref: '#/responses/Standard401'
56
+ '409':
57
+ $ref: '#/responses/Standard409'
58
+ tags:
59
+ - Projects
60
+ '/projects/{projectKey}':
61
+ get:
62
+ summary: Fetch a single project by key.
63
+ operationId: getProject
64
+ parameters:
65
+ - $ref: '#/parameters/ProjectKey'
66
+ responses:
67
+ '200':
68
+ $ref: '#/responses/Projects200'
69
+ '401':
70
+ $ref: '#/responses/Standard401'
71
+ '404':
72
+ $ref: '#/responses/Standard404'
73
+ tags:
74
+ - Projects
75
+ patch:
76
+ summary: Modify a project by ID.
77
+ operationId: patchProject
78
+ parameters:
79
+ - $ref: '#/parameters/ProjectKey'
80
+ - $ref: '#/parameters/PatchRequest'
81
+ responses:
82
+ '200':
83
+ $ref: '#/responses/Projects200'
84
+ '400':
85
+ $ref: '#/responses/Standard400'
86
+ '401':
87
+ $ref: '#/responses/Standard401'
88
+ '404':
89
+ $ref: '#/responses/Standard404'
90
+ '409':
91
+ $ref: '#/responses/Standard409'
92
+ tags:
93
+ - Projects
94
+ delete:
95
+ summary: >-
96
+ Delete a project by key. Caution-- deleting a project will delete all
97
+ associated environments and feature flags. You cannot delete the last
98
+ project in an account.
99
+ operationId: deleteProject
100
+ parameters:
101
+ - $ref: '#/parameters/ProjectKey'
102
+ responses:
103
+ '204':
104
+ $ref: '#/responses/Standard204'
105
+ '401':
106
+ $ref: '#/responses/Standard401'
107
+ '404':
108
+ $ref: '#/responses/Standard404'
109
+ tags:
110
+ - Projects
111
+ '/projects/{projectKey}/environments':
112
+ post:
113
+ summary: >-
114
+ Create a new environment in a specified project with a given name, key,
115
+ and swatch color.
116
+ operationId: postEnvironment
117
+ parameters:
118
+ - $ref: '#/parameters/ProjectKey'
119
+ - $ref: '#/parameters/EnvironmentPostRequest'
120
+ responses:
121
+ '201':
122
+ $ref: '#/responses/Standard201'
123
+ '400':
124
+ $ref: '#/responses/Standard400'
125
+ '401':
126
+ $ref: '#/responses/Standard401'
127
+ '409':
128
+ $ref: '#/responses/Standard409'
129
+ tags:
130
+ - Environments
131
+ '/projects/{projectKey}/environments/{environmentKey}':
132
+ get:
133
+ summary: Get an environment given a project and key.
134
+ operationId: getEnvironment
135
+ parameters:
136
+ - $ref: '#/parameters/ProjectKey'
137
+ - $ref: '#/parameters/EnvironmentKey'
138
+ responses:
139
+ '200':
140
+ description: Environment response.
141
+ schema:
142
+ $ref: '#/definitions/Environment'
143
+ '401':
144
+ $ref: '#/responses/Standard401'
145
+ '404':
146
+ $ref: '#/responses/Standard404'
147
+ tags:
148
+ - Environments
149
+ patch:
150
+ summary: Modify an environment by ID.
151
+ operationId: patchEnvironment
152
+ parameters:
153
+ - $ref: '#/parameters/ProjectKey'
154
+ - $ref: '#/parameters/EnvironmentKey'
155
+ - $ref: '#/parameters/PatchRequest'
156
+ responses:
157
+ '200':
158
+ description: Environment response.
159
+ schema:
160
+ $ref: '#/definitions/Environment'
161
+ '400':
162
+ $ref: '#/responses/Standard400'
163
+ '401':
164
+ $ref: '#/responses/Standard401'
165
+ '404':
166
+ $ref: '#/responses/Standard404'
167
+ '409':
168
+ $ref: '#/responses/Standard409'
169
+ tags:
170
+ - Environments
171
+ delete:
172
+ summary: Delete an environment in a specific project.
173
+ operationId: deleteEnvironment
174
+ parameters:
175
+ - $ref: '#/parameters/ProjectKey'
176
+ - $ref: '#/parameters/EnvironmentKey'
177
+ responses:
178
+ '204':
179
+ $ref: '#/responses/Standard204'
180
+ '401':
181
+ $ref: '#/responses/Standard401'
182
+ '404':
183
+ $ref: '#/responses/Standard404'
184
+ tags:
185
+ - Environments
186
+ '/flags/{projectKey}':
187
+ get:
188
+ summary: Get a list of all features in the given project.
189
+ operationId: getFeatureFlags
190
+ parameters:
191
+ - $ref: '#/parameters/ProjectKey'
192
+ - $ref: '#/parameters/EnvironmentKeyQuery'
193
+ - $ref: '#/parameters/Tag'
194
+ responses:
195
+ '200':
196
+ description: Flags response.
197
+ schema:
198
+ $ref: '#/definitions/FeatureFlags'
199
+ '401':
200
+ $ref: '#/responses/Standard401'
201
+ tags:
202
+ - Feature flags
203
+ post:
204
+ summary: Creates a new feature flag.
205
+ operationId: postFeatureFlag
206
+ parameters:
207
+ - $ref: '#/parameters/ProjectKey'
208
+ - $ref: '#/parameters/FeatureFlagPostRequest'
209
+ - $ref: '#/parameters/CloneFlagKeyQuery'
210
+ responses:
211
+ '201':
212
+ description: Flag response.
213
+ schema:
214
+ $ref: '#/definitions/FeatureFlag'
215
+ '400':
216
+ $ref: '#/responses/Standard400'
217
+ '401':
218
+ $ref: '#/responses/Standard401'
219
+ '409':
220
+ $ref: '#/responses/Standard409'
221
+ tags:
222
+ - Feature flags
223
+ '/flags/{projectKey}/{featureFlagKey}':
224
+ get:
225
+ summary: Get a single feature flag by key.
226
+ operationId: getFeatureFlag
227
+ parameters:
228
+ - $ref: '#/parameters/ProjectKey'
229
+ - $ref: '#/parameters/FeatureFlagKey'
230
+ - $ref: '#/parameters/EnvironmentKeyQuery'
231
+ responses:
232
+ '200':
233
+ description: Flag response.
234
+ schema:
235
+ $ref: '#/definitions/FeatureFlag'
236
+ '401':
237
+ $ref: '#/responses/Standard401'
238
+ '404':
239
+ $ref: '#/responses/Standard404'
240
+ tags:
241
+ - Feature flags
242
+ patch:
243
+ summary: Perform a partial update to a feature.
244
+ operationId: patchFeatureFlag
245
+ parameters:
246
+ - $ref: '#/parameters/ProjectKey'
247
+ - $ref: '#/parameters/FeatureFlagKey'
248
+ - $ref: '#/parameters/PatchWithComment'
249
+ responses:
250
+ '200':
251
+ description: Feature flag response.
252
+ schema:
253
+ $ref: '#/definitions/FeatureFlag'
254
+ '400':
255
+ $ref: '#/responses/Standard400'
256
+ '401':
257
+ $ref: '#/responses/Standard401'
258
+ '404':
259
+ $ref: '#/responses/Standard404'
260
+ '409':
261
+ $ref: '#/responses/Standard409'
262
+ tags:
263
+ - Feature flags
264
+ delete:
265
+ summary: >-
266
+ Delete a feature flag in all environments. Be careful-- only delete
267
+ feature flags that are no longer being used by your application.
268
+ operationId: deleteFeatureFlag
269
+ parameters:
270
+ - $ref: '#/parameters/ProjectKey'
271
+ - $ref: '#/parameters/FeatureFlagKey'
272
+ responses:
273
+ '204':
274
+ $ref: '#/responses/Standard204'
275
+ '401':
276
+ $ref: '#/responses/Standard401'
277
+ '404':
278
+ $ref: '#/responses/Standard404'
279
+ tags:
280
+ - Feature flags
281
+ '/flag-statuses/{projectKey}/{environmentKey}':
282
+ get:
283
+ summary: >-
284
+ Get a list of statuses for all feature flags. The status includes the
285
+ last time the feature flag was requested, as well as the state of the
286
+ flag.
287
+ operationId: getFeatureFlagStatuses
288
+ parameters:
289
+ - $ref: '#/parameters/ProjectKey'
290
+ - $ref: '#/parameters/EnvironmentKey'
291
+ responses:
292
+ '200':
293
+ description: List of feature flag statuses.
294
+ schema:
295
+ $ref: '#/definitions/FeatureFlagStatuses'
296
+ '401':
297
+ $ref: '#/responses/Standard401'
298
+ tags:
299
+ - Feature flags
300
+ '/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}':
301
+ get:
302
+ summary: Get the status for a particular feature flag.
303
+ operationId: getFeatureFlagStatus
304
+ parameters:
305
+ - $ref: '#/parameters/ProjectKey'
306
+ - $ref: '#/parameters/EnvironmentKey'
307
+ - $ref: '#/parameters/FeatureFlagKey'
308
+ responses:
309
+ '200':
310
+ description: Status of the requested feature flag.
311
+ schema:
312
+ $ref: '#/definitions/FeatureFlagStatus'
313
+ '401':
314
+ $ref: '#/responses/Standard401'
315
+ tags:
316
+ - Feature flags
317
+ '/segments/{projectKey}/{environmentKey}':
318
+ get:
319
+ summary: Get a list of all user segments in the given project.
320
+ operationId: getUserSegments
321
+ parameters:
322
+ - $ref: '#/parameters/ProjectKey'
323
+ - $ref: '#/parameters/EnvironmentKey'
324
+ - $ref: '#/parameters/Tag'
325
+ responses:
326
+ '200':
327
+ description: Segments response.
328
+ schema:
329
+ $ref: '#/definitions/UserSegments'
330
+ '401':
331
+ $ref: '#/responses/Standard401'
332
+ tags:
333
+ - User segments
334
+ post:
335
+ summary: Creates a new user segment.
336
+ operationId: postUserSegment
337
+ parameters:
338
+ - $ref: '#/parameters/ProjectKey'
339
+ - $ref: '#/parameters/EnvironmentKey'
340
+ - $ref: '#/parameters/UserSegmentPostRequest'
341
+ responses:
342
+ '201':
343
+ $ref: '#/responses/Standard201'
344
+ '400':
345
+ $ref: '#/responses/Standard400'
346
+ '401':
347
+ $ref: '#/responses/Standard401'
348
+ '409':
349
+ $ref: '#/responses/Standard409'
350
+ tags:
351
+ - User segments
352
+ '/segments/{projectKey}/{environmentKey}/{userSegmentKey}':
353
+ get:
354
+ summary: Get a single user segment by key.
355
+ operationId: getUserSegment
356
+ parameters:
357
+ - $ref: '#/parameters/ProjectKey'
358
+ - $ref: '#/parameters/EnvironmentKey'
359
+ - $ref: '#/parameters/UserSegmentKey'
360
+ responses:
361
+ '200':
362
+ description: User segment response.
363
+ schema:
364
+ $ref: '#/definitions/UserSegment'
365
+ '401':
366
+ $ref: '#/responses/Standard401'
367
+ '404':
368
+ $ref: '#/responses/Standard404'
369
+ tags:
370
+ - User segments
371
+ patch:
372
+ summary: Perform a partial update to a user segment.
373
+ operationId: patchUserSegment
374
+ parameters:
375
+ - $ref: '#/parameters/ProjectKey'
376
+ - $ref: '#/parameters/EnvironmentKey'
377
+ - $ref: '#/parameters/UserSegmentKey'
378
+ - $ref: '#/parameters/PatchOnly'
379
+ responses:
380
+ '200':
381
+ $ref: '#/responses/UserSegment200'
382
+ '400':
383
+ $ref: '#/responses/Standard400'
384
+ '401':
385
+ $ref: '#/responses/Standard401'
386
+ '404':
387
+ $ref: '#/responses/Standard404'
388
+ '409':
389
+ $ref: '#/responses/Standard409'
390
+ tags:
391
+ - User segments
392
+ delete:
393
+ summary: Delete a user segment.
394
+ operationId: deleteUserSegment
395
+ parameters:
396
+ - $ref: '#/parameters/ProjectKey'
397
+ - $ref: '#/parameters/EnvironmentKey'
398
+ - $ref: '#/parameters/UserSegmentKey'
399
+ responses:
400
+ '204':
401
+ $ref: '#/responses/Standard204'
402
+ '401':
403
+ $ref: '#/responses/Standard401'
404
+ '404':
405
+ $ref: '#/responses/Standard404'
406
+ tags:
407
+ - User segments
408
+ '/users/{projectKey}/{environmentKey}':
409
+ get:
410
+ summary: >-
411
+ List all users in the environment. Includes the total count of users. In
412
+ each page, there will be up to 'limit' users returned (default 20). This
413
+ is useful for exporting all users in the system for further analysis.
414
+ Paginated collections will include a next link containing a URL with the
415
+ next set of elements in the collection.
416
+ operationId: getUsers
417
+ parameters:
418
+ - $ref: '#/parameters/ProjectKey'
419
+ - $ref: '#/parameters/EnvironmentKey'
420
+ - $ref: '#/parameters/Limit'
421
+ - $ref: '#/parameters/HMAC'
422
+ - $ref: '#/parameters/ScrollId'
423
+ responses:
424
+ '200':
425
+ description: Users response.
426
+ schema:
427
+ $ref: '#/definitions/Users'
428
+ '401':
429
+ $ref: '#/responses/Standard401'
430
+ tags:
431
+ - Users
432
+ '/user-search/{projectKey}/{environmentKey}':
433
+ get:
434
+ summary: >-
435
+ Search users in LaunchDarkly based on their last active date, or a
436
+ search query. It should not be used to enumerate all users in
437
+ LaunchDarkly-- use the List users API resource.
438
+ operationId: getSearchUsers
439
+ parameters:
440
+ - $ref: '#/parameters/ProjectKey'
441
+ - $ref: '#/parameters/EnvironmentKey'
442
+ - $ref: '#/parameters/Query'
443
+ - $ref: '#/parameters/Limit'
444
+ - $ref: '#/parameters/Offset'
445
+ - $ref: '#/parameters/After'
446
+ responses:
447
+ '200':
448
+ description: Users response.
449
+ schema:
450
+ $ref: '#/definitions/Users'
451
+ '401':
452
+ $ref: '#/responses/Standard401'
453
+ tags:
454
+ - Users
455
+ '/users/{projectKey}/{environmentKey}/{userKey}':
456
+ get:
457
+ summary: Get a user by key.
458
+ operationId: getUser
459
+ parameters:
460
+ - $ref: '#/parameters/ProjectKey'
461
+ - $ref: '#/parameters/EnvironmentKey'
462
+ - $ref: '#/parameters/UserKey'
463
+ responses:
464
+ '200':
465
+ description: User response.
466
+ schema:
467
+ $ref: '#/definitions/User'
468
+ '401':
469
+ $ref: '#/responses/Standard401'
470
+ '404':
471
+ $ref: '#/responses/Standard404'
472
+ tags:
473
+ - Users
474
+ delete:
475
+ summary: Delete a user by ID.
476
+ operationId: deleteUser
477
+ parameters:
478
+ - $ref: '#/parameters/ProjectKey'
479
+ - $ref: '#/parameters/EnvironmentKey'
480
+ - $ref: '#/parameters/UserKey'
481
+ responses:
482
+ '204':
483
+ $ref: '#/responses/Standard204'
484
+ '401':
485
+ $ref: '#/responses/Standard401'
486
+ '404':
487
+ $ref: '#/responses/Standard404'
488
+ tags:
489
+ - Users
490
+ '/users/{projectKey}/{environmentKey}/{userKey}/flags':
491
+ get:
492
+ summary: Fetch a single flag setting for a user by key.
493
+ operationId: getUserFlagSettings
494
+ parameters:
495
+ - $ref: '#/parameters/ProjectKey'
496
+ - $ref: '#/parameters/EnvironmentKey'
497
+ - $ref: '#/parameters/UserKey'
498
+ responses:
499
+ '200':
500
+ description: User flags settings response.
501
+ schema:
502
+ $ref: '#/definitions/UserFlagSettings'
503
+ '401':
504
+ $ref: '#/responses/Standard401'
505
+ '404':
506
+ $ref: '#/responses/Standard404'
507
+ tags:
508
+ - User settings
509
+ '/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}':
510
+ get:
511
+ summary: Fetch a single flag setting for a user by key.
512
+ operationId: getUserFlagSetting
513
+ parameters:
514
+ - $ref: '#/parameters/ProjectKey'
515
+ - $ref: '#/parameters/EnvironmentKey'
516
+ - $ref: '#/parameters/UserKey'
517
+ - $ref: '#/parameters/FeatureFlagKey'
518
+ responses:
519
+ '200':
520
+ description: User flag setting response.
521
+ schema:
522
+ $ref: '#/definitions/UserFlagSetting'
523
+ '401':
524
+ $ref: '#/responses/Standard401'
525
+ '404':
526
+ $ref: '#/responses/Standard404'
527
+ tags:
528
+ - User settings
529
+ put:
530
+ summary: >-
531
+ Specifically enable or disable a feature flag for a user based on their
532
+ key.
533
+ operationId: putFlagSetting
534
+ parameters:
535
+ - $ref: '#/parameters/ProjectKey'
536
+ - $ref: '#/parameters/EnvironmentKey'
537
+ - $ref: '#/parameters/UserKey'
538
+ - $ref: '#/parameters/FeatureFlagKey'
539
+ - $ref: '#/parameters/UserSettingsPutRequest'
540
+ responses:
541
+ '204':
542
+ $ref: '#/responses/Standard204'
543
+ '400':
544
+ $ref: '#/responses/Standard400'
545
+ '401':
546
+ $ref: '#/responses/Standard401'
547
+ '404':
548
+ $ref: '#/responses/Standard404'
549
+ tags:
550
+ - User settings
551
+ /auditlog:
552
+ get:
553
+ summary: >-
554
+ Get a list of all audit log entries. The query parameters allow you to
555
+ restrict the returned results by date ranges, resource specifiers, or a
556
+ full-text search query.
557
+ operationId: getAuditLogEntries
558
+ parameters:
559
+ - $ref: '#/parameters/Before'
560
+ - $ref: '#/parameters/After'
561
+ - $ref: '#/parameters/Q'
562
+ - $ref: '#/parameters/AuditLimit'
563
+ - $ref: '#/parameters/Spec'
564
+ responses:
565
+ '200':
566
+ description: Audit log entries response.
567
+ schema:
568
+ $ref: '#/definitions/AuditLogEntries'
569
+ '400':
570
+ $ref: '#/responses/Standard400'
571
+ '401':
572
+ $ref: '#/responses/Standard401'
573
+ tags:
574
+ - Audit log
575
+ '/auditlog/{resourceId}':
576
+ get:
577
+ summary: Use this endpoint to fetch a single audit log entry by its resouce ID.
578
+ operationId: getAuditLogEntry
579
+ parameters:
580
+ - $ref: '#/parameters/ResourceId'
581
+ responses:
582
+ '200':
583
+ description: Audit log entry response.
584
+ schema:
585
+ $ref: '#/definitions/AuditLogEntry'
586
+ '401':
587
+ $ref: '#/responses/Standard401'
588
+ '404':
589
+ $ref: '#/responses/Standard404'
590
+ tags:
591
+ - Audit log
592
+ /webhooks:
593
+ get:
594
+ summary: Fetch a list of all webhooks.
595
+ operationId: getWebhooks
596
+ responses:
597
+ '200':
598
+ description: Webhooks response.
599
+ schema:
600
+ $ref: '#/definitions/Webhooks'
601
+ '401':
602
+ $ref: '#/responses/Standard401'
603
+ tags:
604
+ - Webhooks
605
+ post:
606
+ summary: Create a webhook.
607
+ operationId: postWebhook
608
+ parameters:
609
+ - $ref: '#/parameters/WebhookPostRequest'
610
+ responses:
611
+ '201':
612
+ $ref: '#/responses/Standard201'
613
+ '400':
614
+ $ref: '#/responses/Standard400'
615
+ '401':
616
+ $ref: '#/responses/Standard401'
617
+ tags:
618
+ - Webhooks
619
+ '/webhooks/{resourceId}':
620
+ get:
621
+ summary: Get a webhook by ID.
622
+ operationId: getWebhook
623
+ parameters:
624
+ - $ref: '#/parameters/ResourceId'
625
+ responses:
626
+ '200':
627
+ $ref: '#/responses/Webhooks200'
628
+ '401':
629
+ $ref: '#/responses/Standard401'
630
+ '404':
631
+ $ref: '#/responses/Standard404'
632
+ tags:
633
+ - Webhooks
634
+ patch:
635
+ summary: Modify a webhook by ID.
636
+ operationId: patchWebhook
637
+ parameters:
638
+ - $ref: '#/parameters/ResourceId'
639
+ - $ref: '#/parameters/PatchRequest'
640
+ responses:
641
+ '200':
642
+ $ref: '#/responses/Webhooks200'
643
+ '400':
644
+ $ref: '#/responses/Standard400'
645
+ '401':
646
+ $ref: '#/responses/Standard401'
647
+ '404':
648
+ $ref: '#/responses/Standard404'
649
+ '409':
650
+ $ref: '#/responses/Standard409'
651
+ tags:
652
+ - Webhooks
653
+ delete:
654
+ summary: Delete a webhook by ID.
655
+ operationId: deleteWebhook
656
+ parameters:
657
+ - $ref: '#/parameters/ResourceId'
658
+ responses:
659
+ '204':
660
+ $ref: '#/responses/Standard204'
661
+ '401':
662
+ $ref: '#/responses/Standard401'
663
+ '404':
664
+ $ref: '#/responses/Standard404'
665
+ tags:
666
+ - Webhooks
667
+ /roles:
668
+ get:
669
+ summary: Return a complete list of custom roles.
670
+ operationId: getCustomRoles
671
+ responses:
672
+ '200':
673
+ description: Custom roles response.
674
+ schema:
675
+ $ref: '#/definitions/CustomRoles'
676
+ '401':
677
+ $ref: '#/responses/Standard401'
678
+ tags:
679
+ - Custom roles
680
+ post:
681
+ summary: Create a new custom role.
682
+ operationId: postCustomRole
683
+ parameters:
684
+ - $ref: '#/parameters/CustomRolePostRequest'
685
+ responses:
686
+ '201':
687
+ $ref: '#/responses/Standard201'
688
+ '400':
689
+ $ref: '#/responses/Standard400'
690
+ '401':
691
+ $ref: '#/responses/Standard401'
692
+ '409':
693
+ $ref: '#/responses/Standard409'
694
+ tags:
695
+ - Custom roles
696
+ '/roles/{customRoleKey}':
697
+ get:
698
+ summary: Get one custom role by key.
699
+ operationId: getCustomRole
700
+ parameters:
701
+ - $ref: '#/parameters/CustomRoleKey'
702
+ responses:
703
+ '200':
704
+ $ref: '#/responses/CustomRole200'
705
+ '400':
706
+ $ref: '#/responses/Standard400'
707
+ '401':
708
+ $ref: '#/responses/Standard401'
709
+ tags:
710
+ - Custom roles
711
+ patch:
712
+ summary: Modify a custom role by key.
713
+ operationId: patchCustomRole
714
+ parameters:
715
+ - $ref: '#/parameters/CustomRoleKey'
716
+ - $ref: '#/parameters/PatchRequest'
717
+ responses:
718
+ '200':
719
+ $ref: '#/responses/CustomRole200'
720
+ '400':
721
+ $ref: '#/responses/Standard400'
722
+ '401':
723
+ $ref: '#/responses/Standard401'
724
+ '404':
725
+ $ref: '#/responses/Standard404'
726
+ '409':
727
+ $ref: '#/responses/Standard409'
728
+ tags:
729
+ - Custom roles
730
+ delete:
731
+ summary: Delete a custom role by key.
732
+ operationId: deleteCustomRole
733
+ parameters:
734
+ - $ref: '#/parameters/CustomRoleKey'
735
+ responses:
736
+ '204':
737
+ $ref: '#/responses/Standard204'
738
+ '401':
739
+ $ref: '#/responses/Standard401'
740
+ '404':
741
+ $ref: '#/responses/Standard404'
742
+ tags:
743
+ - Custom roles
744
+ /members:
745
+ get:
746
+ summary: Returns a list of all members in the account.
747
+ operationId: getMembers
748
+ responses:
749
+ '200':
750
+ description: Projects response.
751
+ schema:
752
+ $ref: '#/definitions/Members'
753
+ '401':
754
+ $ref: '#/responses/Standard401'
755
+ tags:
756
+ - Team members
757
+ post:
758
+ summary: Invite new members.
759
+ operationId: postMembers
760
+ parameters:
761
+ - $ref: '#/parameters/MembersPostRequest'
762
+ responses:
763
+ '201':
764
+ $ref: '#/responses/Standard201'
765
+ '400':
766
+ $ref: '#/responses/Standard400'
767
+ '401':
768
+ $ref: '#/responses/Standard401'
769
+ '409':
770
+ $ref: '#/responses/Standard409'
771
+ tags:
772
+ - Team members
773
+ '/members/{memberId}':
774
+ get:
775
+ summary: Get a single team member by ID.
776
+ operationId: getMember
777
+ parameters:
778
+ - $ref: '#/parameters/MemberId'
779
+ responses:
780
+ '200':
781
+ $ref: '#/responses/Member200'
782
+ '400':
783
+ $ref: '#/responses/Standard400'
784
+ '401':
785
+ $ref: '#/responses/Standard401'
786
+ tags:
787
+ - Team members
788
+ patch:
789
+ summary: Modify a team member by ID.
790
+ operationId: patchMember
791
+ parameters:
792
+ - $ref: '#/parameters/MemberId'
793
+ - $ref: '#/parameters/PatchRequest'
794
+ responses:
795
+ '200':
796
+ $ref: '#/responses/Member200'
797
+ '400':
798
+ $ref: '#/responses/Standard400'
799
+ '401':
800
+ $ref: '#/responses/Standard401'
801
+ '404':
802
+ $ref: '#/responses/Standard404'
803
+ '409':
804
+ $ref: '#/responses/Standard409'
805
+ tags:
806
+ - Team members
807
+ delete:
808
+ summary: Delete a team member by ID.
809
+ operationId: deleteMember
810
+ parameters:
811
+ - $ref: '#/parameters/MemberId'
812
+ responses:
813
+ '204':
814
+ $ref: '#/responses/Standard204'
815
+ '401':
816
+ $ref: '#/responses/Standard401'
817
+ '404':
818
+ $ref: '#/responses/Standard404'
819
+ tags:
820
+ - Team members
821
+ /:
822
+ get:
823
+ description: >-
824
+ You can issue a GET request to the root resource to find all of the
825
+ resource categories supported by the API.
826
+ operationId: getRoot
827
+ responses:
828
+ '200':
829
+ $ref: '#/responses/Root200'
830
+ '401':
831
+ $ref: '#/responses/Standard401'
832
+ tags:
833
+ - Root
834
+ definitions:
835
+ Link:
836
+ type: object
837
+ properties:
838
+ href:
839
+ type: string
840
+ example: /api/v2/endpoint
841
+ type:
842
+ type: string
843
+ example: application/json
844
+ Links:
845
+ type: object
846
+ properties:
847
+ self:
848
+ $ref: '#/definitions/Link'
849
+ next:
850
+ $ref: '#/definitions/Link'
851
+ Webhook:
852
+ type: object
853
+ properties:
854
+ _links:
855
+ $ref: '#/definitions/Links'
856
+ _id:
857
+ $ref: '#/definitions/Id'
858
+ url:
859
+ type: string
860
+ description: The URL of the remote webhook.
861
+ example: 'https://example.com/example'
862
+ secret:
863
+ type: string
864
+ description: >-
865
+ If defined, the webhooks post request will include a X-LD-Signature
866
+ header whose value will contain an HMAC SHA256 hex digest of the
867
+ webhook payload, using the secret as the key.
868
+ example: frobozz
869
+ 'on':
870
+ type: boolean
871
+ description: Whether this webhook is enabled or not.
872
+ example: true
873
+ name:
874
+ type: string
875
+ description: The name of the webhook.
876
+ example: Example hook
877
+ tags:
878
+ type: array
879
+ description: Tags assigned to this webhook.
880
+ items:
881
+ type: string
882
+ example: []
883
+ Webhooks:
884
+ type: object
885
+ properties:
886
+ _links:
887
+ $ref: '#/definitions/Links'
888
+ items:
889
+ type: array
890
+ items:
891
+ $ref: '#/definitions/Webhook'
892
+ FeatureFlag:
893
+ type: object
894
+ properties:
895
+ key:
896
+ type: string
897
+ example: test-feature
898
+ name:
899
+ type: string
900
+ description: Name of the feature flag.
901
+ example: Test Feature
902
+ description:
903
+ type: string
904
+ description: Description of the feature flag.
905
+ example: This flag controls whether test feature is turned on or not.
906
+ kind:
907
+ type: string
908
+ description: Whether the feature flag is a boolean flag or multivariate.
909
+ example: boolean
910
+ creationDate:
911
+ type: number
912
+ format: int64
913
+ description: >-
914
+ A unix epoch time in milliseconds specifying the creation time of this
915
+ flag.
916
+ example: 1443652232590
917
+ includeInSnippet:
918
+ type: boolean
919
+ example: false
920
+ temporary:
921
+ type: boolean
922
+ description: Whether or not this flag is temporary.
923
+ example: false
924
+ maintainerId:
925
+ type: string
926
+ description: The ID of the member that should maintain this flag.
927
+ example: 561c579cd8fd5c2704000001
928
+ tags:
929
+ type: array
930
+ description: An array of tags for this feature flag.
931
+ items:
932
+ type: string
933
+ example: []
934
+ variations:
935
+ type: array
936
+ description: The variations for this feature flag.
937
+ items:
938
+ $ref: '#/definitions/Variation'
939
+ example:
940
+ - value: a
941
+ - value: b
942
+ _version:
943
+ type: integer
944
+ example: 23
945
+ customProperties:
946
+ $ref: '#/definitions/CustomProperties'
947
+ _links:
948
+ $ref: '#/definitions/Links'
949
+ _maintainer:
950
+ $ref: '#/definitions/Member'
951
+ environments:
952
+ type: object
953
+ additionalProperties:
954
+ $ref: '#/definitions/FeatureFlagConfig'
955
+ FeatureFlags:
956
+ type: object
957
+ properties:
958
+ _links:
959
+ $ref: '#/definitions/Links'
960
+ items:
961
+ type: array
962
+ items:
963
+ $ref: '#/definitions/FeatureFlag'
964
+ Member:
965
+ type: object
966
+ properties:
967
+ _links:
968
+ $ref: '#/definitions/Links'
969
+ _id:
970
+ $ref: '#/definitions/Id'
971
+ role:
972
+ $ref: '#/definitions/Role'
973
+ email:
974
+ type: string
975
+ example: user@launchdarkly.com
976
+ _pendingInvite:
977
+ type: boolean
978
+ isBeta:
979
+ type: boolean
980
+ customRoles:
981
+ type: array
982
+ items:
983
+ $ref: '#/definitions/Id'
984
+ Members:
985
+ type: object
986
+ properties:
987
+ _links:
988
+ $ref: '#/definitions/Links'
989
+ items:
990
+ $ref: '#/definitions/Member'
991
+ FeatureFlagConfig:
992
+ type: object
993
+ properties:
994
+ 'on':
995
+ type: boolean
996
+ archived:
997
+ type: boolean
998
+ salt:
999
+ type: string
1000
+ example: YWx0ZXJuYXRlLnBhZ2U=
1001
+ sel:
1002
+ type: string
1003
+ example: 45501b9314dc4641841af774cb038b96
1004
+ lastModified:
1005
+ type: integer
1006
+ format: int64
1007
+ example: 1469326565348
1008
+ version:
1009
+ type: integer
1010
+ example: 65
1011
+ targets:
1012
+ type: array
1013
+ items:
1014
+ $ref: '#/definitions/Target'
1015
+ goalIds:
1016
+ type: array
1017
+ example:
1018
+ - d7239405bd89c930e885aa76
1019
+ - 405bc930e88d7239d895aa76
1020
+ items:
1021
+ type: string
1022
+ rules:
1023
+ type: array
1024
+ items:
1025
+ $ref: '#/definitions/Rule'
1026
+ fallthrough:
1027
+ $ref: '#/definitions/Fallthrough'
1028
+ offVariation:
1029
+ type: integer
1030
+ prerequisites:
1031
+ type: array
1032
+ items:
1033
+ $ref: '#/definitions/Prerequisite'
1034
+ trackEvents:
1035
+ type: boolean
1036
+ example: false
1037
+ description: Set to true to send detailed event information for this flag.
1038
+ Target:
1039
+ type: object
1040
+ properties:
1041
+ values:
1042
+ type: array
1043
+ items:
1044
+ type: string
1045
+ example: '"1461797806427-7-115540266", "00142875-a39d-4028-a3b7-987ccd151649"'
1046
+ variation:
1047
+ type: integer
1048
+ Rule:
1049
+ type: object
1050
+ properties:
1051
+ _id:
1052
+ type: string
1053
+ variation:
1054
+ type: integer
1055
+ rollout:
1056
+ $ref: '#/definitions/Rollout'
1057
+ clauses:
1058
+ type: array
1059
+ items:
1060
+ $ref: '#/definitions/Clause'
1061
+ Fallthrough:
1062
+ type: object
1063
+ properties:
1064
+ variation:
1065
+ type: integer
1066
+ rollout:
1067
+ $ref: '#/definitions/Rollout'
1068
+ Rollout:
1069
+ type: object
1070
+ properties:
1071
+ variations:
1072
+ type: array
1073
+ items:
1074
+ $ref: '#/definitions/WeightedVariation'
1075
+ WeightedVariation:
1076
+ type: object
1077
+ properties:
1078
+ variation:
1079
+ type: integer
1080
+ weight:
1081
+ type: integer
1082
+ Clause:
1083
+ type: object
1084
+ properties:
1085
+ attribute:
1086
+ type: string
1087
+ example: groups
1088
+ op:
1089
+ type: string
1090
+ example: in
1091
+ values:
1092
+ type: array
1093
+ items:
1094
+ type: object
1095
+ example: Top Customers
1096
+ negate:
1097
+ type: boolean
1098
+ Variation:
1099
+ type: object
1100
+ required:
1101
+ - value
1102
+ properties:
1103
+ name:
1104
+ type: string
1105
+ example: 'True'
1106
+ description:
1107
+ type: string
1108
+ example: The true variation
1109
+ value:
1110
+ type: object
1111
+ Prerequisite:
1112
+ type: object
1113
+ properties:
1114
+ key:
1115
+ type: string
1116
+ variation:
1117
+ type: integer
1118
+ FeatureFlagStatus:
1119
+ type: object
1120
+ properties:
1121
+ _links:
1122
+ $ref: '#/definitions/Links'
1123
+ name:
1124
+ type: string
1125
+ description: >
1126
+ | Name | Description |
1127
+
1128
+ | --------:| ----------- |
1129
+
1130
+ | new | the feature flag was created within the last 7 days, and
1131
+ has not been requested yet |
1132
+
1133
+ | active | the feature flag was requested by your servers or clients
1134
+ within the last 7 days |
1135
+
1136
+ | inactive | the feature flag was created more than 7 days ago, and
1137
+ hasn't been requested by your servers or clients within the past 7
1138
+ days |
1139
+
1140
+ | launched | one variation of the feature flag has been rolled out to
1141
+ all your users for at least 7 days |
1142
+ enum:
1143
+ - new
1144
+ - active
1145
+ - inactive
1146
+ - launched
1147
+ lastRequested:
1148
+ type: string
1149
+ example: '2016-08-16T21:10:11.886Z'
1150
+ default:
1151
+ type: object
1152
+ FeatureFlagStatuses:
1153
+ type: object
1154
+ properties:
1155
+ _links:
1156
+ $ref: '#/definitions/Links'
1157
+ items:
1158
+ type: array
1159
+ items:
1160
+ $ref: '#/definitions/FeatureFlagStatus'
1161
+ UserSegment:
1162
+ type: object
1163
+ required:
1164
+ - key
1165
+ - name
1166
+ - creationDate
1167
+ properties:
1168
+ key:
1169
+ type: string
1170
+ description: Unique identifier for the user segment.
1171
+ example: beta-testers
1172
+ name:
1173
+ type: string
1174
+ description: Name of the user segment.
1175
+ example: Beta Testers
1176
+ description:
1177
+ type: string
1178
+ description: Description of the user segment.
1179
+ example: Users in this segment can access beta features.
1180
+ tags:
1181
+ type: array
1182
+ items:
1183
+ type: string
1184
+ example:
1185
+ - dev
1186
+ - ops
1187
+ description: An array of tags for this user segment.
1188
+ creationDate:
1189
+ type: number
1190
+ format: int64
1191
+ description: >-
1192
+ A unix epoch time in milliseconds specifying the creation time of this
1193
+ flag.
1194
+ example: 1443652232590
1195
+ included:
1196
+ type: array
1197
+ items:
1198
+ type: string
1199
+ description: An array of user keys that are included in this segment.
1200
+ excluded:
1201
+ type: array
1202
+ items:
1203
+ type: string
1204
+ description: >-
1205
+ An array of user keys that should not be included in this segment,
1206
+ unless they are also listed in "included".
1207
+ rules:
1208
+ type: array
1209
+ items:
1210
+ $ref: '#/definitions/UserSegmentRule'
1211
+ description: >-
1212
+ An array of rules that can cause a user to be included in this
1213
+ segment.
1214
+ version:
1215
+ type: integer
1216
+ _links:
1217
+ $ref: '#/definitions/Links'
1218
+ UserSegmentRule:
1219
+ type: object
1220
+ properties:
1221
+ clauses:
1222
+ type: array
1223
+ items:
1224
+ $ref: '#/definitions/Clause'
1225
+ weight:
1226
+ type: integer
1227
+ bucketBy:
1228
+ type: string
1229
+ UserSegments:
1230
+ type: object
1231
+ properties:
1232
+ _links:
1233
+ $ref: '#/definitions/Links'
1234
+ items:
1235
+ type: array
1236
+ items:
1237
+ $ref: '#/definitions/UserSegment'
1238
+ Project:
1239
+ type: object
1240
+ properties:
1241
+ _links:
1242
+ $ref: '#/definitions/Links'
1243
+ _id:
1244
+ $ref: '#/definitions/Id'
1245
+ key:
1246
+ type: string
1247
+ example: zentasks
1248
+ name:
1249
+ type: string
1250
+ example: Zentasks
1251
+ environments:
1252
+ type: array
1253
+ items:
1254
+ $ref: '#/definitions/Environment'
1255
+ tags:
1256
+ type: array
1257
+ items:
1258
+ type: string
1259
+ description: An array of tags for this project.
1260
+ Projects:
1261
+ type: object
1262
+ properties:
1263
+ _links:
1264
+ $ref: '#/definitions/Links'
1265
+ items:
1266
+ type: array
1267
+ items:
1268
+ $ref: '#/definitions/Project'
1269
+ Environment:
1270
+ type: object
1271
+ properties:
1272
+ _links:
1273
+ $ref: '#/definitions/Links'
1274
+ _id:
1275
+ $ref: '#/definitions/Id'
1276
+ key:
1277
+ type: string
1278
+ example: production
1279
+ description: The key for the environment.
1280
+ name:
1281
+ type: string
1282
+ example: Production
1283
+ description: The name of the environment.
1284
+ apiKey:
1285
+ type: string
1286
+ example: XXX
1287
+ description: The SDK key for backend LaunchDarkly SDKs.
1288
+ mobileKey:
1289
+ type: string
1290
+ example: XXX
1291
+ description: The SDK key for mobile LaunchDarkly SDKs.
1292
+ color:
1293
+ type: string
1294
+ example: '417505'
1295
+ description: The swatch color for the environment.
1296
+ defaultTtl:
1297
+ type: number
1298
+ example: 0
1299
+ description: The default TTL.
1300
+ secureMode:
1301
+ type: boolean
1302
+ example: false
1303
+ description: Determines if this environment is in safe mode.
1304
+ defaultTrackEvents:
1305
+ type: boolean
1306
+ example: false
1307
+ description: Set to true to send detailed event information for new flags.
1308
+ tags:
1309
+ type: array
1310
+ items:
1311
+ type: string
1312
+ description: An array of tags for this environment.
1313
+ EnvironmentPost:
1314
+ type: object
1315
+ properties:
1316
+ name:
1317
+ type: string
1318
+ description: The name of the new environment.
1319
+ example: Development
1320
+ key:
1321
+ type: string
1322
+ description: A project-unique key for the new environment.
1323
+ example: dev
1324
+ color:
1325
+ type: string
1326
+ description: 'A color swatch (as an RGB hex value with no leading ''#'', e.g. C8C8C8).'
1327
+ example: '417505'
1328
+ defaultTtl:
1329
+ type: number
1330
+ description: The default TTL for the new environment.
1331
+ example: 0
1332
+ required:
1333
+ - name
1334
+ - key
1335
+ - color
1336
+ User:
1337
+ type: object
1338
+ properties:
1339
+ key:
1340
+ type: string
1341
+ example: a00bea
1342
+ secondary:
1343
+ type: string
1344
+ ip:
1345
+ type: string
1346
+ country:
1347
+ type: string
1348
+ email:
1349
+ type: string
1350
+ firstName:
1351
+ type: string
1352
+ lastName:
1353
+ type: string
1354
+ avatar:
1355
+ type: string
1356
+ name:
1357
+ type: string
1358
+ example: Bob Loblaw
1359
+ anonymous:
1360
+ type: boolean
1361
+ custom:
1362
+ type: object
1363
+ example:
1364
+ company: example.com
1365
+ UserRecord:
1366
+ type: object
1367
+ properties:
1368
+ lastPing:
1369
+ type: string
1370
+ format: int64
1371
+ example: '2015-03-03T02:37:22.492Z'
1372
+ environmentId:
1373
+ type: string
1374
+ example: 54ac2d97de674204ddd61096
1375
+ ownerId:
1376
+ $ref: '#/definitions/Id'
1377
+ user:
1378
+ $ref: '#/definitions/User'
1379
+ avatar:
1380
+ type: string
1381
+ example: 'https://s3.amazonaws.com/uifaces/faces/twitter/shylockjoy/73.jpg'
1382
+ Users:
1383
+ type: object
1384
+ properties:
1385
+ _links:
1386
+ $ref: '#/definitions/Links'
1387
+ totalCount:
1388
+ type: number
1389
+ example: 3
1390
+ items:
1391
+ type: array
1392
+ items:
1393
+ $ref: '#/definitions/UserRecord'
1394
+ AuditLogEntry:
1395
+ type: object
1396
+ properties:
1397
+ _links:
1398
+ $ref: '#/definitions/Links'
1399
+ _id:
1400
+ $ref: '#/definitions/Id'
1401
+ date:
1402
+ type: integer
1403
+ format: int64
1404
+ example: 1472243938774
1405
+ kind:
1406
+ type: string
1407
+ example: environment
1408
+ name:
1409
+ type: string
1410
+ example: Testing
1411
+ description:
1412
+ type: string
1413
+ example: Changed the name from Test to Testing
1414
+ shortDescription:
1415
+ type: string
1416
+ example: '""'
1417
+ comment:
1418
+ type: string
1419
+ example: This is a comment string
1420
+ member:
1421
+ $ref: '#/definitions/Member'
1422
+ titleVerb:
1423
+ type: string
1424
+ example: changed the name of
1425
+ title:
1426
+ type: string
1427
+ example: >-
1428
+ [Reese Applebaum](mailto:refapp@launchdarkly.com) changed the name of
1429
+ [Testing](https://app.launchdarkly.com/settings#/projects)
1430
+ target:
1431
+ type: object
1432
+ properties:
1433
+ _links:
1434
+ $ref: '#/definitions/Links'
1435
+ name:
1436
+ type: string
1437
+ example: Testing
1438
+ resources:
1439
+ type: array
1440
+ items:
1441
+ type: string
1442
+ example: 'proj/alexis:env/test'
1443
+ AuditLogEntries:
1444
+ type: object
1445
+ properties:
1446
+ _links:
1447
+ $ref: '#/definitions/Links'
1448
+ items:
1449
+ type: array
1450
+ items:
1451
+ $ref: '#/definitions/AuditLogEntry'
1452
+ UserFlagSetting:
1453
+ type: object
1454
+ properties:
1455
+ _links:
1456
+ $ref: '#/definitions/Links'
1457
+ _value:
1458
+ type: boolean
1459
+ description: >-
1460
+ The most important attribute in the response. The _value is the
1461
+ current setting for the user. For a boolean feature toggle, this will
1462
+ be true, false, or null if there is no defined fallthrough value.
1463
+ example: true
1464
+ setting:
1465
+ type: boolean
1466
+ description: >-
1467
+ The setting attribute indicates whether you've explicitly targeted
1468
+ this user to receive a particular variation. For example, if you have
1469
+ explicitly turned off a feature toggle for a user, setting will be
1470
+ false. A setting of null means that you haven't assigned that user to
1471
+ a specific variation.
1472
+ example: null
1473
+ UserFlagSettings:
1474
+ type: object
1475
+ properties:
1476
+ _links:
1477
+ $ref: '#/definitions/Links'
1478
+ items:
1479
+ type: object
1480
+ additionalProperties:
1481
+ $ref: '#/definitions/UserFlagSetting'
1482
+ example:
1483
+ sort.order:
1484
+ _links:
1485
+ self:
1486
+ href: /api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order
1487
+ type: application/json
1488
+ _value: true
1489
+ setting: null
1490
+ alternate.page:
1491
+ _links:
1492
+ self:
1493
+ href: >-
1494
+ /api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page
1495
+ type: application/json
1496
+ _value: 'false,'
1497
+ setting: null
1498
+ Statements:
1499
+ type: array
1500
+ items:
1501
+ $ref: '#/definitions/Statement'
1502
+ Statement:
1503
+ type: object
1504
+ properties:
1505
+ resources:
1506
+ $ref: '#/definitions/Resources'
1507
+ notresources:
1508
+ $ref: '#/definitions/Resources'
1509
+ description: >-
1510
+ Targeted resource will be those resources NOT in this list. The
1511
+ "resources`" field must be empty to use this field.
1512
+ actions:
1513
+ $ref: '#/definitions/Actions'
1514
+ notactions:
1515
+ $ref: '#/definitions/Actions'
1516
+ description: >-
1517
+ Targeted actions will be those actions NOT in this list. The "actions"
1518
+ field must be empty to use this field.
1519
+ effect:
1520
+ type: string
1521
+ enum:
1522
+ - allow
1523
+ - deny
1524
+ Resources:
1525
+ type: array
1526
+ items:
1527
+ $ref: '#/definitions/Resource'
1528
+ Resource:
1529
+ type: string
1530
+ description: A resource specifier string
1531
+ example: 'proj/*:env/*:flag/my-flag'
1532
+ Actions:
1533
+ type: array
1534
+ items:
1535
+ $ref: '#/definitions/Action'
1536
+ Action:
1537
+ type: string
1538
+ description: An action to perform on a resource.
1539
+ example: updateOn
1540
+ Role:
1541
+ type: string
1542
+ enum:
1543
+ - writer
1544
+ - reader
1545
+ - admin
1546
+ - owner
1547
+ CustomRoleKeyOrId:
1548
+ type: string
1549
+ description: The 20-hexdigit id or the key for a custom role.
1550
+ example: revenue-team
1551
+ CustomRole:
1552
+ type: object
1553
+ properties:
1554
+ _links:
1555
+ $ref: '#/definitions/Links'
1556
+ name:
1557
+ type: string
1558
+ description: Name of the custom role.
1559
+ example: revenue team
1560
+ key:
1561
+ $ref: '#/definitions/CustomRoleKeyOrId'
1562
+ description:
1563
+ type: string
1564
+ description: Description of the custom role.
1565
+ example: Description of revenue team role here
1566
+ _id:
1567
+ $ref: '#/definitions/Id'
1568
+ policy:
1569
+ type: array
1570
+ items:
1571
+ $ref: '#/definitions/Policy'
1572
+ CustomRoles:
1573
+ type: object
1574
+ properties:
1575
+ _links:
1576
+ $ref: '#/definitions/Links'
1577
+ items:
1578
+ $ref: '#/definitions/CustomRole'
1579
+ Policy:
1580
+ type: object
1581
+ properties:
1582
+ resources:
1583
+ $ref: '#/definitions/Resources'
1584
+ actions:
1585
+ $ref: '#/definitions/Actions'
1586
+ effect:
1587
+ type: string
1588
+ description: Effect of the policy - allow or deny.
1589
+ example: deny
1590
+ Id:
1591
+ type: string
1592
+ description: The unique resource id.
1593
+ example: 5a580a01b4ff89217bdf9dc1
1594
+ PatchOperation:
1595
+ type: object
1596
+ properties:
1597
+ op:
1598
+ type: string
1599
+ example: replace
1600
+ path:
1601
+ type: string
1602
+ example: /on
1603
+ value:
1604
+ type: object
1605
+ required:
1606
+ - op
1607
+ - path
1608
+ - value
1609
+ CustomProperties:
1610
+ type: object
1611
+ description: A mapping of keys to CustomProperty entries.
1612
+ items:
1613
+ $ref: '#/definitions/CustomProperty'
1614
+ example:
1615
+ bugs:
1616
+ name: Issue tracker ids
1617
+ value:
1618
+ - '123'
1619
+ - '456'
1620
+ deprecated:
1621
+ name: Deprecated Date
1622
+ value: []
1623
+ CustomProperty:
1624
+ type: object
1625
+ description: A name and value describing a custom property.
1626
+ properties:
1627
+ name:
1628
+ type: string
1629
+ description: The name of the property.
1630
+ example: My property
1631
+ value:
1632
+ $ref: '#/definitions/CustomPropertyValues'
1633
+ required:
1634
+ - name
1635
+ CustomPropertyValues:
1636
+ type: array
1637
+ description: Values for this property.
1638
+ items:
1639
+ type: string
1640
+ example:
1641
+ - Value 1
1642
+ - Value 2
1643
+ responses:
1644
+ Standard201:
1645
+ description: Resource created.
1646
+ Standard204:
1647
+ description: Action completed successfully.
1648
+ Standard400:
1649
+ description: Invalid request body.
1650
+ Standard401:
1651
+ description: Invalid access token.
1652
+ Standard404:
1653
+ description: Invalid resource specifier.
1654
+ Standard409:
1655
+ description: Status conflict.
1656
+ Root200:
1657
+ description: A list of links to available resources in the API.
1658
+ schema:
1659
+ $ref: '#/definitions/Links'
1660
+ Webhooks200:
1661
+ description: Webhook response.
1662
+ schema:
1663
+ $ref: '#/definitions/Webhook'
1664
+ UserSegment200:
1665
+ description: User segment response.
1666
+ schema:
1667
+ $ref: '#/definitions/UserSegment'
1668
+ Projects200:
1669
+ description: Successful Project response.
1670
+ schema:
1671
+ $ref: '#/definitions/Project'
1672
+ Member200:
1673
+ description: Member response.
1674
+ schema:
1675
+ $ref: '#/definitions/Member'
1676
+ CustomRole200:
1677
+ description: Custom role response.
1678
+ schema:
1679
+ $ref: '#/definitions/CustomRole'
1680
+ parameters:
1681
+ ResourceId:
1682
+ name: resourceId
1683
+ in: path
1684
+ required: true
1685
+ description: The resource ID.
1686
+ type: string
1687
+ WebhookPostRequest:
1688
+ name: webhookBody
1689
+ in: body
1690
+ required: true
1691
+ description: New webhook.
1692
+ schema:
1693
+ type: object
1694
+ properties:
1695
+ url:
1696
+ example: 'https://example.com/example'
1697
+ type: string
1698
+ description: The URL of the remote webhook.
1699
+ secret:
1700
+ example: <password>
1701
+ type: string
1702
+ description: >-
1703
+ If sign is true, and the secret attribute is omitted, LaunchDarkly
1704
+ will automatically generate a secret for you.
1705
+ sign:
1706
+ type: boolean
1707
+ description: >-
1708
+ If sign is false, the webhook will not include a signature header,
1709
+ and the secret can be omitted.
1710
+ 'on':
1711
+ type: boolean
1712
+ example: true
1713
+ description: Whether this webhook is enabled or not.
1714
+ name:
1715
+ type: string
1716
+ example: Example hook
1717
+ description: The name of the webhook.
1718
+ required:
1719
+ - url
1720
+ - sign
1721
+ - 'on'
1722
+ FeatureFlagPostRequest:
1723
+ name: featureFlagBody
1724
+ in: body
1725
+ required: true
1726
+ description: Create a new feature flag.
1727
+ schema:
1728
+ type: object
1729
+ properties:
1730
+ name:
1731
+ type: string
1732
+ description: >-
1733
+ A human-friendly name for the feature flag. Remember to note if this
1734
+ flag is intended to be temporary or permanent.
1735
+ example: new test flag
1736
+ key:
1737
+ type: string
1738
+ description: A unique key that will be used to reference the flag in your code.
1739
+ example: new-test-flag
1740
+ description:
1741
+ type: string
1742
+ description: A description of the feature flag.
1743
+ example: This flag controls whether test feature is turned on or not.
1744
+ variations:
1745
+ type: array
1746
+ items:
1747
+ $ref: '#/definitions/Variation'
1748
+ description: An array of possible variations for the flag.
1749
+ temporary:
1750
+ type: boolean
1751
+ description: Whether or not the flag is a temporary flag.
1752
+ tags:
1753
+ type: array
1754
+ items:
1755
+ type: string
1756
+ example: []
1757
+ description: Tags for the feature flag.
1758
+ includeInSnippet:
1759
+ type: boolean
1760
+ description: >-
1761
+ Whether or not this flag should be made available to the client-side
1762
+ JavaScript SDK.
1763
+ required:
1764
+ - name
1765
+ - key
1766
+ - variations
1767
+ UserSegmentPostRequest:
1768
+ name: userSegmentBody
1769
+ in: body
1770
+ required: true
1771
+ description: Create a new user segment.
1772
+ schema:
1773
+ type: object
1774
+ properties:
1775
+ name:
1776
+ type: string
1777
+ description: A human-friendly name for the user segment.
1778
+ example: new segment
1779
+ key:
1780
+ type: string
1781
+ description: >-
1782
+ A unique key that will be used to reference the user segment in
1783
+ feature flags.
1784
+ example: new-segment
1785
+ description:
1786
+ type: string
1787
+ description: A description for the user segment.
1788
+ example: Users in this segment will have access to beta features.
1789
+ tags:
1790
+ type: array
1791
+ items:
1792
+ type: string
1793
+ example: []
1794
+ description: Tags for the user segment.
1795
+ required:
1796
+ - name
1797
+ - key
1798
+ ProjectPostRequest:
1799
+ name: projectBody
1800
+ in: body
1801
+ required: true
1802
+ description: Project keys must be unique within an account.
1803
+ schema:
1804
+ type: object
1805
+ properties:
1806
+ name:
1807
+ type: string
1808
+ example: New Project
1809
+ key:
1810
+ type: string
1811
+ example: new-project
1812
+ environments:
1813
+ type: array
1814
+ items:
1815
+ $ref: '#/definitions/EnvironmentPost'
1816
+ minLength: 1
1817
+ required:
1818
+ - name
1819
+ - key
1820
+ EnvironmentPostRequest:
1821
+ name: environmentBody
1822
+ in: body
1823
+ required: true
1824
+ description: New environment.
1825
+ schema:
1826
+ $ref: '#/definitions/EnvironmentPost'
1827
+ ProjectKey:
1828
+ name: projectKey
1829
+ in: path
1830
+ required: true
1831
+ description: >-
1832
+ The project key, used to tie the flags together under one project so they
1833
+ can be managed together.
1834
+ type: string
1835
+ EnvironmentKey:
1836
+ name: environmentKey
1837
+ in: path
1838
+ required: true
1839
+ description: >-
1840
+ The environment key, used to tie together flag configuration and users
1841
+ under one environment so they can be managed together.
1842
+ type: string
1843
+ EnvironmentKeyQuery:
1844
+ name: env
1845
+ in: query
1846
+ required: false
1847
+ description: >-
1848
+ By default, each feature will include configurations for each environment.
1849
+ You can filter environments with the env query parameter. For example,
1850
+ setting env=production will restrict the returned configurations to just
1851
+ your production environment.
1852
+ type: string
1853
+ FeatureFlagKey:
1854
+ name: featureFlagKey
1855
+ in: path
1856
+ required: true
1857
+ description: The feature flag's key. The key identifies the flag in your code.
1858
+ type: string
1859
+ CloneFlagKeyQuery:
1860
+ name: clone
1861
+ in: query
1862
+ required: false
1863
+ description: >-
1864
+ The key of the feature flag to be cloned. The key identifies the flag in
1865
+ your code. For example, setting clone=flagKey will copy the full
1866
+ targeting configuration for all environments (including on/off state) from
1867
+ the original flag to the new flag.
1868
+ type: string
1869
+ UserSegmentKey:
1870
+ name: userSegmentKey
1871
+ in: path
1872
+ required: true
1873
+ description: The user segment's key. The key identifies the user segment in your code.
1874
+ type: string
1875
+ UserKey:
1876
+ name: userKey
1877
+ in: path
1878
+ required: true
1879
+ description: The user's key.
1880
+ type: string
1881
+ Tag:
1882
+ name: tag
1883
+ in: query
1884
+ required: false
1885
+ description: Filter by tag. A tag can be used to group flags across projects.
1886
+ type: string
1887
+ Limit:
1888
+ name: limit
1889
+ in: query
1890
+ required: false
1891
+ description: Pagination limit.
1892
+ type: integer
1893
+ Query:
1894
+ name: q
1895
+ in: query
1896
+ required: false
1897
+ description: Search query.
1898
+ type: string
1899
+ HMAC:
1900
+ name: h
1901
+ in: query
1902
+ required: false
1903
+ description: This parameter is required when following "next" links.
1904
+ type: string
1905
+ ScrollId:
1906
+ name: scrollId
1907
+ in: query
1908
+ required: false
1909
+ description: This parameter is required when following "next" links.
1910
+ type: string
1911
+ Offset:
1912
+ name: offset
1913
+ in: query
1914
+ required: false
1915
+ description: Specifies the first item to return in the collection.
1916
+ type: integer
1917
+ After:
1918
+ name: after
1919
+ in: query
1920
+ required: false
1921
+ description: >-
1922
+ A timestamp filter, expressed as a Unix epoch time in milliseconds. All
1923
+ entries returned will have occured after this timestamp.
1924
+ format: int64
1925
+ type: number
1926
+ PatchRequest:
1927
+ name: patchDelta
1928
+ in: body
1929
+ required: true
1930
+ description: >-
1931
+ Requires a JSON Patch representation of the desired changes to the
1932
+ project. 'http://jsonpatch.com/'
1933
+ schema:
1934
+ type: array
1935
+ items:
1936
+ $ref: '#/definitions/PatchOperation'
1937
+ UserSettingsPutRequest:
1938
+ name: userSettingsBody
1939
+ in: body
1940
+ required: true
1941
+ schema:
1942
+ type: object
1943
+ properties:
1944
+ setting:
1945
+ type: boolean
1946
+ description: >
1947
+ The variation value to set for the user. Must match the variation
1948
+ type of the flag.
1949
+ Before:
1950
+ name: before
1951
+ in: query
1952
+ required: false
1953
+ description: >-
1954
+ A timestamp filter, expressed as a Unix epoch time in milliseconds. All
1955
+ entries returned will have before this timestamp.
1956
+ type: number
1957
+ Q:
1958
+ name: q
1959
+ in: query
1960
+ required: false
1961
+ description: >-
1962
+ Text to search for. You can search for the full or partial name of the
1963
+ resource involved or fullpartial email address of the member who made the
1964
+ change.
1965
+ type: string
1966
+ AuditLimit:
1967
+ name: limit
1968
+ in: query
1969
+ required: false
1970
+ description: >-
1971
+ A limit on the number of audit log entries to be returned, between 1 and
1972
+ 20.
1973
+ type: number
1974
+ Spec:
1975
+ name: spec
1976
+ in: query
1977
+ required: false
1978
+ description: >-
1979
+ A resource specifier, allowing you to filter audit log listings by
1980
+ resource.
1981
+ type: string
1982
+ MembersPostRequest:
1983
+ name: membersBody
1984
+ in: body
1985
+ required: true
1986
+ description: New members to invite.
1987
+ schema:
1988
+ type: array
1989
+ items:
1990
+ type: object
1991
+ properties:
1992
+ email:
1993
+ type: string
1994
+ example: exampleuser@email.com
1995
+ firstName:
1996
+ type: string
1997
+ example: Bob
1998
+ lastName:
1999
+ type: string
2000
+ example: Loblaw
2001
+ role:
2002
+ $ref: '#/definitions/Role'
2003
+ customRoles:
2004
+ type: array
2005
+ items:
2006
+ $ref: '#/definitions/CustomRoleKeyOrId'
2007
+ inlineRole:
2008
+ $ref: '#/definitions/Statements'
2009
+ required:
2010
+ - email
2011
+ MemberId:
2012
+ name: memberId
2013
+ in: path
2014
+ required: true
2015
+ description: The member ID.
2016
+ type: string
2017
+ CustomRolePostRequest:
2018
+ name: customRoleBody
2019
+ in: body
2020
+ required: true
2021
+ description: New role or roles to create.
2022
+ schema:
2023
+ type: object
2024
+ properties:
2025
+ name:
2026
+ type: string
2027
+ description: Name of the custom role.
2028
+ example: revenue team
2029
+ description:
2030
+ type: string
2031
+ description: Description of the custom role.
2032
+ example: Description of revenue team role here
2033
+ key:
2034
+ $ref: '#/definitions/CustomRoleKeyOrId'
2035
+ policy:
2036
+ type: array
2037
+ items:
2038
+ $ref: '#/definitions/Policy'
2039
+ required:
2040
+ - name
2041
+ - key
2042
+ - policy
2043
+ CustomRoleKey:
2044
+ name: customRoleKey
2045
+ in: path
2046
+ required: true
2047
+ description: The custom role key.
2048
+ type: string
2049
+ PatchWithComment:
2050
+ name: patchComment
2051
+ in: body
2052
+ required: true
2053
+ description: >-
2054
+ Requires a JSON Patch representation of the desired changes to the
2055
+ project, and an optional comment. 'http://jsonpatch.com/' Feature flag
2056
+ patches also support JSON Merge Patch format.
2057
+ 'https://tools.ietf.org/html/rfc7386' The addition of comments is also
2058
+ supported.
2059
+ schema:
2060
+ type: object
2061
+ properties:
2062
+ comment:
2063
+ type: string
2064
+ example: This is a comment string
2065
+ patch:
2066
+ type: array
2067
+ items:
2068
+ $ref: '#/definitions/PatchOperation'
2069
+ PatchOnly:
2070
+ name: PatchOnly
2071
+ in: body
2072
+ required: true
2073
+ description: >-
2074
+ Requires a JSON Patch representation of the desired changes to the
2075
+ project. 'http://jsonpatch.com/' Feature flag patches also support JSON
2076
+ Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of
2077
+ comments is also supported.
2078
+ schema:
2079
+ type: array
2080
+ items:
2081
+ $ref: '#/definitions/PatchOperation'
2082
+