rbflagr 0.1.2 → 1.1.12

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/spec/api/tag_api_spec.rb

@@ -0,0 +1,79 @@
+=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.1.10
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Flagr::TagApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'TagApi' do
+  before do
+    # run before each test
+    @instance = Flagr::TagApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TagApi' do
+    it 'should create an instance of TagApi' do
+      expect(@instance).to be_instance_of(Flagr::TagApi)
+    end
+  end
+
+  # unit tests for create_tag
+  # @param flag_id numeric ID of the flag
+  # @param body create a tag
+  # @param [Hash] opts the optional parameters
+  # @return [Tag]
+  describe 'create_tag test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_tag
+  # @param flag_id numeric ID of the flag
+  # @param tag_id numeric ID of the tag
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_tag test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for find_all_tags
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit the numbers of tags to return
+  # @option opts [Integer] :offset return tags given the offset, it should usually set together with limit
+  # @option opts [String] :value_like return tags partially matching given value
+  # @return [Array<Tag>]
+  describe 'find_all_tags test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for find_tags
+  # @param flag_id numeric ID of the flag
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Tag>]
+  describe 'find_tags test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/create_tag_request_spec.rb

@@ -0,0 +1,41 @@
+=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.1.10
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Flagr::CreateTagRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CreateTagRequest' do
+  before do
+    # run before each test
+    @instance = Flagr::CreateTagRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CreateTagRequest' do
+    it 'should create an instance of CreateTagRequest' do
+      expect(@instance).to be_instance_of(Flagr::CreateTagRequest)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/health_spec.rb

@@ -0,0 +1,41 @@
+=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.1.10
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Flagr::Health
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Health' do
+  before do
+    # run before each test
+    @instance = Flagr::Health.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Health' do
+    it 'should create an instance of Health' do
+      expect(@instance).to be_instance_of(Flagr::Health)
+    end
+  end
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/tag_spec.rb

@@ -0,0 +1,47 @@
+=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.1.10
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Flagr::Tag
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Tag' do
+  before do
+    # run before each test
+    @instance = Flagr::Tag.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Tag' do
+    it 'should create an instance of Tag' do
+      expect(@instance).to be_instance_of(Flagr::Tag)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "value"' 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.1.12
 tags:
   - name: flag
     description: Everything about the flag
@@ -28,12 +28,16 @@ x-tagGroups:
       - constraint
       - distribution
       - variant
+      - tag
   - name: Flag Evaluation
     tags:
       - evaluation
   - name: Health Check
     tags:
       - health
+  - name: Export
+    tags:
+      - export
 consumes:
   - application/json
 produces:
@@ -61,10 +65,18 @@ paths:
           name: description
           type: string
           description: return flags exactly matching given description
+        - in: query
+          name: tags
+          type: string
+          description: return flags with the given tags (comma separated)
         - in: query
           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
@@ -72,6 +84,10 @@ paths:
           description: >-
             return flags given the offset, it should usually set together with
             limit
+        - in: query
+          name: preload
+          type: boolean
+          description: return flags with preloaded segments and variants
       responses:
         '200':
           description: list all the flags
@@ -125,6 +141,25 @@ paths:
           description: generic error response
           schema:
             $ref: '#/definitions/error'
+    delete:
+      tags:
+        - flag
+      operationId: deleteFlag
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: OK deleted
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
     put:
       tags:
         - flag
@@ -152,10 +187,39 @@ paths:
           description: generic error response
           schema:
             $ref: '#/definitions/error'
-    delete:
+  '/flags/{flagID}/enabled':
+    put:
       tags:
         - flag
-      operationId: deleteFlag
+      operationId: setFlagEnabled
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag to get
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: set flag enabled state
+          required: true
+          schema:
+            $ref: '#/definitions/setFlagEnabledRequest'
+      responses:
+        '200':
+          description: returns the flag
+          schema:
+            $ref: '#/definitions/flag'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/tags':
+    get:
+      tags:
+        - tag
+      operationId: findTags
       parameters:
         - in: path
           name: flagID
@@ -166,35 +230,65 @@ paths:
           minimum: 1
       responses:
         '200':
-          description: OK deleted
+          description: tag ordered by tagID
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/tag'
         default:
           description: generic error response
           schema:
             $ref: '#/definitions/error'
-  '/flags/{flagID}/enabled':
-    put:
+    post:
       tags:
-        - flag
-      operationId: setFlagEnabled
+        - tag
+      operationId: createTag
       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: set flag enabled state
+          description: create a tag
           required: true
           schema:
-            $ref: '#/definitions/setFlagEnabledRequest'
+            $ref: '#/definitions/createTagRequest'
       responses:
         '200':
-          description: returns the flag
+          description: tag just created
           schema:
-            $ref: '#/definitions/flag'
+            $ref: '#/definitions/tag'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/tags/{tagID}':
+    delete:
+      tags:
+        - tag
+      operationId: deleteTag
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: tagID
+          description: numeric ID of the tag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: deleted
         default:
           description: generic error response
           schema:
@@ -681,6 +775,56 @@ 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'
+  /tags:
+    get:
+      tags:
+        - tag
+      operationId: findAllTags
+      parameters:
+        - in: query
+          name: limit
+          type: integer
+          format: int64
+          description: the numbers of tags to return
+        - in: query
+          name: offset
+          type: integer
+          format: int64
+          description: >-
+            return tags given the offset, it should usually set together with
+            limit
+        - in: query
+          name: value_like
+          type: string
+          description: return tags partially matching given value
+      responses:
+        '200':
+          description: list all the tags
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/tag'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
   /evaluation:
     post:
       tags:
