rbflagr 0.1.2 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d581712bb92f0f0bc0dcf1bd36fae8f9ed8e5511147bde6ed674f018ef8402b
-  data.tar.gz: 35f793dab20335bd32c8b8602b178cfd580ddaa5eb20a21759821f21be2eb6a6
+  metadata.gz: a0dfe99e7f241d711f2fb3efad5c9088b4100e831f9d615542ecb10492594535
+  data.tar.gz: feb4705f5681ed11837b59b4f14581b1708696fe390501f7d96f1ee26001b1a4
 SHA512:
-  metadata.gz: 41dd88e56157dd2ca3df30e5bf40b4bd487c3c93634da94d0d331f0827274045426f4ef75c1d73426e4a5cb48fac7ccd351a091239ed4545aaa512b74dad1002
-  data.tar.gz: c3b140e97a2c4921df97ccd8d89669de4eeb65d378549d317a1419e5457a063fc7dab72e90f028b523059ca57a9281347cbedc499d2cdfb9f50c5f3a2596f162
+  metadata.gz: df6812bfa92ab9cf34375f86ea25dd015cf3355bb49b7678ac8bb662d5dd4b91889a0e6b1683bf3934d0a8dd5c89a7045a7c50f7e27036841a690675dc70a0d3
+  data.tar.gz: a9bb90db94df009edf3597cfebddc245893da1267d4e0eb4b4cb018f4b4e59b1f2af5787791c054f04723c8be4cb1039e397858227b9ce1eb2e9e8cbf9c74e4f

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
 end

data/README.md

@@ -2,12 +2,12 @@
 
 Flagr - the Ruby gem for the Flagr
 
-Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 1.0.8
-- Package version: 0.1.2
+- API version: 1.1.12
+- Package version: 1.1.12
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build rbflagr.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./rbflagr-0.1.2.gem
+gem install ./rbflagr-1.1.12.gem
 ```
-(for development, run `gem install --dev ./rbflagr-0.1.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./rbflagr-1.1.12.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'rbflagr', '~> 0.1.2'
+    gem 'rbflagr', '~> 1.1.12'
 
 ### Install from Git
 
@@ -86,19 +86,26 @@ Class | Method | HTTP request | Description
 *Flagr::DistributionApi* | [**put_distributions**](docs/DistributionApi.md#put_distributions) | **PUT** /flags/{flagID}/segments/{segmentID}/distributions | 
 *Flagr::EvaluationApi* | [**post_evaluation**](docs/EvaluationApi.md#post_evaluation) | **POST** /evaluation | 
 *Flagr::EvaluationApi* | [**post_evaluation_batch**](docs/EvaluationApi.md#post_evaluation_batch) | **POST** /evaluation/batch | 
+*Flagr::ExportApi* | [**get_export_eval_cache_json**](docs/ExportApi.md#get_export_eval_cache_json) | **GET** /export/eval_cache/json | 
+*Flagr::ExportApi* | [**get_export_sqlite**](docs/ExportApi.md#get_export_sqlite) | **GET** /export/sqlite | 
 *Flagr::FlagApi* | [**create_flag**](docs/FlagApi.md#create_flag) | **POST** /flags | 
 *Flagr::FlagApi* | [**delete_flag**](docs/FlagApi.md#delete_flag) | **DELETE** /flags/{flagID} | 
 *Flagr::FlagApi* | [**find_flags**](docs/FlagApi.md#find_flags) | **GET** /flags | 
 *Flagr::FlagApi* | [**get_flag**](docs/FlagApi.md#get_flag) | **GET** /flags/{flagID} | 
+*Flagr::FlagApi* | [**get_flag_entity_types**](docs/FlagApi.md#get_flag_entity_types) | **GET** /flags/entity_types | 
 *Flagr::FlagApi* | [**get_flag_snapshots**](docs/FlagApi.md#get_flag_snapshots) | **GET** /flags/{flagID}/snapshots | 
 *Flagr::FlagApi* | [**put_flag**](docs/FlagApi.md#put_flag) | **PUT** /flags/{flagID} | 
 *Flagr::FlagApi* | [**set_flag_enabled**](docs/FlagApi.md#set_flag_enabled) | **PUT** /flags/{flagID}/enabled | 
-*Flagr::HealthApi* | [**health_get**](docs/HealthApi.md#health_get) | **GET** /health | 
+*Flagr::HealthApi* | [**get_health**](docs/HealthApi.md#get_health) | **GET** /health | 
 *Flagr::SegmentApi* | [**create_segment**](docs/SegmentApi.md#create_segment) | **POST** /flags/{flagID}/segments | 
 *Flagr::SegmentApi* | [**delete_segment**](docs/SegmentApi.md#delete_segment) | **DELETE** /flags/{flagID}/segments/{segmentID} | 
 *Flagr::SegmentApi* | [**find_segments**](docs/SegmentApi.md#find_segments) | **GET** /flags/{flagID}/segments | 
 *Flagr::SegmentApi* | [**put_segment**](docs/SegmentApi.md#put_segment) | **PUT** /flags/{flagID}/segments/{segmentID} | 
 *Flagr::SegmentApi* | [**put_segments_reorder**](docs/SegmentApi.md#put_segments_reorder) | **PUT** /flags/{flagID}/segments/reorder | 
+*Flagr::TagApi* | [**create_tag**](docs/TagApi.md#create_tag) | **POST** /flags/{flagID}/tags | 
+*Flagr::TagApi* | [**delete_tag**](docs/TagApi.md#delete_tag) | **DELETE** /flags/{flagID}/tags/{tagID} | 
+*Flagr::TagApi* | [**find_all_tags**](docs/TagApi.md#find_all_tags) | **GET** /tags | 
+*Flagr::TagApi* | [**find_tags**](docs/TagApi.md#find_tags) | **GET** /flags/{flagID}/tags | 
 *Flagr::VariantApi* | [**create_variant**](docs/VariantApi.md#create_variant) | **POST** /flags/{flagID}/variants | 
 *Flagr::VariantApi* | [**delete_variant**](docs/VariantApi.md#delete_variant) | **DELETE** /flags/{flagID}/variants/{variantID} | 
 *Flagr::VariantApi* | [**find_variants**](docs/VariantApi.md#find_variants) | **GET** /flags/{flagID}/variants | 
@@ -111,6 +118,7 @@ Class | Method | HTTP request | Description
  - [Flagr::CreateConstraintRequest](docs/CreateConstraintRequest.md)
  - [Flagr::CreateFlagRequest](docs/CreateFlagRequest.md)
  - [Flagr::CreateSegmentRequest](docs/CreateSegmentRequest.md)
+ - [Flagr::CreateTagRequest](docs/CreateTagRequest.md)
  - [Flagr::CreateVariantRequest](docs/CreateVariantRequest.md)
  - [Flagr::Distribution](docs/Distribution.md)
  - [Flagr::Error](docs/Error.md)
@@ -122,6 +130,7 @@ Class | Method | HTTP request | Description
  - [Flagr::EvaluationEntity](docs/EvaluationEntity.md)
  - [Flagr::Flag](docs/Flag.md)
  - [Flagr::FlagSnapshot](docs/FlagSnapshot.md)
+ - [Flagr::Health](docs/Health.md)
  - [Flagr::PutDistributionsRequest](docs/PutDistributionsRequest.md)
  - [Flagr::PutFlagRequest](docs/PutFlagRequest.md)
  - [Flagr::PutSegmentReorderRequest](docs/PutSegmentReorderRequest.md)
@@ -130,6 +139,7 @@ Class | Method | HTTP request | Description
  - [Flagr::Segment](docs/Segment.md)
  - [Flagr::SegmentDebugLog](docs/SegmentDebugLog.md)
  - [Flagr::SetFlagEnabledRequest](docs/SetFlagEnabledRequest.md)
+ - [Flagr::Tag](docs/Tag.md)
  - [Flagr::Variant](docs/Variant.md)
 
 

data/docs/CreateFlagRequest.md

@@ -4,5 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | **String** |  | 
+**key** | **String** | unique key representation of the flag | [optional] 
+**template** | **String** | template for flag creation | [optional] 
 
 

data/docs/CreateTagRequest.md

@@ -0,0 +1,8 @@
+# Flagr::CreateTagRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | 
+
+

data/docs/Distribution.md

@@ -5,7 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** |  | [optional] 
 **percent** | **Integer** |  | 
-**bitmap** | **String** |  | [optional] 
 **variant_key** | **String** |  | 
 **variant_id** | **Integer** |  | 
 

data/docs/EvalContext.md

@@ -4,9 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entity_id** | **String** | entityID is used to deterministically at random to evaluate the flag result. If it's empty, flagr will randomly generate one. | [optional] 
-**entity_type** | **String** |  | 
+**entity_type** | **String** |  | [optional] 
 **entity_context** | **Object** |  | [optional] 
 **enable_debug** | **BOOLEAN** |  | [optional] 
-**flag_id** | **Integer** |  | 
+**flag_id** | **Integer** | flagID | [optional] 
+**flag_key** | **String** | flagKey. flagID or flagKey will resolve to the same flag. Either works. | [optional] 
+**flag_tags** | **Array<String>** | flagTags. flagTags looks up flags by tag. Either works. | [optional] 
 
 

data/docs/EvalResult.md

@@ -3,14 +3,15 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**flag_id** | **Integer** |  | 
+**flag_id** | **Integer** |  | [optional] 
+**flag_key** | **String** |  | [optional] 
 **flag_snapshot_id** | **Integer** |  | [optional] 
-**segment_id** | **Integer** |  | 
-**variant_id** | **Integer** |  | 
-**variant_key** | **String** |  | 
-**variant_attachment** | **Object** |  | 
-**eval_context** | [**EvalContext**](EvalContext.md) |  | 
-**timestamp** | **String** |  | 
+**segment_id** | **Integer** |  | [optional] 
+**variant_id** | **Integer** |  | [optional] 
+**variant_key** | **String** |  | [optional] 
+**variant_attachment** | **Object** |  | [optional] 
+**eval_context** | [**EvalContext**](EvalContext.md) |  | [optional] 
+**timestamp** | **String** |  | [optional] 
 **eval_debug_log** | [**EvalDebugLog**](EvalDebugLog.md) |  | [optional] 
 
 

data/docs/EvaluationBatchRequest.md

@@ -5,6 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entities** | [**Array<EvaluationEntity>**](EvaluationEntity.md) |  | 
 **enable_debug** | **BOOLEAN** |  | [optional] 
-**flag_i_ds** | **Array<Integer>** |  | 
+**flag_i_ds** | **Array<Integer>** | flagIDs | [optional] 
+**flag_keys** | **Array<String>** | flagKeys. Either flagIDs, flagKeys or flagTags works. If pass in multiples, Flagr may return duplicate results. | [optional] 
+**flag_tags** | **Array<String>** | flagTags. Either flagIDs, flagKeys or flagTags works. If pass in multiples, Flagr may return duplicate results. | [optional] 
 
 

data/docs/EvaluationEntity.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entity_id** | **String** |  | [optional] 
-**entity_type** | **String** |  | 
+**entity_type** | **String** |  | [optional] 
 **entity_context** | **Object** |  | [optional] 
 
 

data/docs/ExportApi.md

@@ -0,0 +1,97 @@
+# Flagr::ExportApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_export_eval_cache_json**](ExportApi.md#get_export_eval_cache_json) | **GET** /export/eval_cache/json | 
+[**get_export_sqlite**](ExportApi.md#get_export_sqlite) | **GET** /export/sqlite | 
+
+
+# **get_export_eval_cache_json**
+> Object get_export_eval_cache_json
+
+
+
+Export JSON format of the eval cache dump
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::ExportApi.new
+
+begin
+  result = api_instance.get_export_eval_cache_json
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling ExportApi->get_export_eval_cache_json: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_export_sqlite**
+> File get_export_sqlite(opts)
+
+
+
+Export sqlite3 format of the db dump, which is converted from the main database.
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::ExportApi.new
+
+opts = { 
+  exclude_snapshots: true # BOOLEAN | export without snapshots data - useful for smaller db without snapshots 
+}
+
+begin
+  result = api_instance.get_export_sqlite(opts)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling ExportApi->get_export_sqlite: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exclude_snapshots** | **BOOLEAN**| export without snapshots data - useful for smaller db without snapshots  | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/octet-stream
+
+
+

data/docs/Flag.md

@@ -4,10 +4,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** |  | [optional] 
+**key** | **String** | unique key representation of the flag | [optional] 
 **description** | **String** |  | 
 **enabled** | **BOOLEAN** |  | 
+**tags** | [**Array<Tag>**](Tag.md) |  | [optional] 
 **segments** | [**Array<Segment>**](Segment.md) |  | [optional] 
 **variants** | [**Array<Variant>**](Variant.md) |  | [optional] 
 **data_records_enabled** | **BOOLEAN** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | 
+**entity_type** | **String** | it will override the entityType in the evaluation logs if it's not empty | [optional] 
+**notes** | **String** | flag usage details in markdown format | [optional] 
+**created_by** | **String** |  | [optional] 
+**updated_by** | **String** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
 
 

data/docs/FlagApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**delete_flag**](FlagApi.md#delete_flag) | **DELETE** /flags/{flagID} | 
 [**find_flags**](FlagApi.md#find_flags) | **GET** /flags | 
 [**get_flag**](FlagApi.md#get_flag) | **GET** /flags/{flagID} | 
+[**get_flag_entity_types**](FlagApi.md#get_flag_entity_types) | **GET** /flags/entity_types | 
 [**get_flag_snapshots**](FlagApi.md#get_flag_snapshots) | **GET** /flags/{flagID}/snapshots | 
 [**put_flag**](FlagApi.md#put_flag) | **PUT** /flags/{flagID} | 
 [**set_flag_enabled**](FlagApi.md#set_flag_enabled) | **PUT** /flags/{flagID}/enabled | 
@@ -116,8 +117,11 @@ opts = {
   limit: 789, # Integer | the numbers of flags to return
   enabled: true, # BOOLEAN | return flags having given enabled status
   description: 'description_example', # String | return flags exactly matching given description
+  tags: 'tags_example', # String | return flags with the given tags (comma separated)
   description_like: 'description_like_example', # String | return flags partially matching given description
-  offset: 789 # Integer | return flags given the offset, it should usually set together with limit
+  key: 'key_example', # String | return flags matching given key
+  offset: 789, # Integer | return flags given the offset, it should usually set together with limit
+  preload: true # BOOLEAN | return flags with preloaded segments and variants
 }
 
 begin
@@ -135,8 +139,11 @@ Name | Type | Description  | Notes
  **limit** | **Integer**| the numbers of flags to return | [optional] 
  **enabled** | **BOOLEAN**| return flags having given enabled status | [optional] 
  **description** | **String**| return flags exactly matching given description | [optional] 
+ **tags** | **String**| return flags with the given tags (comma separated) | [optional] 
  **description_like** | **String**| return flags partially matching given description | [optional] 
+ **key** | **String**| return flags matching given key | [optional] 
  **offset** | **Integer**| return flags given the offset, it should usually set together with limit | [optional] 
+ **preload** | **BOOLEAN**| return flags with preloaded segments and variants | [optional] 
 
 ### Return type
 
@@ -197,6 +204,44 @@ No authorization required
 
 
 
+# **get_flag_entity_types**
+> Array<String> get_flag_entity_types
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+begin
+  result = api_instance.get_flag_entity_types
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->get_flag_entity_types: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_flag_snapshots**
 > Array<FlagSnapshot> get_flag_snapshots(flag_id)
 

data/docs/Health.md

@@ -0,0 +1,8 @@
+# Flagr::Health
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+
+

data/docs/HealthApi.md

@@ -4,14 +4,16 @@ All URIs are relative to *http://localhost/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**health_get**](HealthApi.md#health_get) | **GET** /health | 
+[**get_health**](HealthApi.md#get_health) | **GET** /health | 
 
 
-# **health_get**
-> health_get
+# **get_health**
+> Health get_health
 
 
 
+Check if Flagr is healthy
+
 ### Example
 ```ruby
 # load the gem
@@ -20,9 +22,10 @@ require 'rbflagr'
 api_instance = Flagr::HealthApi.new
 
 begin
-  api_instance.health_get
+  result = api_instance.get_health
+  p result
 rescue Flagr::ApiError => e
-  puts "Exception when calling HealthApi->health_get: #{e}"
+  puts "Exception when calling HealthApi->get_health: #{e}"
 end
 ```
 
@@ -31,7 +34,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+[**Health**](Health.md)
 
 ### Authorization
 

data/docs/PutFlagRequest.md

@@ -3,7 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | **String** |  | 
+**description** | **String** |  | [optional] 
 **data_records_enabled** | **BOOLEAN** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | [optional] 
+**entity_type** | **String** | it will overwrite entityType into evaluation logs if it's not empty | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**key** | **String** |  | [optional] 
+**notes** | **String** |  | [optional]