rbflagr 0.1.2

data/spec/models/segment_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#Flagr
+
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Flagr::Segment
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Segment' do
+  before do
+    # run before each test
+    @instance = Flagr::Segment.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Segment' do
+    it 'should create an instance of Segment' do
+      expect(@instance).to be_instance_of(Flagr::Segment)
+    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 "description"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "constraints"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "distributions"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "rank"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "rollout_percent"' 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/set_flag_enabled_request_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#Flagr
+
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Flagr::SetFlagEnabledRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SetFlagEnabledRequest' do
+  before do
+    # run before each test
+    @instance = Flagr::SetFlagEnabledRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SetFlagEnabledRequest' do
+    it 'should create an instance of SetFlagEnabledRequest' do
+      expect(@instance).to be_instance_of(Flagr::SetFlagEnabledRequest)
+    end
+  end
+  describe 'test attribute "enabled"' 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/variant_spec.rb

@@ -0,0 +1,54 @@
+=begin
+#Flagr
+
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Flagr::Variant
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Variant' do
+  before do
+    # run before each test
+    @instance = Flagr::Variant.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Variant' do
+    it 'should create an instance of Variant' do
+      expect(@instance).to be_instance_of(Flagr::Variant)
+    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 "key"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "attachment"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+=begin
+#Flagr
+
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+# load the gem
+require 'rbflagr'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/swagger.yaml

