Skip to content

Commit a2f640b

Browse files
zhouzhuojiezhouzhuojie
authored
Merge pull request #9 from checkr/zz/bump-flagr-version
Bump flagr version to 1.1.10
2 parents 5ae7f29 + fa77b12 commit a2f640b

File tree

93 files changed

+5324
-2376
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+5324
-2376
lines changed

‎.swagger-codegen/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.4.0-SNAPSHOT
1+
2.4.14

‎Makefile

+1-2
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,4 @@ gen:
1717
-D licenseName="Apache 2.0" \
1818
-D projectDescription="jsflagr is a Javascript client SDK for Flagr." \
1919
-o /local/
20-
git co -- package.json
21-
git co -- package-lock.json
20+
npm i && npm audit fix --force

‎README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Jsflagr - JavaScript client for jsflagr
44
Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\".
55
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
66

7-
- API version: 1.1.0
8-
- Package version: 1.1.0
7+
- API version: 1.1.10
8+
- Package version: 1.1.10
99
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
1010

1111
## Installation
@@ -129,7 +129,8 @@ Class | Method | HTTP request | Description
129129
*Jsflagr.DistributionApi* | [**putDistributions**](docs/DistributionApi.md#putDistributions) | **PUT** /flags/{flagID}/segments/{segmentID}/distributions |
130130
*Jsflagr.EvaluationApi* | [**postEvaluation**](docs/EvaluationApi.md#postEvaluation) | **POST** /evaluation |
131131
*Jsflagr.EvaluationApi* | [**postEvaluationBatch**](docs/EvaluationApi.md#postEvaluationBatch) | **POST** /evaluation/batch |
132-
*Jsflagr.ExportApi* | [**getExportSQLite**](docs/ExportApi.md#getExportSQLite) | **GET** /export/sqlite |
132+
*Jsflagr.ExportApi* | [**getExportEvalCacheJSON**](docs/ExportApi.md#getExportEvalCacheJSON) | **GET** /export/eval_cache/json |
133+
*Jsflagr.ExportApi* | [**getExportSqlite**](docs/ExportApi.md#getExportSqlite) | **GET** /export/sqlite |
133134
*Jsflagr.FlagApi* | [**createFlag**](docs/FlagApi.md#createFlag) | **POST** /flags |
134135
*Jsflagr.FlagApi* | [**deleteFlag**](docs/FlagApi.md#deleteFlag) | **DELETE** /flags/{flagID} |
135136
*Jsflagr.FlagApi* | [**findFlags**](docs/FlagApi.md#findFlags) | **GET** /flags |
@@ -144,6 +145,10 @@ Class | Method | HTTP request | Description
144145
*Jsflagr.SegmentApi* | [**findSegments**](docs/SegmentApi.md#findSegments) | **GET** /flags/{flagID}/segments |
145146
*Jsflagr.SegmentApi* | [**putSegment**](docs/SegmentApi.md#putSegment) | **PUT** /flags/{flagID}/segments/{segmentID} |
146147
*Jsflagr.SegmentApi* | [**putSegmentsReorder**](docs/SegmentApi.md#putSegmentsReorder) | **PUT** /flags/{flagID}/segments/reorder |
148+
*Jsflagr.TagApi* | [**createTag**](docs/TagApi.md#createTag) | **POST** /flags/{flagID}/tags |
149+
*Jsflagr.TagApi* | [**deleteTag**](docs/TagApi.md#deleteTag) | **DELETE** /flags/{flagID}/tags/{tagID} |
150+
*Jsflagr.TagApi* | [**findAllTags**](docs/TagApi.md#findAllTags) | **GET** /tags |
151+
*Jsflagr.TagApi* | [**findTags**](docs/TagApi.md#findTags) | **GET** /flags/{flagID}/tags |
147152
*Jsflagr.VariantApi* | [**createVariant**](docs/VariantApi.md#createVariant) | **POST** /flags/{flagID}/variants |
148153
*Jsflagr.VariantApi* | [**deleteVariant**](docs/VariantApi.md#deleteVariant) | **DELETE** /flags/{flagID}/variants/{variantID} |
149154
*Jsflagr.VariantApi* | [**findVariants**](docs/VariantApi.md#findVariants) | **GET** /flags/{flagID}/variants |
@@ -156,6 +161,7 @@ Class | Method | HTTP request | Description
156161
- [Jsflagr.CreateConstraintRequest](docs/CreateConstraintRequest.md)
157162
- [Jsflagr.CreateFlagRequest](docs/CreateFlagRequest.md)
158163
- [Jsflagr.CreateSegmentRequest](docs/CreateSegmentRequest.md)
164+
- [Jsflagr.CreateTagRequest](docs/CreateTagRequest.md)
159165
- [Jsflagr.CreateVariantRequest](docs/CreateVariantRequest.md)
160166
- [Jsflagr.Distribution](docs/Distribution.md)
161167
- [Jsflagr.Error](docs/Error.md)
@@ -167,6 +173,7 @@ Class | Method | HTTP request | Description
167173
- [Jsflagr.EvaluationEntity](docs/EvaluationEntity.md)
168174
- [Jsflagr.Flag](docs/Flag.md)
169175
- [Jsflagr.FlagSnapshot](docs/FlagSnapshot.md)
176+
- [Jsflagr.Health](docs/Health.md)
170177
- [Jsflagr.PutDistributionsRequest](docs/PutDistributionsRequest.md)
171178
- [Jsflagr.PutFlagRequest](docs/PutFlagRequest.md)
172179
- [Jsflagr.PutSegmentReorderRequest](docs/PutSegmentReorderRequest.md)
@@ -175,6 +182,7 @@ Class | Method | HTTP request | Description
175182
- [Jsflagr.Segment](docs/Segment.md)
176183
- [Jsflagr.SegmentDebugLog](docs/SegmentDebugLog.md)
177184
- [Jsflagr.SetFlagEnabledRequest](docs/SetFlagEnabledRequest.md)
185+
- [Jsflagr.Tag](docs/Tag.md)
178186
- [Jsflagr.Variant](docs/Variant.md)
179187

180188

‎docs/CreateFlagRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**description** | **String** | |
77
**key** | **String** | unique key representation of the flag | [optional]
8+
**template** | **String** | template for flag creation | [optional]
89

910

‎docs/CreateTagRequest.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Jsflagr.CreateTagRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**value** | **String** | |
7+
8+

‎docs/EvalContext.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**entityID** | **String** | entityID is used to deterministically at random to evaluate the flag result. If it's empty, flagr will randomly generate one. | [optional]
6+
**entityID** | **String** | entityID is used to deterministically at random to evaluate the flag result. If it's empty, flagr will randomly generate one. | [optional]
77
**entityType** | **String** | | [optional]
88
**entityContext** | **Object** | | [optional]
99
**enableDebug** | **Boolean** | | [optional]
1010
**flagID** | **Number** | flagID | [optional]
1111
**flagKey** | **String** | flagKey. flagID or flagKey will resolve to the same flag. Either works. | [optional]
12+
**flagTags** | **[String]** | flagTags. flagTags looks up flags by tag. Either works. | [optional]
1213

1314

‎docs/EvaluationBatchRequest.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
**entities** | [**[EvaluationEntity]**](EvaluationEntity.md) | |
77
**enableDebug** | **Boolean** | | [optional]
88
**flagIDs** | **[Number]** | flagIDs | [optional]
9-
**flagKeys** | **[String]** | flagKeys. Either flagIDs or flagKeys works. If pass in both, Flagr may return duplicate results. | [optional]
9+
**flagKeys** | **[String]** | flagKeys. Either flagIDs, flagKeys or flagTags works. If pass in multiples, Flagr may return duplicate results. | [optional]
10+
**flagTags** | **[String]** | flagTags. Either flagIDs, flagKeys or flagTags works. If pass in multiples, Flagr may return duplicate results. | [optional]
1011

1112

‎docs/ExportApi.md

+54-6
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ All URIs are relative to *http://localhost/api/v1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**getExportSQLite**](ExportApi.md#getExportSQLite) | **GET** /export/sqlite |
7+
[**getExportEvalCacheJSON**](ExportApi.md#getExportEvalCacheJSON) | **GET** /export/eval_cache/json |
8+
[**getExportSqlite**](ExportApi.md#getExportSqlite) | **GET** /export/sqlite |
89

910

10-
<a name="getExportSQLite"></a>
11-
# **getExportSQLite**
12-
> File getExportSQLite()
11+
<a name="getExportEvalCacheJSON"></a>
12+
# **getExportEvalCacheJSON**
13+
> Object getExportEvalCacheJSON()
1314
1415

1516

16-
Export sqlite3 format of the db dump, which is converted from the main database.
17+
Export JSON format of the eval cache dump
1718

1819
### Example
1920
```javascript
@@ -28,14 +29,61 @@ var callback = function(error, data, response) {
2829
console.log('API called successfully. Returned data: ' + data);
2930
}
3031
};
31-
apiInstance.getExportSQLite(callback);
32+
apiInstance.getExportEvalCacheJSON(callback);
3233
```
3334

3435
### Parameters
3536
This endpoint does not need any parameter.
3637

3738
### Return type
3839

40+
**Object**
41+
42+
### Authorization
43+
44+
No authorization required
45+
46+
### HTTP request headers
47+
48+
- **Content-Type**: application/json
49+
- **Accept**: application/json
50+
51+
<a name="getExportSqlite"></a>
52+
# **getExportSqlite**
53+
> File getExportSqlite(opts)
54+
55+
56+
57+
Export sqlite3 format of the db dump, which is converted from the main database.
58+
59+
### Example
60+
```javascript
61+
var Jsflagr = require('jsflagr');
62+
63+
var apiInstance = new Jsflagr.ExportApi();
64+
65+
var opts = {
66+
'excludeSnapshots': true // Boolean | export without snapshots data - useful for smaller db without snapshots
67+
};
68+
69+
var callback = function(error, data, response) {
70+
if (error) {
71+
console.error(error);
72+
} else {
73+
console.log('API called successfully. Returned data: ' + data);
74+
}
75+
};
76+
apiInstance.getExportSqlite(opts, callback);
77+
```
78+
79+
### Parameters
80+
81+
Name | Type | Description | Notes
82+
------------- | ------------- | ------------- | -------------
83+
**excludeSnapshots** | **Boolean**| export without snapshots data - useful for smaller db without snapshots | [optional]
84+
85+
### Return type
86+
3987
**File**
4088

4189
### Authorization

‎docs/Flag.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ Name | Type | Description | Notes
77
**key** | **String** | unique key representation of the flag | [optional]
88
**description** | **String** | |
99
**enabled** | **Boolean** | |
10+
**tags** | [**[Tag]**](Tag.md) | | [optional]
1011
**segments** | [**[Segment]**](Segment.md) | | [optional]
1112
**variants** | [**[Variant]**](Variant.md) | | [optional]
1213
**dataRecordsEnabled** | **Boolean** | enabled data records will get data logging in the metrics pipeline, for example, kafka. |
13-
**entityType** | **String** | it will override the entityType in the evaluation logs if it&#39;s not empty | [optional]
14+
**entityType** | **String** | it will override the entityType in the evaluation logs if it's not empty | [optional]
15+
**notes** | **String** | flag usage details in markdown format | [optional]
1416
**createdBy** | **String** | | [optional]
1517
**updatedBy** | **String** | | [optional]
1618
**updatedAt** | **Date** | | [optional]

‎docs/FlagApi.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ var opts = {
118118
'limit': 789, // Number | the numbers of flags to return
119119
'enabled': true, // Boolean | return flags having given enabled status
120120
'description': "description_example", // String | return flags exactly matching given description
121+
'tags': "tags_example", // String | return flags with the given tags (comma separated)
121122
'descriptionLike': "descriptionLike_example", // String | return flags partially matching given description
122123
'key': "key_example", // String | return flags matching given key
123124
'offset': 789, // Number | return flags given the offset, it should usually set together with limit
@@ -141,6 +142,7 @@ Name | Type | Description | Notes
141142
**limit** | **Number**| the numbers of flags to return | [optional]
142143
**enabled** | **Boolean**| return flags having given enabled status | [optional]
143144
**description** | **String**| return flags exactly matching given description | [optional]
145+
**tags** | **String**| return flags with the given tags (comma separated) | [optional]
144146
**descriptionLike** | **String**| return flags partially matching given description | [optional]
145147
**key** | **String**| return flags matching given key | [optional]
146148
**offset** | **Number**| return flags given the offset, it should usually set together with limit | [optional]
@@ -205,7 +207,7 @@ No authorization required
205207

206208
<a name="getFlagEntityTypes"></a>
207209
# **getFlagEntityTypes**
208-
> [&#39;String&#39;] getFlagEntityTypes()
210+
> ['String'] getFlagEntityTypes()
209211
210212

211213

@@ -230,7 +232,7 @@ This endpoint does not need any parameter.
230232

231233
### Return type
232234

233-
**[&#39;String&#39;]**
235+
**['String']**
234236

235237
### Authorization
236238

‎docs/Health.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Jsflagr.Health
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**status** | **String** | | [optional]
7+
8+

‎docs/HealthApi.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Method | HTTP request | Description
99

1010
<a name="getHealth"></a>
1111
# **getHealth**
12-
> getHealth()
12+
> Health getHealth()
1313
1414

1515

@@ -25,7 +25,7 @@ var callback = function(error, data, response) {
2525
if (error) {
2626
console.error(error);
2727
} else {
28-
console.log('API called successfully.');
28+
console.log('API called successfully. Returned data: ' + data);
2929
}
3030
};
3131
apiInstance.getHealth(callback);
@@ -36,7 +36,7 @@ This endpoint does not need any parameter.
3636

3737
### Return type
3838

39-
null (empty response body)
39+
[**Health**](Health.md)
4040

4141
### Authorization
4242

‎docs/PutFlagRequest.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**description** | **String** | | [optional]
77
**dataRecordsEnabled** | **Boolean** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | [optional]
8-
**entityType** | **String** | it will overwrite entityType into evaluation logs if it&#39;s not empty | [optional]
8+
**entityType** | **String** | it will overwrite entityType into evaluation logs if it's not empty | [optional]
99
**enabled** | **Boolean** | | [optional]
1010
**key** | **String** | | [optional]
11+
**notes** | **String** | | [optional]
1112

1213

‎docs/Tag.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Jsflagr.Tag
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **Number** | | [optional]
7+
**value** | **String** | |
8+
9+

0 commit comments

Comments
 (0)