rbflagr 0.1.2 → 0.2.0

data/lib/rbflagr/models/put_segment_reorder_request.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/models/put_segment_request.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/models/put_variant_request.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT
@@ -63,10 +63,6 @@ module Flagr
         invalid_properties.push('invalid value for "key", the character length must be great than or equal to 1.')
       end
 
-      if @attachment.nil?
-        invalid_properties.push('invalid value for "attachment", attachment cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -75,7 +71,6 @@ module Flagr
     def valid?
       return false if @key.nil?
       return false if @key.to_s.length < 1
-      return false if @attachment.nil?
       true
     end
 

data/lib/rbflagr/models/segment.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/models/segment_debug_log.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/models/set_flag_enabled_request.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/models/variant.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/version.rb

@@ -1,9 +1,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 =end
 
 module Flagr
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/rbflagr.gemspec

@@ -3,9 +3,9 @@
 =begin
 #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\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = [""]
   s.homepage    = "https://github.com/swagger-api/swagger-codegen"
   s.summary     = "Flagr Ruby Gem"
-  s.description = "Flagr is a feature flagging, A/B testing and dynamic configuration microservice"
+  s.description = "Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". "
   s.license     = 'Apache 2.0'
   s.required_ruby_version = ">= 1.9"
 

data/spec/api/export_api_spec.rb

@@ -0,0 +1,45 @@
+=begin
+#Flagr
+
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
+
+OpenAPI spec version: 1.0.13
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Flagr::ExportApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ExportApi' do
+  before do
+    # run before each test
+    @instance = Flagr::ExportApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ExportApi' do
+    it 'should create an instance of ExportApi' do
+      expect(@instance).to be_instance_of(Flagr::ExportApi)
+    end
+  end
+
+  # unit tests for get_export_sq_lite
+  # Export sqlite3 format of the db dump, which is converted from the main database.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_export_sq_lite test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/swagger.yaml

@@ -1,10 +1,10 @@
 swagger: '2.0'
 info:
-  description: >-
+  description: >
     Flagr is a feature flagging, A/B testing and dynamic configuration
-    microservice
+    microservice. The base path for all the APIs is "/api/v1".
   title: Flagr
-  version: 1.0.8
+  version: 1.0.13
 tags:
   - name: flag
     description: Everything about the flag
@@ -34,6 +34,9 @@ x-tagGroups:
   - name: Health Check
     tags:
       - health
+  - name: Export
+    tags:
+      - export
 consumes:
   - application/json
 produces:
@@ -65,6 +68,10 @@ paths:
           name: description_like
           type: string
           description: return flags partially matching given description
+        - in: query
+          name: key
+          type: string
+          description: return flags matching given key
         - in: query
           name: offset
           type: integer
@@ -125,48 +132,48 @@ paths:
           description: generic error response
           schema:
             $ref: '#/definitions/error'
-    put:
+    delete:
       tags:
         - flag
-      operationId: putFlag
+      operationId: deleteFlag
       parameters:
         - in: path
           name: flagID
-          description: numeric ID of the flag to get
+          description: numeric ID of the flag
           required: true
           type: integer
           format: int64
           minimum: 1
-        - in: body
-          name: body
-          description: update a flag
-          required: true
-          schema:
-            $ref: '#/definitions/putFlagRequest'
       responses:
         '200':
-          description: returns the flag
-          schema:
-            $ref: '#/definitions/flag'
+          description: OK deleted
         default:
           description: generic error response
           schema:
             $ref: '#/definitions/error'
-    delete:
+    put:
       tags:
         - flag
-      operationId: deleteFlag
+      operationId: putFlag
       parameters:
         - in: path
           name: flagID
-          description: numeric ID of the flag
+          description: numeric ID of the flag to get
           required: true
           type: integer
           format: int64
           minimum: 1
+        - in: body
+          name: body
+          description: update a flag
+          required: true
+          schema:
+            $ref: '#/definitions/putFlagRequest'
       responses:
         '200':
-          description: OK deleted
+          description: returns the flag
+          schema:
+            $ref: '#/definitions/flag'
         default:
           description: generic error response
           schema:
@@ -681,6 +688,23 @@ paths:
           description: generic error response
           schema:
             $ref: '#/definitions/error'
+  /flags/entity_types:
+    get:
+      tags:
+        - flag
+      operationId: getFlagEntityTypes
+      responses:
+        '200':
+          description: returns all the FlagEntityTypes
+          schema:
+            type: array
+            items:
+              type: string
+              minLength: 1
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
   /evaluation:
     post:
       tags:
@@ -727,9 +751,30 @@ paths:
     get:
       tags:
         - health
+      operationId: getHealth
+      description: Check if Flagr is healthy
       responses:
         '200':
-          description: Flagr is healthy
+          description: OK
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  /export/sqlite:
+    get:
+      tags:
+        - export
+      operationId: getExportSQLite
+      description: >-
+        Export sqlite3 format of the db dump, which is converted from the main
+        database.
+      produces:
+        - application/octet-stream
+      responses:
+        '200':
+          description: OK
+          schema:
+            type: file
         default:
           description: generic error response
           schema:
@@ -747,6 +792,10 @@ definitions:
         format: int64
         minimum: 1
         readOnly: true
+      key:
+        description: unique key representation of the flag
+        type: string
+        minLength: 1
       description:
         type: string
         minLength: 1
@@ -765,6 +814,18 @@ definitions:
           enabled data records will get data logging in the metrics pipeline,
           for example, kafka.
         type: boolean
+      entityType:
+        description: >-
+          it will override the entityType in the evaluation logs if it's not
+          empty
+        type: string
+      createdBy:
+        type: string
+      updatedBy:
+        type: string
+      updatedAt:
+        type: string
+        format: date-time
   createFlagRequest:
     type: object
     required:
@@ -773,20 +834,32 @@ definitions:
       description:
         type: string
         minLength: 1
+      key:
+        description: unique key representation of the flag
+        type: string
   putFlagRequest:
     type: object
-    required:
-      - description
     properties:
       description:
         type: string
         minLength: 1
+        x-nullable: true
       dataRecordsEnabled:
         type: boolean
         description: >-
           enabled data records will get data logging in the metrics pipeline,
           for example, kafka.
         x-nullable: true
+      entityType:
+        description: it will overwrite entityType into evaluation logs if it's not empty
+        type: string
+        x-nullable: true
+      enabled:
+        type: boolean
+        x-nullable: true
+      key:
+        type: string
+        x-nullable: true
   setFlagEnabledRequest:
     type: object
     required:
@@ -913,7 +986,6 @@ definitions:
     type: object
     required:
       - key
-      - attachment
     properties:
       key:
         type: string
@@ -987,9 +1059,6 @@ definitions:
         format: int64
         minimum: 0
         maximum: 100
-      bitmap:
-        type: string
-        minLength: 1
       variantKey:
         type: string
         minLength: 1
@@ -1008,9 +1077,6 @@ definitions:
           $ref: '#/definitions/distribution'
   evalContext:
     type: object
-    required:
-      - entityType
-      - flagID
     properties:
       entityID:
         type: string
@@ -1019,19 +1085,25 @@ definitions:
           result. If it's empty, flagr will randomly generate one.
       entityType:
         type: string
-        minLength: 1
       entityContext:
         type: object
       enableDebug:
         type: boolean
       flagID:
+        description: flagID
         type: integer
         format: int64
         minimum: 1
+      flagKey:
+        description: >-
+          flagKey. flagID or flagKey will resolve to the same flag. Either
+          works.
+        type: string
   evalResult:
     type: object
     required:
       - flagID
+      - flagKey
       - segmentID
       - variantID
       - variantKey
@@ -1043,6 +1115,8 @@ definitions:
         type: integer
         format: int64
         minimum: 1
+      flagKey:
+        type: string
       flagSnapshotID:
         type: integer
         format: int64
@@ -1086,21 +1160,17 @@ definitions:
         type: string
   evaluationEntity:
     type: object
-    required:
-      - entityType
     properties:
       entityID:
         type: string
       entityType:
         type: string
-        minLength: 1
       entityContext:
         type: object
   evaluationBatchRequest:
     type: object
     required:
       - entities
-      - flagIDs
     properties:
       entities:
         type: array
@@ -1110,12 +1180,22 @@ definitions:
       enableDebug:
         type: boolean
       flagIDs:
+        description: flagIDs
         type: array
         items:
           type: integer
           format: int64
           minimum: 1
         minItems: 1
+      flagKeys:
+        description: >-
+          flagKeys. Either flagIDs or flagKeys works. If pass in both, Flagr may
+          return duplicate results.
+        type: array
+        items:
+          type: string
+          minLength: 1
+        minItems: 1
   evaluationBatchResponse:
     type: object
     required:
@@ -1132,4 +1212,4 @@ definitions:
     properties:
       message:
         type: string
-        minLength: 1
+        minLength: 1