@@ -0,0 +1,1135 @@
+swagger: '2.0'
+info:
+  description: >-
+    Flagr is a feature flagging, A/B testing and dynamic configuration
+    microservice
+  title: Flagr
+  version: 1.0.8
+tags:
+  - name: flag
+    description: Everything about the flag
+  - name: segment
+    description: 'Segment defines the audience of the flag, it''s the user segmentation'
+  - name: constraint
+    description: Constraint is the unit of defining a small subset of users
+  - name: distribution
+    description: Distribution is the percent distribution of variants within that segment
+  - name: variant
+    description: Variants are the possible outcomes of flag evaluation
+  - name: evaluation
+    description: Evaluation is the process of evaluating a flag given the entity context
+  - name: health
+    description: Check if Flagr is healthy
+x-tagGroups:
+  - name: Flag Management
+    tags:
+      - flag
+      - segment
+      - constraint
+      - distribution
+      - variant
+  - name: Flag Evaluation
+    tags:
+      - evaluation
+  - name: Health Check
+    tags:
+      - health
+consumes:
+  - application/json
+produces:
+  - application/json
+schemes:
+  - http
+basePath: /api/v1
+paths:
+  /flags:
+    get:
+      tags:
+        - flag
+      operationId: findFlags
+      parameters:
+        - in: query
+          name: limit
+          type: integer
+          format: int64
+          description: the numbers of flags to return
+        - in: query
+          name: enabled
+          type: boolean
+          description: return flags having given enabled status
+        - in: query
+          name: description
+          type: string
+          description: return flags exactly matching given description
+        - in: query
+          name: description_like
+          type: string
+          description: return flags partially matching given description
+        - in: query
+          name: offset
+          type: integer
+          format: int64
+          description: >-
+            return flags given the offset, it should usually set together with
+            limit
+      responses:
+        '200':
+          description: list all the flags
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/flag'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    post:
+      tags:
+        - flag
+      operationId: createFlag
+      parameters:
+        - in: body
+          name: body
+          description: create a flag
+          required: true
+          schema:
+            $ref: '#/definitions/createFlagRequest'
+      responses:
+        '200':
+          description: returns the created flag
+          schema:
+            $ref: '#/definitions/flag'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}':
+    get:
+      tags:
+        - flag
+      operationId: getFlag
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag to get
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: returns the flag
+          schema:
+            $ref: '#/definitions/flag'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    put:
+      tags:
+        - flag
+      operationId: putFlag
+      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: update a flag
+          required: true
+          schema:
+            $ref: '#/definitions/putFlagRequest'
+      responses:
+        '200':
+          description: returns the flag
+          schema:
+            $ref: '#/definitions/flag'
+        default:
+          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'
+  '/flags/{flagID}/enabled':
+    put:
+      tags:
+        - flag
+      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}/variants':
+    get:
+      tags:
+        - variant
+      operationId: findVariants
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: variant ordered by variantID
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/variant'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    post:
+      tags:
+        - variant
+      operationId: createVariant
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: create a variant
+          required: true
+          schema:
+            $ref: '#/definitions/createVariantRequest'
+      responses:
+        '200':
+          description: variant just created
+          schema:
+            $ref: '#/definitions/variant'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/variants/{variantID}':
+    put:
+      tags:
+        - variant
+      operationId: putVariant
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: variantID
+          description: numeric ID of the variant
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: update a variant
+          required: true
+          schema:
+            $ref: '#/definitions/putVariantRequest'
+      responses:
+        '200':
+          description: variant just updated
+          schema:
+            $ref: '#/definitions/variant'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    delete:
+      tags:
+        - variant
+      operationId: deleteVariant
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: variantID
+          description: numeric ID of the variant
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: deleted
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/segments':
+    get:
+      tags:
+        - segment
+      operationId: findSegments
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag to get
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: segments ordered by rank of the flag
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/segment'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    post:
+      tags:
+        - segment
+      operationId: createSegment
+      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: create a segment under a flag
+          required: true
+          schema:
+            $ref: '#/definitions/createSegmentRequest'
+      responses:
+        '200':
+          description: segment created
+          schema:
+            $ref: '#/definitions/segment'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/segments/reorder':
+    put:
+      tags:
+        - segment
+      operationId: putSegmentsReorder
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: reorder segments
+          required: true
+          schema:
+            $ref: '#/definitions/putSegmentReorderRequest'
+      responses:
+        '200':
+          description: segments reordered
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/segments/{segmentID}':
+    put:
+      tags:
+        - segment
+      operationId: putSegment
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: update a segment
+          required: true
+          schema:
+            $ref: '#/definitions/putSegmentRequest'
+      responses:
+        '200':
+          description: segment updated
+          schema:
+            $ref: '#/definitions/segment'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    delete:
+      tags:
+        - segment
+      operationId: deleteSegment
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: deleted
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/segments/{segmentID}/constraints':
+    get:
+      tags:
+        - constraint
+      operationId: findConstraints
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: constraints under the segment
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/constraint'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    post:
+      tags:
+        - constraint
+      operationId: createConstraint
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: create a constraint
+          required: true
+          schema:
+            $ref: '#/definitions/createConstraintRequest'
+      responses:
+        '200':
+          description: the constraint created
+          schema:
+            $ref: '#/definitions/constraint'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/segments/{segmentID}/constraints/{constraintID}':
+    put:
+      tags:
+        - constraint
+      operationId: putConstraint
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: constraintID
+          description: numeric ID of the constraint
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: create a constraint
+          required: true
+          schema:
+            $ref: '#/definitions/createConstraintRequest'
+      responses:
+        '200':
+          description: constraint just updated
+          schema:
+            $ref: '#/definitions/constraint'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    delete:
+      tags:
+        - constraint
+      operationId: deleteConstraint
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: constraintID
+          description: numeric ID of the constraint
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: deleted
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/segments/{segmentID}/distributions':
+    get:
+      tags:
+        - distribution
+      operationId: findDistributions
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: distribution under the segment
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/distribution'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+    put:
+      tags:
+        - distribution
+      operationId: putDistributions
+      description: replace the distribution with the new setting
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: path
+          name: segmentID
+          description: numeric ID of the segment
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+        - in: body
+          name: body
+          description: array of distributions
+          required: true
+          schema:
+            $ref: '#/definitions/putDistributionsRequest'
+      responses:
+        '200':
+          description: distribution under the segment
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/distribution'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  '/flags/{flagID}/snapshots':
+    get:
+      tags:
+        - flag
+      operationId: getFlagSnapshots
+      parameters:
+        - in: path
+          name: flagID
+          description: numeric ID of the flag to get
+          required: true
+          type: integer
+          format: int64
+          minimum: 1
+      responses:
+        '200':
+          description: returns the flag snapshots
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/flagSnapshot'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  /evaluation:
+    post:
+      tags:
+        - evaluation
+      operationId: postEvaluation
+      parameters:
+        - in: body
+          name: body
+          description: evalution context
+          required: true
+          schema:
+            $ref: '#/definitions/evalContext'
+      responses:
+        '200':
+          description: evaluation result
+          schema:
+            $ref: '#/definitions/evalResult'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  /evaluation/batch:
+    post:
+      tags:
+        - evaluation
+      operationId: postEvaluationBatch
+      parameters:
+        - in: body
+          name: body
+          description: evalution batch request
+          required: true
+          schema:
+            $ref: '#/definitions/evaluationBatchRequest'
+      responses:
+        '200':
+          description: evaluation batch result
+          schema:
+            $ref: '#/definitions/evaluationBatchResponse'
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+  /health:
+    get:
+      tags:
+        - health
+      responses:
+        '200':
+          description: Flagr is healthy
+        default:
+          description: generic error response
+          schema:
+            $ref: '#/definitions/error'
+definitions:
+  flag:
+    type: object
+    required:
+      - description
+      - enabled
+      - dataRecordsEnabled
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+        readOnly: true
+      description:
+        type: string
+        minLength: 1
+      enabled:
+        type: boolean
+      segments:
+        type: array
+        items:
+          $ref: '#/definitions/segment'
+      variants:
+        type: array
+        items:
+          $ref: '#/definitions/variant'
+      dataRecordsEnabled:
+        description: >-
+          enabled data records will get data logging in the metrics pipeline,
+          for example, kafka.
+        type: boolean
+  createFlagRequest:
+    type: object
+    required:
+      - description
+    properties:
+      description:
+        type: string
+        minLength: 1
+  putFlagRequest:
+    type: object
+    required:
+      - description
+    properties:
+      description:
+        type: string
+        minLength: 1
+      dataRecordsEnabled:
+        type: boolean
+        description: >-
+          enabled data records will get data logging in the metrics pipeline,
+          for example, kafka.
+        x-nullable: true
+  setFlagEnabledRequest:
+    type: object
+    required:
+      - enabled
+    properties:
+      enabled:
+        type: boolean
+  flagSnapshot:
+    type: object
+    required:
+      - id
+      - flag
+      - updatedAt
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+      updatedBy:
+        type: string
+      flag:
+        $ref: '#/definitions/flag'
+      updatedAt:
+        type: string
+        minLength: 1
+  segment:
+    type: object
+    required:
+      - description
+      - rank
+      - rolloutPercent
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+        readOnly: true
+      description:
+        type: string
+        minLength: 1
+      constraints:
+        type: array
+        items:
+          $ref: '#/definitions/constraint'
+      distributions:
+        type: array
+        items:
+          $ref: '#/definitions/distribution'
+      rank:
+        type: integer
+        format: int64
+        minimum: 0
+      rolloutPercent:
+        type: integer
+        format: int64
+        minimum: 0
+        maximum: 100
+  createSegmentRequest:
+    type: object
+    required:
+      - description
+      - rolloutPercent
+    properties:
+      description:
+        type: string
+        minLength: 1
+      rolloutPercent:
+        type: integer
+        format: int64
+        minimum: 0
+        maximum: 100
+  putSegmentRequest:
+    type: object
+    required:
+      - description
+      - rolloutPercent
+    properties:
+      description:
+        type: string
+        minLength: 1
+      rolloutPercent:
+        type: integer
+        format: int64
+        minimum: 0
+        maximum: 100
+  putSegmentReorderRequest:
+    type: object
+    required:
+      - segmentIDs
+    properties:
+      segmentIDs:
+        type: array
+        minItems: 1
+        items:
+          type: integer
+          format: int64
+          minimum: 1
+  variant:
+    type: object
+    required:
+      - key
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+        readOnly: true
+      key:
+        type: string
+        minLength: 1
+      attachment:
+        type: object
+  createVariantRequest:
+    type: object
+    required:
+      - key
+    properties:
+      key:
+        type: string
+        minLength: 1
+      attachment:
+        type: object
+  putVariantRequest:
+    type: object
+    required:
+      - key
+      - attachment
+    properties:
+      key:
+        type: string
+        minLength: 1
+      attachment:
+        type: object
+  constraint:
+    type: object
+    required:
+      - property
+      - operator
+      - value
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+        readOnly: true
+      property:
+        type: string
+        minLength: 1
+      operator:
+        type: string
+        minLength: 1
+        enum:
+          - EQ
+          - NEQ
+          - LT
+          - LTE
+          - GT
+          - GTE
+          - EREG
+          - NEREG
+          - IN
+          - NOTIN
+          - CONTAINS
+          - NOTCONTAINS
+      value:
+        type: string
+        minLength: 1
+  createConstraintRequest:
+    type: object
+    required:
+      - property
+      - operator
+      - value
+    properties:
+      property:
+        type: string
+        minLength: 1
+      operator:
+        type: string
+        minLength: 1
+      value:
+        type: string
+        minLength: 1
+  distribution:
+    type: object
+    required:
+      - percent
+      - variantID
+      - variantKey
+    properties:
+      id:
+        type: integer
+        format: int64
+        minimum: 1
+        readOnly: true
+      percent:
+        type: integer
+        format: int64
+        minimum: 0
+        maximum: 100
+      bitmap:
+        type: string
+        minLength: 1
+      variantKey:
+        type: string
+        minLength: 1
+      variantID:
+        type: integer
+        format: int64
+        minimum: 1
+  putDistributionsRequest:
+    type: object
+    required:
+      - distributions
+    properties:
+      distributions:
+        type: array
+        items:
+          $ref: '#/definitions/distribution'
+  evalContext:
+    type: object
+    required:
+      - entityType
+      - flagID
+    properties:
+      entityID:
+        type: string
+        description: >-
+          entityID is used to deterministically at random to evaluate the flag
+          result. If it's empty, flagr will randomly generate one.
+      entityType:
+        type: string
+        minLength: 1
+      entityContext:
+        type: object
+      enableDebug:
+        type: boolean
+      flagID:
+        type: integer
+        format: int64
+        minimum: 1
+  evalResult:
+    type: object
+    required:
+      - flagID
+      - segmentID
+      - variantID
+      - variantKey
+      - variantAttachment
+      - evalContext
+      - timestamp
+    properties:
+      flagID:
+        type: integer
+        format: int64
+        minimum: 1
+      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:
+    type: object
+    properties:
+      segmentDebugLogs:
+        type: array
+        items:
+          $ref: '#/definitions/segmentDebugLog'
+      msg:
+        type: string
+  segmentDebugLog:
+    type: object
+    properties:
+      segmentID:
+        type: integer
+        format: int64
+        minimum: 1
+      msg:
+        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
+        items:
+          $ref: '#/definitions/evaluationEntity'
+        minItems: 1
+      enableDebug:
+        type: boolean
+      flagIDs:
+        type: array
+        items:
+          type: integer
+          format: int64
+          minimum: 1
+        minItems: 1
+  evaluationBatchResponse:
+    type: object
+    required:
+      - evaluationResults
+    properties:
+      evaluationResults:
+        type: array
+        items:
+          $ref: '#/definitions/evalResult'
+  error:
+    type: object
+    required:
+      - message
+    properties:
+      message:
+        type: string
+        minLength: 1