@@ -727,9 +871,56 @@ paths:
     get:
       tags:
         - health
+      operationId: getHealth
+      description: Check if Flagr is healthy
+      responses:
+        '200':
+          description: status of health check
+          schema:
+            $ref: '#/definitions/health'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  /export/sqlite:
+    get:
+      tags:
+        - export
+      operationId: getExportSqlite
+      parameters:
+        - in: query
+          name: exclude_snapshots
+          type: boolean
+          description: >
+            export without snapshots data - useful for smaller db without
+            snapshots
+      description: >-
+        Export sqlite3 format of the db dump, which is converted from the main
+        database.
+      produces:
+        - application/octet-stream
       responses:
         '200':
-          description: Flagr is healthy
+          description: OK
+          schema:
+            type: file
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  /export/eval_cache/json:
+    get:
+      tags:
+        - export
+      operationId: getExportEvalCacheJSON
+      description: Export JSON format of the eval cache dump
+      produces:
+        - application/json
+      responses:
+        '200':
+          description: OK
+          schema:
+            type: object
         default:
           description: generic error response
           schema:
@@ -747,11 +938,19 @@ definitions:
         format: int64
         minimum: 1
         readOnly: true
+      key:
+        description: unique key representation of the flag
+        type: string
+        minLength: 1
       description:
         type: string
         minLength: 1
       enabled:
         type: boolean
+      tags:
+        type: array
+        items:
+          $ref: '#/definitions/tag'
       segments:
         type: array
         items:
@@ -765,6 +964,21 @@ 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
+      notes:
+        description: flag usage details in markdown format
+        type: string
+      createdBy:
+        type: string
+      updatedBy:
+        type: string
+      updatedAt:
+        type: string
+        format: date-time
   createFlagRequest:
     type: object
     required:
@@ -773,20 +987,38 @@ definitions:
       description:
         type: string
         minLength: 1
+      key:
+        description: unique key representation of the flag
+        type: string
+      template:
+        description: template for flag creation
+        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
+      notes:
+        type: string
+        x-nullable: true
   setFlagEnabledRequest:
     type: object
     required:
@@ -812,6 +1044,27 @@ definitions:
       updatedAt:
         type: string
         minLength: 1
+  tag:
+    type: object
+    required:
+      - value
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+        readOnly: true
+      value:
+        type: string
+        minLength: 1
+  createTagRequest:
+    type: object
+    required:
+      - value
+    properties:
+      value:
+        type: string
+        minLength: 1
   segment:
     type: object
     required:
@@ -913,7 +1166,6 @@ definitions:
     type: object
     required:
       - key
-      - attachment
     properties:
       key:
         type: string
@@ -987,9 +1239,6 @@ definitions:
         format: int64
         minimum: 0
         maximum: 100
-      bitmap:
-        type: string
-        minLength: 1
       variantKey:
         type: string
         minLength: 1
@@ -1008,9 +1257,6 @@ definitions:
           $ref: '#/definitions/distribution'
   evalContext:
     type: object
-    required:
-      - entityType
-      - flagID
     properties:
       entityID:
         type: string
@@ -1019,51 +1265,51 @@ 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
+      flagTags:
+        description: flagTags. flagTags looks up flags by tag. Either works.
+        type: array
+        x-omitempty: true
+        items:
+          type: string
   evalResult:
     type: object
-    required:
-      - flagID
-      - segmentID
-      - variantID
-      - variantKey
-      - variantAttachment
-      - evalContext
-      - timestamp
     properties:
       flagID:
         type: integer
         format: int64
-        minimum: 1
+      flagKey:
+        type: string
       flagSnapshotID:
         type: integer
         format: int64
       segmentID:
         type: integer
         format: int64
-        minimum: 1
       variantID:
         type: integer
         format: int64
-        minimum: 1
       variantKey:
         type: string
-        minLength: 1
       variantAttachment:
         type: object
       evalContext:
         $ref: '#/definitions/evalContext'
       timestamp:
         type: string
-        minLength: 1
       evalDebugLog:
         $ref: '#/definitions/evalDebugLog'
   evalDebugLog:
@@ -1086,21 +1332,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 +1352,31 @@ definitions:
       enableDebug:
         type: boolean
       flagIDs:
+        description: flagIDs
         type: array
         items:
           type: integer
           format: int64
           minimum: 1
         minItems: 1
+      flagKeys:
+        description: >-
+          flagKeys. Either flagIDs, flagKeys or flagTags works. If pass in
+          multiples, Flagr may return duplicate results.
+        type: array
+        items:
+          type: string
+          minLength: 1
+        minItems: 1
+      flagTags:
+        description: >-
+          flagTags. Either flagIDs, flagKeys or flagTags works. If pass in
+          multiples, Flagr may return duplicate results.
+        type: array
+        items:
+          type: string
+          minLength: 1
+        minItems: 1
   evaluationBatchResponse:
     type: object
     required:
@@ -1125,6 +1386,11 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/evalResult'
+  health:
+    type: object
+    properties:
+      status:
+        type: string
   error:
     type: object
     required: