rbflagr 1.1.0 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f318bd8d828121492002a8777982a3c2afae9e37
-  data.tar.gz: 0a0963c8a47f0d535c214aa392033a177bc95113
+SHA256:
+  metadata.gz: 1d70d24ed0ee321f0b7dd00459f440ab2428357d0e2c25182e9e7c57b3610bbf
+  data.tar.gz: 340441a4b90a00fc1288a48fa9b7da623108342a7dbc02948ca142d960f67c34
 SHA512:
-  metadata.gz: db2a9b57764ac362d1337d5fa2fa98fb9fcdb58a513f99053a9dda599c58073f48885b26c375d23083b20b8fab17bc4fbb6a112469348dca471c4ffa0159c6db
-  data.tar.gz: b23fd22a2687fa1944a9ea636a6405dcf1ce14c50a88d70a0dd78df56eee6f0e41ec1f52505b83d59c9970b8421e406350184b5867f9bcf00ca590039bbd0472
+  metadata.gz: 35cac01f3ea668f933d2022ddcf244df9a5733deb4093c894df83805f1dce3965804bbecd35ebe4436ba5302aacbdb4eb0201b434553fd8c93bfaf2ac5f185a6
+  data.tar.gz: 960ea91ef6cc34121ce6646ddcc12fc7df5814fdb3fb064950b372c9109d5b3f2ed6cc8405d9a4df529dce136c248ceedcdf8564929766be1d6e66dc38fe271c

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

@@ -6,8 +6,8 @@ Flagr is a feature flagging, A/B testing and dynamic configuration microservice.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 1.1.0
-- Package version: 1.1.0
+- API version: 1.1.10
+- Package version: 1.1.10
 - 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-1.1.0.gem
+gem install ./rbflagr-1.1.10.gem
 ```
-(for development, run `gem install --dev ./rbflagr-1.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./rbflagr-1.1.10.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', '~> 1.1.0'
+    gem 'rbflagr', '~> 1.1.10'
 
 ### Install from Git
 
@@ -86,7 +86,8 @@ 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_sq_lite**](docs/ExportApi.md#get_export_sq_lite) | **GET** /export/sqlite | 
+*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 | 
@@ -101,6 +102,10 @@ Class | Method | HTTP request | Description
 *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 | 
@@ -113,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)
@@ -124,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)
@@ -132,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

@@ -5,5 +5,6 @@ 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/EvalContext.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **enable_debug** | **BOOLEAN** |  | [optional] 
 **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/EvaluationBatchRequest.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **entities** | [**Array<EvaluationEntity>**](EvaluationEntity.md) |  | 
 **enable_debug** | **BOOLEAN** |  | [optional] 
 **flag_i_ds** | **Array<Integer>** | flagIDs | [optional] 
-**flag_keys** | **Array<String>** | flagKeys. Either flagIDs or flagKeys works. If pass in both, Flagr may return duplicate results. | [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/ExportApi.md

@@ -4,15 +4,16 @@ All URIs are relative to *http://localhost/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_export_sq_lite**](ExportApi.md#get_export_sq_lite) | **GET** /export/sqlite | 
+[**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_sq_lite**
-> File get_export_sq_lite
+# **get_export_eval_cache_json**
+> Object get_export_eval_cache_json
 
 
 
-Export sqlite3 format of the db dump, which is converted from the main database.
+Export JSON format of the eval cache dump
 
 ### Example
 ```ruby
@@ -22,10 +23,10 @@ require 'rbflagr'
 api_instance = Flagr::ExportApi.new
 
 begin
-  result = api_instance.get_export_sq_lite
+  result = api_instance.get_export_eval_cache_json
   p result
 rescue Flagr::ApiError => e
-  puts "Exception when calling ExportApi->get_export_sq_lite: #{e}"
+  puts "Exception when calling ExportApi->get_export_eval_cache_json: #{e}"
 end
 ```
 
@@ -34,6 +35,53 @@ 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

data/docs/Flag.md

@@ -7,10 +7,12 @@ Name | Type | Description | Notes
 **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

@@ -117,6 +117,7 @@ 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
   key: 'key_example', # String | return flags matching given key
   offset: 789, # Integer | return flags given the offset, it should usually set together with limit
@@ -138,6 +139,7 @@ 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] 

data/docs/Health.md

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

data/docs/HealthApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **get_health**
-> get_health
+> Health get_health
 
 
 
@@ -22,7 +22,8 @@ require 'rbflagr'
 api_instance = Flagr::HealthApi.new
 
 begin
-  api_instance.get_health
+  result = api_instance.get_health
+  p result
 rescue Flagr::ApiError => e
   puts "Exception when calling HealthApi->get_health: #{e}"
 end
@@ -33,7 +34,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+[**Health**](Health.md)
 
 ### Authorization
 

data/docs/PutFlagRequest.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **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] 
 
 

data/docs/Tag.md

@@ -0,0 +1,9 @@
+# Flagr::Tag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**value** | **String** |  | 
+
+

data/docs/TagApi.md

@@ -0,0 +1,198 @@
+# Flagr::TagApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_tag**](TagApi.md#create_tag) | **POST** /flags/{flagID}/tags | 
+[**delete_tag**](TagApi.md#delete_tag) | **DELETE** /flags/{flagID}/tags/{tagID} | 
+[**find_all_tags**](TagApi.md#find_all_tags) | **GET** /tags | 
+[**find_tags**](TagApi.md#find_tags) | **GET** /flags/{flagID}/tags | 
+
+
+# **create_tag**
+> Tag create_tag(flag_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::TagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+body = Flagr::CreateTagRequest.new # CreateTagRequest | create a tag
+
+
+begin
+  result = api_instance.create_tag(flag_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling TagApi->create_tag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **body** | [**CreateTagRequest**](CreateTagRequest.md)| create a tag | 
+
+### Return type
+
+[**Tag**](Tag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_tag**
+> delete_tag(flag_id, tag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::TagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+tag_id = 789 # Integer | numeric ID of the tag
+
+
+begin
+  api_instance.delete_tag(flag_id, tag_id)
+rescue Flagr::ApiError => e
+  puts "Exception when calling TagApi->delete_tag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **tag_id** | **Integer**| numeric ID of the tag | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_all_tags**
+> Array<Tag> find_all_tags(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::TagApi.new
+
+opts = { 
+  limit: 789, # Integer | the numbers of tags to return
+  offset: 789, # Integer | return tags given the offset, it should usually set together with limit
+  value_like: 'value_like_example' # String | return tags partially matching given value
+}
+
+begin
+  result = api_instance.find_all_tags(opts)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling TagApi->find_all_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| the numbers of tags to return | [optional] 
+ **offset** | **Integer**| return tags given the offset, it should usually set together with limit | [optional] 
+ **value_like** | **String**| return tags partially matching given value | [optional] 
+
+### Return type
+
+[**Array<Tag>**](Tag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_tags**
+> Array<Tag> find_tags(flag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::TagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+
+begin
+  result = api_instance.find_tags(flag_id)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling TagApi->find_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+
+### Return type
+
+[**Array<Tag>**](Tag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+