flagr

Flagr - JavaScript client for flagr Flagr is a feature flagging, A/B testing and dynamic configuration microservice This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install flagr --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Flagr = require('flagr');

var api = new Flagr.ConstraintApi()

var flagID = 789; // {Number} numeric ID of the flag

var segmentID = 789; // {Number} numeric ID of the segment

var body = new Flagr.CreateConstraintRequest(); // {CreateConstraintRequest} create a constraint


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConstraint(flagID, segmentID, body, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request
Flagr.ConstraintApi	createConstraint	POST /flags/{flagID}/segments/{segmentID}/constraints
Flagr.ConstraintApi	deleteConstraint	DELETE /flags/{flagID}/segments/{segmentID}/constraints/{constraintID}
Flagr.ConstraintApi	findConstraints	GET /flags/{flagID}/segments/{segmentID}/constraints
Flagr.ConstraintApi	putConstraint	PUT /flags/{flagID}/segments/{segmentID}/constraints/{constraintID}
Flagr.DistributionApi	findDistributions	GET /flags/{flagID}/segments/{segmentID}/distributions
Flagr.DistributionApi	putDistributions	PUT /flags/{flagID}/segments/{segmentID}/distributions
Flagr.EvaluationApi	postEvaluation	POST /evaluation
Flagr.EvaluationApi	postEvaluationBatch	POST /evaluation/batch
Flagr.FlagApi	createFlag	POST /flags
Flagr.FlagApi	deleteFlag	DELETE /flags/{flagID}
Flagr.FlagApi	findFlags	GET /flags
Flagr.FlagApi	getFlag	GET /flags/{flagID}
Flagr.FlagApi	getFlagSnapshots	GET /flags/{flagID}/snapshots
Flagr.FlagApi	putFlag	PUT /flags/{flagID}
Flagr.FlagApi	setFlagEnabled	PUT /flags/{flagID}/enabled
Flagr.SegmentApi	createSegment	POST /flags/{flagID}/segments
Flagr.SegmentApi	deleteSegment	DELETE /flags/{flagID}/segments/{segmentID}
Flagr.SegmentApi	findSegments	GET /flags/{flagID}/segments
Flagr.SegmentApi	putSegment	PUT /flags/{flagID}/segments/{segmentID}
Flagr.SegmentApi	putSegmentsReorder	PUT /flags/{flagID}/segments/reorder
Flagr.VariantApi	createVariant	POST /flags/{flagID}/variants
Flagr.VariantApi	deleteVariant	DELETE /flags/{flagID}/variants/{variantID}
Flagr.VariantApi	findVariants	GET /flags/{flagID}/variants
Flagr.VariantApi	putVariant	PUT /flags/{flagID}/variants/{variantID}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

vayan/jsflagr