unleash-server 5.2.7 → 5.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/addons/addon-schema.js +10 -0
- package/dist/lib/addons/addon-schema.js.map +1 -1
- package/dist/lib/addons/addon.d.ts +1 -0
- package/dist/lib/addons/addon.js.map +1 -1
- package/dist/lib/addons/datadog-definition.js +21 -0
- package/dist/lib/addons/datadog-definition.js.map +1 -1
- package/dist/lib/addons/datadog.d.ts +8 -1
- package/dist/lib/addons/datadog.js +14 -2
- package/dist/lib/addons/datadog.js.map +1 -1
- package/dist/lib/addons/datadog.test.js +62 -0
- package/dist/lib/addons/datadog.test.js.map +1 -1
- package/dist/lib/addons/feature-event-formatter-md.d.ts +1 -0
- package/dist/lib/addons/feature-event-formatter-md.js +7 -0
- package/dist/lib/addons/feature-event-formatter-md.js.map +1 -1
- package/dist/lib/addons/index.d.ts +2 -1
- package/dist/lib/addons/index.js +12 -2
- package/dist/lib/addons/index.js.map +1 -1
- package/dist/lib/addons/installation-definition-schema.d.ts +2 -0
- package/dist/lib/addons/installation-definition-schema.js +13 -0
- package/dist/lib/addons/installation-definition-schema.js.map +1 -0
- package/dist/lib/addons/slack-app-definition.d.ts +3 -0
- package/dist/lib/addons/slack-app-definition.js +68 -0
- package/dist/lib/addons/slack-app-definition.js.map +1 -0
- package/dist/lib/addons/slack-app.d.ts +23 -0
- package/dist/lib/addons/slack-app.js +137 -0
- package/dist/lib/addons/slack-app.js.map +1 -0
- package/dist/lib/addons/slack-app.test.d.ts +1 -0
- package/dist/lib/addons/slack-app.test.js +191 -0
- package/dist/lib/addons/slack-app.test.js.map +1 -0
- package/dist/lib/addons/slack-definition.js +13 -0
- package/dist/lib/addons/slack-definition.js.map +1 -1
- package/dist/lib/addons/slack.d.ts +9 -1
- package/dist/lib/addons/slack.js +15 -3
- package/dist/lib/addons/slack.js.map +1 -1
- package/dist/lib/addons/slack.test.js +33 -0
- package/dist/lib/addons/slack.test.js.map +1 -1
- package/dist/lib/addons/teams-definition.js +13 -0
- package/dist/lib/addons/teams-definition.js.map +1 -1
- package/dist/lib/addons/teams.d.ts +6 -1
- package/dist/lib/addons/teams.js +11 -2
- package/dist/lib/addons/teams.js.map +1 -1
- package/dist/lib/addons/teams.test.js +28 -0
- package/dist/lib/addons/teams.test.js.map +1 -1
- package/dist/lib/addons/webhook-definition.js +13 -0
- package/dist/lib/addons/webhook-definition.js.map +1 -1
- package/dist/lib/addons/webhook.d.ts +1 -0
- package/dist/lib/addons/webhook.js +11 -1
- package/dist/lib/addons/webhook.js.map +1 -1
- package/dist/lib/addons/webhook.test.js +29 -0
- package/dist/lib/addons/webhook.test.js.map +1 -1
- package/dist/lib/create-config.js +2 -2
- package/dist/lib/create-config.js.map +1 -1
- package/dist/lib/db/access-store.d.ts +0 -1
- package/dist/lib/db/access-store.js +1 -14
- package/dist/lib/db/access-store.js.map +1 -1
- package/dist/lib/db/client-metrics-store-v2.js +7 -2
- package/dist/lib/db/client-metrics-store-v2.js.map +1 -1
- package/dist/lib/db/context-field-store.js +9 -18
- package/dist/lib/db/context-field-store.js.map +1 -1
- package/dist/lib/db/event-store.d.ts +2 -0
- package/dist/lib/db/event-store.js +19 -9
- package/dist/lib/db/event-store.js.map +1 -1
- package/dist/lib/db/feature-strategy-store.js +5 -0
- package/dist/lib/db/feature-strategy-store.js.map +1 -1
- package/dist/lib/db/feature-strategy-store.test.js +1 -0
- package/dist/lib/db/feature-strategy-store.test.js.map +1 -1
- package/dist/lib/db/feature-toggle-client-store.d.ts +7 -8
- package/dist/lib/db/feature-toggle-client-store.js +46 -24
- package/dist/lib/db/feature-toggle-client-store.js.map +1 -1
- package/dist/lib/db/feature-toggle-store.d.ts +6 -0
- package/dist/lib/db/feature-toggle-store.js +35 -0
- package/dist/lib/db/feature-toggle-store.js.map +1 -1
- package/dist/lib/db/feature-type-store.d.ts +1 -0
- package/dist/lib/db/feature-type-store.js +12 -0
- package/dist/lib/db/feature-type-store.js.map +1 -1
- package/dist/lib/db/group-store.d.ts +5 -7
- package/dist/lib/db/group-store.js +51 -25
- package/dist/lib/db/group-store.js.map +1 -1
- package/dist/lib/db/index.js +1 -1
- package/dist/lib/db/index.js.map +1 -1
- package/dist/lib/db/project-store.d.ts +3 -5
- package/dist/lib/db/project-store.js +19 -19
- package/dist/lib/db/project-store.js.map +1 -1
- package/dist/lib/db/segment-store.d.ts +2 -1
- package/dist/lib/db/segment-store.js +23 -20
- package/dist/lib/db/segment-store.js.map +1 -1
- package/dist/lib/db/segment-store.test.d.ts +1 -0
- package/dist/lib/db/segment-store.test.js +32 -0
- package/dist/lib/db/segment-store.test.js.map +1 -0
- package/dist/lib/error/bad-data-error.d.ts +1 -0
- package/dist/lib/error/bad-data-error.js +18 -5
- package/dist/lib/error/bad-data-error.js.map +1 -1
- package/dist/lib/error/content-type-error.d.ts +1 -0
- package/dist/lib/error/content-type-error.js +1 -0
- package/dist/lib/error/content-type-error.js.map +1 -1
- package/dist/lib/error/disabled-error.d.ts +1 -0
- package/dist/lib/error/disabled-error.js +4 -0
- package/dist/lib/error/disabled-error.js.map +1 -1
- package/dist/lib/error/feature-has-tag-error.d.ts +1 -0
- package/dist/lib/error/feature-has-tag-error.js +4 -0
- package/dist/lib/error/feature-has-tag-error.js.map +1 -1
- package/dist/lib/error/forbidden-error.d.ts +5 -0
- package/dist/lib/error/forbidden-error.js +12 -0
- package/dist/lib/error/forbidden-error.js.map +1 -0
- package/dist/lib/error/from-legacy-error.js +68 -0
- package/dist/lib/error/from-legacy-error.js.map +1 -1
- package/dist/lib/error/incompatible-project-error.d.ts +1 -0
- package/dist/lib/error/incompatible-project-error.js +1 -0
- package/dist/lib/error/incompatible-project-error.js.map +1 -1
- package/dist/lib/error/index.d.ts +3 -2
- package/dist/lib/error/index.js +5 -3
- package/dist/lib/error/index.js.map +1 -1
- package/dist/lib/error/invalid-operation-error.d.ts +1 -0
- package/dist/lib/error/invalid-operation-error.js +4 -0
- package/dist/lib/error/invalid-operation-error.js.map +1 -1
- package/dist/lib/error/invalid-token-error.d.ts +1 -0
- package/dist/lib/error/invalid-token-error.js +1 -0
- package/dist/lib/error/invalid-token-error.js.map +1 -1
- package/dist/lib/error/minimum-one-environment-error.d.ts +1 -0
- package/dist/lib/error/minimum-one-environment-error.js +4 -0
- package/dist/lib/error/minimum-one-environment-error.js.map +1 -1
- package/dist/lib/error/name-exists-error.d.ts +1 -0
- package/dist/lib/error/name-exists-error.js +4 -0
- package/dist/lib/error/name-exists-error.js.map +1 -1
- package/dist/lib/error/not-implemented-error.d.ts +1 -0
- package/dist/lib/error/not-implemented-error.js +4 -0
- package/dist/lib/error/not-implemented-error.js.map +1 -1
- package/dist/lib/error/notfound-error.d.ts +1 -0
- package/dist/lib/error/notfound-error.js +1 -0
- package/dist/lib/error/notfound-error.js.map +1 -1
- package/dist/lib/error/operation-denied-error.d.ts +1 -0
- package/dist/lib/error/operation-denied-error.js +4 -0
- package/dist/lib/error/operation-denied-error.js.map +1 -1
- package/dist/lib/error/owasp-validation-error.d.ts +1 -0
- package/dist/lib/error/owasp-validation-error.js +1 -0
- package/dist/lib/error/owasp-validation-error.js.map +1 -1
- package/dist/lib/error/password-mismatch.d.ts +1 -0
- package/dist/lib/error/password-mismatch.js +1 -0
- package/dist/lib/error/password-mismatch.js.map +1 -1
- package/dist/lib/error/password-undefined.d.ts +1 -0
- package/dist/lib/error/password-undefined.js +1 -0
- package/dist/lib/error/password-undefined.js.map +1 -1
- package/dist/lib/error/{no-access-error.d.ts → permission-error.d.ts} +3 -2
- package/dist/lib/error/{no-access-error.js → permission-error.js} +10 -7
- package/dist/lib/error/permission-error.js.map +1 -0
- package/dist/lib/error/project-without-owner-error.d.ts +1 -0
- package/dist/lib/error/project-without-owner-error.js +1 -0
- package/dist/lib/error/project-without-owner-error.js.map +1 -1
- package/dist/lib/error/role-in-use-error.d.ts +1 -0
- package/dist/lib/error/role-in-use-error.js +4 -0
- package/dist/lib/error/role-in-use-error.js.map +1 -1
- package/dist/lib/error/unauthorized-error.d.ts +1 -0
- package/dist/lib/error/unauthorized-error.js +4 -0
- package/dist/lib/error/unauthorized-error.js.map +1 -1
- package/dist/lib/error/unleash-error.d.ts +5 -3
- package/dist/lib/error/unleash-error.js +4 -61
- package/dist/lib/error/unleash-error.js.map +1 -1
- package/dist/lib/error/unleash-error.test.js +67 -37
- package/dist/lib/error/unleash-error.test.js.map +1 -1
- package/dist/lib/error/used-token-error.d.ts +1 -0
- package/dist/lib/error/used-token-error.js +1 -0
- package/dist/lib/error/used-token-error.js.map +1 -1
- package/dist/lib/features/export-import-toggles/export-import-controller.js +12 -7
- package/dist/lib/features/export-import-toggles/export-import-controller.js.map +1 -1
- package/dist/lib/features/export-import-toggles/import-permissions-service.js +1 -1
- package/dist/lib/features/export-import-toggles/import-permissions-service.js.map +1 -1
- package/dist/lib/features/feature-toggle/createFeatureToggleService.js +1 -1
- package/dist/lib/features/feature-toggle/createFeatureToggleService.js.map +1 -1
- package/dist/lib/features/group/createGroupService.d.ts +4 -0
- package/dist/lib/features/group/createGroupService.js +20 -0
- package/dist/lib/features/group/createGroupService.js.map +1 -0
- package/dist/lib/features/playground/feature-evaluator/client.d.ts +3 -1
- package/dist/lib/features/playground/feature-evaluator/client.js +33 -13
- package/dist/lib/features/playground/feature-evaluator/client.js.map +1 -1
- package/dist/lib/features/playground/feature-evaluator/strategy/strategy.d.ts +3 -1
- package/dist/lib/features/playground/feature-evaluator/strategy/strategy.js +14 -1
- package/dist/lib/features/playground/feature-evaluator/strategy/strategy.js.map +1 -1
- package/dist/lib/features/playground/feature-evaluator/variant.d.ts +4 -4
- package/dist/lib/features/playground/feature-evaluator/variant.js +14 -10
- package/dist/lib/features/playground/feature-evaluator/variant.js.map +1 -1
- package/dist/lib/features/playground/offline-unleash-client.js +7 -0
- package/dist/lib/features/playground/offline-unleash-client.js.map +1 -1
- package/dist/lib/features/playground/offline-unleash-client.test.js +69 -0
- package/dist/lib/features/playground/offline-unleash-client.test.js.map +1 -1
- package/dist/lib/features/playground/playground-service.js +5 -3
- package/dist/lib/features/playground/playground-service.js.map +1 -1
- package/dist/lib/features/playground/playground.js +12 -15
- package/dist/lib/features/playground/playground.js.map +1 -1
- package/dist/lib/middleware/api-token-middleware.js +1 -1
- package/dist/lib/middleware/api-token-middleware.js.map +1 -1
- package/dist/lib/openapi/index.js +15 -3
- package/dist/lib/openapi/index.js.map +1 -1
- package/dist/lib/openapi/meta-schema-rules.test.js +0 -126
- package/dist/lib/openapi/meta-schema-rules.test.js.map +1 -1
- package/dist/lib/openapi/spec/addon-type-schema.d.ts +57 -0
- package/dist/lib/openapi/spec/addon-type-schema.js +50 -0
- package/dist/lib/openapi/spec/addon-type-schema.js.map +1 -1
- package/dist/lib/openapi/spec/addons-schema.d.ts +64 -0
- package/dist/lib/openapi/spec/advanced-playground-environment-feature-schema.d.ts +166 -4
- package/dist/lib/openapi/spec/advanced-playground-environment-feature-schema.js +1 -2
- package/dist/lib/openapi/spec/advanced-playground-environment-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/advanced-playground-feature-schema.d.ts +331 -6
- package/dist/lib/openapi/spec/advanced-playground-response-schema.d.ts +662 -12
- package/dist/lib/openapi/spec/api-tokens-schema.d.ts +2 -2
- package/dist/lib/openapi/spec/api-tokens-schema.js +2 -2
- package/dist/lib/openapi/spec/api-tokens-schema.js.map +1 -1
- package/dist/lib/openapi/spec/batch-features-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/batch-features-schema.js +3 -0
- package/dist/lib/openapi/spec/batch-features-schema.js.map +1 -1
- package/dist/lib/openapi/spec/batch-stale-schema.d.ts +7 -0
- package/dist/lib/openapi/spec/batch-stale-schema.js +7 -0
- package/dist/lib/openapi/spec/batch-stale-schema.js.map +1 -1
- package/dist/lib/openapi/spec/change-password-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/change-password-schema.js +5 -0
- package/dist/lib/openapi/spec/change-password-schema.js.map +1 -1
- package/dist/lib/openapi/spec/client-feature-schema.d.ts +121 -3
- package/dist/lib/openapi/spec/client-feature-schema.js +2 -0
- package/dist/lib/openapi/spec/client-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/client-features-schema.d.ts +246 -16
- package/dist/lib/openapi/spec/client-features-schema.js +5 -3
- package/dist/lib/openapi/spec/client-features-schema.js.map +1 -1
- package/dist/lib/openapi/spec/client-features-schema.test.js +1 -2
- package/dist/lib/openapi/spec/client-features-schema.test.js.map +1 -1
- package/dist/lib/openapi/spec/client-segment-schema.d.ts +75 -0
- package/dist/lib/openapi/spec/client-segment-schema.js +35 -0
- package/dist/lib/openapi/spec/client-segment-schema.js.map +1 -0
- package/dist/lib/openapi/spec/clone-feature-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/clone-feature-schema.js +5 -0
- package/dist/lib/openapi/spec/clone-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/context-field-schema.d.ts +22 -3
- package/dist/lib/openapi/spec/context-field-schema.js +17 -3
- package/dist/lib/openapi/spec/context-field-schema.js.map +1 -1
- package/dist/lib/openapi/spec/context-field-strategies-schema.d.ts +1 -1
- package/dist/lib/openapi/spec/context-field-strategies-schema.js +1 -1
- package/dist/lib/openapi/spec/context-field-strategies-schema.js.map +1 -1
- package/dist/lib/openapi/spec/context-fields-schema.d.ts +28 -3
- package/dist/lib/openapi/spec/context-fields-schema.js +1 -0
- package/dist/lib/openapi/spec/context-fields-schema.js.map +1 -1
- package/dist/lib/openapi/spec/create-api-token-schema.d.ts +130 -32
- package/dist/lib/openapi/spec/create-api-token-schema.js +71 -35
- package/dist/lib/openapi/spec/create-api-token-schema.js.map +1 -1
- package/dist/lib/openapi/spec/create-feature-schema.d.ts +9 -0
- package/dist/lib/openapi/spec/create-feature-schema.js +9 -0
- package/dist/lib/openapi/spec/create-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/create-feature-strategy-schema.d.ts +63 -2
- package/dist/lib/openapi/spec/create-feature-strategy-schema.js +12 -2
- package/dist/lib/openapi/spec/create-feature-strategy-schema.js.map +1 -1
- package/dist/lib/openapi/spec/create-group-schema.d.ts +61 -0
- package/dist/lib/openapi/spec/create-group-schema.js +43 -0
- package/dist/lib/openapi/spec/create-group-schema.js.map +1 -0
- package/dist/lib/openapi/spec/create-strategy-schema.d.ts +52 -0
- package/dist/lib/openapi/spec/create-strategy-schema.js +60 -0
- package/dist/lib/openapi/spec/create-strategy-schema.js.map +1 -0
- package/dist/lib/openapi/spec/create-strategy-variant-schema.d.ts +54 -0
- package/dist/lib/openapi/spec/create-strategy-variant-schema.js +53 -0
- package/dist/lib/openapi/spec/create-strategy-variant-schema.js.map +1 -0
- package/dist/lib/openapi/spec/create-user-response-schema.d.ts +98 -0
- package/dist/lib/openapi/spec/create-user-response-schema.js +31 -0
- package/dist/lib/openapi/spec/create-user-response-schema.js.map +1 -0
- package/dist/lib/openapi/spec/create-user-schema.d.ts +21 -1
- package/dist/lib/openapi/spec/create-user-schema.js +24 -1
- package/dist/lib/openapi/spec/create-user-schema.js.map +1 -1
- package/dist/lib/openapi/spec/email-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/email-schema.js +3 -0
- package/dist/lib/openapi/spec/email-schema.js.map +1 -1
- package/dist/lib/openapi/spec/environment-project-schema.d.ts +115 -2
- package/dist/lib/openapi/spec/environment-project-schema.js +2 -0
- package/dist/lib/openapi/spec/environment-project-schema.js.map +1 -1
- package/dist/lib/openapi/spec/environments-project-schema.d.ts +118 -2
- package/dist/lib/openapi/spec/environments-project-schema.js +3 -0
- package/dist/lib/openapi/spec/environments-project-schema.js.map +1 -1
- package/dist/lib/openapi/spec/environments-schema.d.ts +4 -0
- package/dist/lib/openapi/spec/environments-schema.js +4 -0
- package/dist/lib/openapi/spec/environments-schema.js.map +1 -1
- package/dist/lib/openapi/spec/event-schema.d.ts +130 -0
- package/dist/lib/openapi/spec/event-schema.js +42 -2
- package/dist/lib/openapi/spec/event-schema.js.map +1 -1
- package/dist/lib/openapi/spec/events-schema.d.ts +137 -0
- package/dist/lib/openapi/spec/events-schema.js +7 -0
- package/dist/lib/openapi/spec/events-schema.js.map +1 -1
- package/dist/lib/openapi/spec/export-query-schema.d.ts +7 -0
- package/dist/lib/openapi/spec/export-query-schema.js +7 -0
- package/dist/lib/openapi/spec/export-query-schema.js.map +1 -1
- package/dist/lib/openapi/spec/export-result-schema.d.ts +609 -17
- package/dist/lib/openapi/spec/export-result-schema.js +90 -0
- package/dist/lib/openapi/spec/export-result-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-environment-schema.d.ts +125 -3
- package/dist/lib/openapi/spec/feature-environment-schema.js +6 -0
- package/dist/lib/openapi/spec/feature-environment-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-events-schema.d.ts +141 -1
- package/dist/lib/openapi/spec/feature-events-schema.js +13 -1
- package/dist/lib/openapi/spec/feature-events-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-schema.d.ts +251 -6
- package/dist/lib/openapi/spec/feature-schema.js +7 -0
- package/dist/lib/openapi/spec/feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-schema.test.js +2 -2
- package/dist/lib/openapi/spec/feature-schema.test.js.map +1 -1
- package/dist/lib/openapi/spec/feature-strategy-schema.d.ts +61 -1
- package/dist/lib/openapi/spec/feature-strategy-schema.js +10 -1
- package/dist/lib/openapi/spec/feature-strategy-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-type-schema.d.ts +11 -1
- package/dist/lib/openapi/spec/feature-type-schema.js +11 -1
- package/dist/lib/openapi/spec/feature-type-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-types-schema.d.ts +42 -1
- package/dist/lib/openapi/spec/feature-types-schema.js +37 -0
- package/dist/lib/openapi/spec/feature-types-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feature-variants-schema.d.ts +11 -2
- package/dist/lib/openapi/spec/feature-variants-schema.js +4 -0
- package/dist/lib/openapi/spec/feature-variants-schema.js.map +1 -1
- package/dist/lib/openapi/spec/features-schema.d.ts +501 -12
- package/dist/lib/openapi/spec/features-schema.js +6 -0
- package/dist/lib/openapi/spec/features-schema.js.map +1 -1
- package/dist/lib/openapi/spec/feedback-create-schema.d.ts +21 -0
- package/dist/lib/openapi/spec/feedback-create-schema.js +23 -0
- package/dist/lib/openapi/spec/feedback-create-schema.js.map +1 -0
- package/dist/lib/openapi/spec/feedback-response-schema.d.ts +33 -0
- package/dist/lib/openapi/spec/feedback-response-schema.js +35 -0
- package/dist/lib/openapi/spec/feedback-response-schema.js.map +1 -0
- package/dist/lib/openapi/spec/feedback-update-schema.d.ts +27 -0
- package/dist/lib/openapi/spec/feedback-update-schema.js +29 -0
- package/dist/lib/openapi/spec/feedback-update-schema.js.map +1 -0
- package/dist/lib/openapi/spec/group-schema.d.ts +107 -9
- package/dist/lib/openapi/spec/group-schema.js +20 -3
- package/dist/lib/openapi/spec/group-schema.js.map +1 -1
- package/dist/lib/openapi/spec/group-user-model-schema.d.ts +46 -3
- package/dist/lib/openapi/spec/group-user-model-schema.js +5 -0
- package/dist/lib/openapi/spec/group-user-model-schema.js.map +1 -1
- package/dist/lib/openapi/spec/groups-schema.d.ts +196 -15
- package/dist/lib/openapi/spec/groups-schema.js +2 -0
- package/dist/lib/openapi/spec/groups-schema.js.map +1 -1
- package/dist/lib/openapi/spec/health-overview-schema.d.ts +733 -16
- package/dist/lib/openapi/spec/health-overview-schema.js +10 -0
- package/dist/lib/openapi/spec/health-overview-schema.js.map +1 -1
- package/dist/lib/openapi/spec/health-report-schema.d.ts +733 -16
- package/dist/lib/openapi/spec/id-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/id-schema.js +3 -0
- package/dist/lib/openapi/spec/id-schema.js.map +1 -1
- package/dist/lib/openapi/spec/import-toggles-schema.d.ts +1198 -63
- package/dist/lib/openapi/spec/import-toggles-schema.js +7 -0
- package/dist/lib/openapi/spec/import-toggles-schema.js.map +1 -1
- package/dist/lib/openapi/spec/import-toggles-validate-item-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/import-toggles-validate-item-schema.js +5 -0
- package/dist/lib/openapi/spec/import-toggles-validate-item-schema.js.map +1 -1
- package/dist/lib/openapi/spec/import-toggles-validate-schema.d.ts +18 -0
- package/dist/lib/openapi/spec/import-toggles-validate-schema.js +17 -0
- package/dist/lib/openapi/spec/import-toggles-validate-schema.js.map +1 -1
- package/dist/lib/openapi/spec/index.d.ts +15 -3
- package/dist/lib/openapi/spec/index.js +15 -3
- package/dist/lib/openapi/spec/index.js.map +1 -1
- package/dist/lib/openapi/spec/legal-value-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/legal-value-schema.js +5 -0
- package/dist/lib/openapi/spec/legal-value-schema.js.map +1 -1
- package/dist/lib/openapi/spec/login-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/login-schema.js +5 -0
- package/dist/lib/openapi/spec/login-schema.js.map +1 -1
- package/dist/lib/openapi/spec/me-schema.d.ts +69 -11
- package/dist/lib/openapi/spec/me-schema.js +7 -3
- package/dist/lib/openapi/spec/me-schema.js.map +1 -1
- package/dist/lib/openapi/spec/name-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/name-schema.js +3 -0
- package/dist/lib/openapi/spec/name-schema.js.map +1 -1
- package/dist/lib/openapi/spec/parameters-schema.d.ts +1 -0
- package/dist/lib/openapi/spec/parameters-schema.js +1 -0
- package/dist/lib/openapi/spec/parameters-schema.js.map +1 -1
- package/dist/lib/openapi/spec/password-schema.d.ts +7 -0
- package/dist/lib/openapi/spec/password-schema.js +7 -0
- package/dist/lib/openapi/spec/password-schema.js.map +1 -1
- package/dist/lib/openapi/spec/patches-schema.d.ts +1 -0
- package/dist/lib/openapi/spec/patches-schema.js +1 -0
- package/dist/lib/openapi/spec/patches-schema.js.map +1 -1
- package/dist/lib/openapi/spec/permission-schema.d.ts +7 -0
- package/dist/lib/openapi/spec/permission-schema.js +7 -0
- package/dist/lib/openapi/spec/permission-schema.js.map +1 -1
- package/dist/lib/openapi/spec/playground-feature-schema.d.ts +165 -3
- package/dist/lib/openapi/spec/playground-feature-schema.js +0 -1
- package/dist/lib/openapi/spec/playground-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/playground-response-schema.d.ts +330 -5
- package/dist/lib/openapi/spec/playground-strategy-schema.d.ts +204 -0
- package/dist/lib/openapi/spec/playground-strategy-schema.js +49 -0
- package/dist/lib/openapi/spec/playground-strategy-schema.js.map +1 -1
- package/dist/lib/openapi/spec/profile-schema.d.ts +267 -7
- package/dist/lib/openapi/spec/profile-schema.js +5 -0
- package/dist/lib/openapi/spec/profile-schema.js.map +1 -1
- package/dist/lib/openapi/spec/project-environment-schema.d.ts +115 -2
- package/dist/lib/openapi/spec/project-environment-schema.js +2 -0
- package/dist/lib/openapi/spec/project-environment-schema.js.map +1 -1
- package/dist/lib/openapi/spec/project-overview-schema.d.ts +733 -16
- package/dist/lib/openapi/spec/project-overview-schema.js +10 -0
- package/dist/lib/openapi/spec/project-overview-schema.js.map +1 -1
- package/dist/lib/openapi/spec/proxy-client-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/proxy-client-schema.js +3 -0
- package/dist/lib/openapi/spec/proxy-client-schema.js.map +1 -1
- package/dist/lib/openapi/spec/proxy-feature-schema.d.ts +20 -2
- package/dist/lib/openapi/spec/proxy-feature-schema.js +20 -3
- package/dist/lib/openapi/spec/proxy-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/proxy-features-schema.d.ts +22 -1
- package/dist/lib/openapi/spec/proxy-features-schema.js +2 -0
- package/dist/lib/openapi/spec/proxy-features-schema.js.map +1 -1
- package/dist/lib/openapi/spec/public-signup-token-schema.d.ts +52 -4
- package/dist/lib/openapi/spec/public-signup-tokens-schema.d.ts +104 -8
- package/dist/lib/openapi/spec/push-variants-schema.d.ts +7 -2
- package/dist/lib/openapi/spec/requests-per-second-schema.d.ts +16 -0
- package/dist/lib/openapi/spec/requests-per-second-schema.js +22 -2
- package/dist/lib/openapi/spec/requests-per-second-schema.js.map +1 -1
- package/dist/lib/openapi/spec/requests-per-second-segmented-schema.d.ts +17 -0
- package/dist/lib/openapi/spec/requests-per-second-segmented-schema.js +1 -0
- package/dist/lib/openapi/spec/requests-per-second-segmented-schema.js.map +1 -1
- package/dist/lib/openapi/spec/role-schema.d.ts +11 -1
- package/dist/lib/openapi/spec/role-schema.js +11 -1
- package/dist/lib/openapi/spec/role-schema.js.map +1 -1
- package/dist/lib/openapi/spec/search-events-schema.d.ts +9 -0
- package/dist/lib/openapi/spec/search-events-schema.js +10 -0
- package/dist/lib/openapi/spec/search-events-schema.js.map +1 -1
- package/dist/lib/openapi/spec/segment-schema.d.ts +23 -6
- package/dist/lib/openapi/spec/segment-schema.js +18 -15
- package/dist/lib/openapi/spec/segment-schema.js.map +1 -1
- package/dist/lib/openapi/spec/set-strategy-sort-order-schema.d.ts +6 -0
- package/dist/lib/openapi/spec/set-strategy-sort-order-schema.js +6 -0
- package/dist/lib/openapi/spec/set-strategy-sort-order-schema.js.map +1 -1
- package/dist/lib/openapi/spec/set-ui-config-schema.d.ts +4 -0
- package/dist/lib/openapi/spec/set-ui-config-schema.js +4 -0
- package/dist/lib/openapi/spec/set-ui-config-schema.js.map +1 -1
- package/dist/lib/openapi/spec/splash-request-schema.d.ts +21 -0
- package/dist/lib/openapi/spec/splash-request-schema.js +23 -0
- package/dist/lib/openapi/spec/splash-request-schema.js.map +1 -0
- package/dist/lib/openapi/spec/splash-response-schema.d.ts +27 -0
- package/dist/lib/openapi/spec/splash-response-schema.js +21 -0
- package/dist/lib/openapi/spec/splash-response-schema.js.map +1 -0
- package/dist/lib/openapi/spec/state-schema.d.ts +523 -19
- package/dist/lib/openapi/spec/state-schema.js +2 -0
- package/dist/lib/openapi/spec/state-schema.js.map +1 -1
- package/dist/lib/openapi/spec/strategies-schema.d.ts +9 -3
- package/dist/lib/openapi/spec/strategies-schema.js +5 -0
- package/dist/lib/openapi/spec/strategies-schema.js.map +1 -1
- package/dist/lib/openapi/spec/strategy-schema.d.ts +4 -3
- package/dist/lib/openapi/spec/strategy-schema.js +4 -3
- package/dist/lib/openapi/spec/strategy-schema.js.map +1 -1
- package/dist/lib/openapi/spec/strategy-schema.test.js +5 -0
- package/dist/lib/openapi/spec/strategy-schema.test.js.map +1 -1
- package/dist/lib/openapi/spec/strategy-variant-schema.d.ts +54 -0
- package/dist/lib/openapi/spec/strategy-variant-schema.js +16 -0
- package/dist/lib/openapi/spec/strategy-variant-schema.js.map +1 -0
- package/dist/lib/openapi/spec/tag-type-schema.d.ts +7 -0
- package/dist/lib/openapi/spec/tag-type-schema.js +7 -0
- package/dist/lib/openapi/spec/tag-type-schema.js.map +1 -1
- package/dist/lib/openapi/spec/tag-types-schema.d.ts +11 -0
- package/dist/lib/openapi/spec/tag-types-schema.js +4 -0
- package/dist/lib/openapi/spec/tag-types-schema.js.map +1 -1
- package/dist/lib/openapi/spec/tag-with-version-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/tag-with-version-schema.js +3 -0
- package/dist/lib/openapi/spec/tag-with-version-schema.js.map +1 -1
- package/dist/lib/openapi/spec/telemetry-settings-schema.d.ts +22 -0
- package/dist/lib/openapi/spec/telemetry-settings-schema.js +24 -0
- package/dist/lib/openapi/spec/telemetry-settings-schema.js.map +1 -0
- package/dist/lib/openapi/spec/token-user-schema.d.ts +23 -2
- package/dist/lib/openapi/spec/token-user-schema.js +12 -1
- package/dist/lib/openapi/spec/token-user-schema.js.map +1 -1
- package/dist/lib/openapi/spec/ui-config-schema.d.ts +77 -1
- package/dist/lib/openapi/spec/ui-config-schema.js +53 -0
- package/dist/lib/openapi/spec/ui-config-schema.js.map +1 -1
- package/dist/lib/openapi/spec/update-api-token-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/update-api-token-schema.js +3 -0
- package/dist/lib/openapi/spec/update-api-token-schema.js.map +1 -1
- package/dist/lib/openapi/spec/update-feature-schema.d.ts +11 -14
- package/dist/lib/openapi/spec/update-feature-schema.js +11 -14
- package/dist/lib/openapi/spec/update-feature-schema.js.map +1 -1
- package/dist/lib/openapi/spec/update-feature-strategy-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/update-feature-strategy-schema.js +4 -0
- package/dist/lib/openapi/spec/update-feature-strategy-schema.js.map +1 -1
- package/dist/lib/openapi/spec/update-feature-type-lifetime-schema.d.ts +19 -0
- package/dist/lib/openapi/spec/update-feature-type-lifetime-schema.js +21 -0
- package/dist/lib/openapi/spec/update-feature-type-lifetime-schema.js.map +1 -0
- package/dist/lib/openapi/spec/update-strategy-schema.d.ts +47 -0
- package/dist/lib/openapi/spec/update-strategy-schema.js +55 -0
- package/dist/lib/openapi/spec/update-strategy-schema.js.map +1 -0
- package/dist/lib/openapi/spec/update-tag-type-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/update-tag-type-schema.js +5 -0
- package/dist/lib/openapi/spec/update-tag-type-schema.js.map +1 -1
- package/dist/lib/openapi/spec/update-user-schema.d.ts +15 -1
- package/dist/lib/openapi/spec/update-user-schema.js +18 -1
- package/dist/lib/openapi/spec/update-user-schema.js.map +1 -1
- package/dist/lib/openapi/spec/upsert-context-field-schema.d.ts +5 -0
- package/dist/lib/openapi/spec/user-schema.d.ts +41 -3
- package/dist/lib/openapi/spec/user-schema.js +41 -3
- package/dist/lib/openapi/spec/user-schema.js.map +1 -1
- package/dist/lib/openapi/spec/users-groups-base-schema.d.ts +194 -15
- package/dist/lib/openapi/spec/users-schema.d.ts +55 -4
- package/dist/lib/openapi/spec/users-schema.js +3 -0
- package/dist/lib/openapi/spec/users-schema.js.map +1 -1
- package/dist/lib/openapi/spec/users-search-schema.d.ts +41 -3
- package/dist/lib/openapi/spec/validate-feature-schema.d.ts +16 -0
- package/dist/lib/openapi/spec/validate-feature-schema.js +18 -0
- package/dist/lib/openapi/spec/validate-feature-schema.js.map +1 -0
- package/dist/lib/openapi/spec/validate-password-schema.d.ts +3 -0
- package/dist/lib/openapi/spec/validate-password-schema.js +3 -0
- package/dist/lib/openapi/spec/validate-password-schema.js.map +1 -1
- package/dist/lib/openapi/spec/validate-tag-type-schema.d.ts +10 -0
- package/dist/lib/openapi/spec/validate-tag-type-schema.js +3 -0
- package/dist/lib/openapi/spec/validate-tag-type-schema.js.map +1 -1
- package/dist/lib/openapi/spec/variant-flag-schema.d.ts +11 -0
- package/dist/lib/openapi/spec/variant-flag-schema.js +11 -0
- package/dist/lib/openapi/spec/variant-flag-schema.js.map +1 -1
- package/dist/lib/openapi/spec/variant-schema.d.ts +7 -2
- package/dist/lib/openapi/spec/variant-schema.js +7 -2
- package/dist/lib/openapi/spec/variant-schema.js.map +1 -1
- package/dist/lib/openapi/spec/variants-schema.d.ts +7 -2
- package/dist/lib/openapi/spec/version-schema.d.ts +16 -1
- package/dist/lib/openapi/spec/version-schema.js +16 -1
- package/dist/lib/openapi/spec/version-schema.js.map +1 -1
- package/dist/lib/openapi/util/openapi-tags.d.ts +14 -2
- package/dist/lib/openapi/util/openapi-tags.js +9 -1
- package/dist/lib/openapi/util/openapi-tags.js.map +1 -1
- package/dist/lib/openapi/util/standard-responses.d.ts +1 -1
- package/dist/lib/openapi/util/standard-responses.js +1 -1
- package/dist/lib/openapi/util/standard-responses.js.map +1 -1
- package/dist/lib/openapi/validate.js +1 -1
- package/dist/lib/openapi/validate.js.map +1 -1
- package/dist/lib/routes/admin-api/api-token.js +12 -0
- package/dist/lib/routes/admin-api/api-token.js.map +1 -1
- package/dist/lib/routes/admin-api/archive.d.ts +0 -1
- package/dist/lib/routes/admin-api/archive.js +20 -5
- package/dist/lib/routes/admin-api/archive.js.map +1 -1
- package/dist/lib/routes/admin-api/config.js +4 -0
- package/dist/lib/routes/admin-api/config.js.map +1 -1
- package/dist/lib/routes/admin-api/constraints.d.ts +2 -2
- package/dist/lib/routes/admin-api/constraints.js +5 -2
- package/dist/lib/routes/admin-api/constraints.js.map +1 -1
- package/dist/lib/routes/admin-api/context.d.ts +2 -1
- package/dist/lib/routes/admin-api/context.js +16 -4
- package/dist/lib/routes/admin-api/context.js.map +1 -1
- package/dist/lib/routes/admin-api/event.js +6 -3
- package/dist/lib/routes/admin-api/event.js.map +1 -1
- package/dist/lib/routes/admin-api/favorites.js +24 -4
- package/dist/lib/routes/admin-api/favorites.js.map +1 -1
- package/dist/lib/routes/admin-api/feature-type.d.ts +6 -0
- package/dist/lib/routes/admin-api/feature-type.js +37 -1
- package/dist/lib/routes/admin-api/feature-type.js.map +1 -1
- package/dist/lib/routes/admin-api/feature.d.ts +2 -3
- package/dist/lib/routes/admin-api/feature.js +14 -3
- package/dist/lib/routes/admin-api/feature.js.map +1 -1
- package/dist/lib/routes/admin-api/index.js +2 -0
- package/dist/lib/routes/admin-api/index.js.map +1 -1
- package/dist/lib/routes/admin-api/project/project-archive.js +13 -4
- package/dist/lib/routes/admin-api/project/project-archive.js.map +1 -1
- package/dist/lib/routes/admin-api/project/project-features.d.ts +1 -1
- package/dist/lib/routes/admin-api/project/project-features.js +116 -27
- package/dist/lib/routes/admin-api/project/project-features.js.map +1 -1
- package/dist/lib/routes/admin-api/project/variants.js +26 -16
- package/dist/lib/routes/admin-api/project/variants.js.map +1 -1
- package/dist/lib/routes/admin-api/strategy.d.ts +6 -3
- package/dist/lib/routes/admin-api/strategy.js +40 -12
- package/dist/lib/routes/admin-api/strategy.js.map +1 -1
- package/dist/lib/routes/admin-api/strategy.test.js +5 -5
- package/dist/lib/routes/admin-api/strategy.test.js.map +1 -1
- package/dist/lib/routes/admin-api/tag-type.js +21 -1
- package/dist/lib/routes/admin-api/tag-type.js.map +1 -1
- package/dist/lib/routes/admin-api/tag.js +17 -1
- package/dist/lib/routes/admin-api/tag.js.map +1 -1
- package/dist/lib/routes/admin-api/telemetry.d.ts +14 -0
- package/dist/lib/routes/admin-api/telemetry.js +41 -0
- package/dist/lib/routes/admin-api/telemetry.js.map +1 -0
- package/dist/lib/routes/admin-api/user/user.js +20 -4
- package/dist/lib/routes/admin-api/user/user.js.map +1 -1
- package/dist/lib/routes/admin-api/user-admin.d.ts +3 -2
- package/dist/lib/routes/admin-api/user-admin.js +88 -14
- package/dist/lib/routes/admin-api/user-admin.js.map +1 -1
- package/dist/lib/routes/admin-api/user-feedback.js +17 -7
- package/dist/lib/routes/admin-api/user-feedback.js.map +1 -1
- package/dist/lib/routes/admin-api/user-splash.js +9 -3
- package/dist/lib/routes/admin-api/user-splash.js.map +1 -1
- package/dist/lib/routes/auth/reset-password-controller.js +24 -4
- package/dist/lib/routes/auth/reset-password-controller.js.map +1 -1
- package/dist/lib/routes/auth/simple-password-provider.js +4 -0
- package/dist/lib/routes/auth/simple-password-provider.js.map +1 -1
- package/dist/lib/routes/client-api/feature.js +1 -1
- package/dist/lib/routes/client-api/feature.js.map +1 -1
- package/dist/lib/routes/client-api/feature.test.js +8 -3
- package/dist/lib/routes/client-api/feature.test.js.map +1 -1
- package/dist/lib/routes/client-api/metrics.js +3 -3
- package/dist/lib/routes/client-api/metrics.js.map +1 -1
- package/dist/lib/routes/controller.js +2 -2
- package/dist/lib/routes/controller.js.map +1 -1
- package/dist/lib/routes/index.js +1 -3
- package/dist/lib/routes/index.js.map +1 -1
- package/dist/lib/routes/proxy-api/index.d.ts +1 -1
- package/dist/lib/routes/proxy-api/index.js +27 -4
- package/dist/lib/routes/proxy-api/index.js.map +1 -1
- package/dist/lib/segments/segment-service-interface.d.ts +2 -1
- package/dist/lib/server-impl.js +1 -0
- package/dist/lib/server-impl.js.map +1 -1
- package/dist/lib/services/addon-service.d.ts +2 -1
- package/dist/lib/services/addon-service.js +6 -2
- package/dist/lib/services/addon-service.js.map +1 -1
- package/dist/lib/services/client-metrics/metrics-service-v2.js +24 -13
- package/dist/lib/services/client-metrics/metrics-service-v2.js.map +1 -1
- package/dist/lib/services/event-announcer-service.d.ts +8 -0
- package/dist/lib/services/event-announcer-service.js +13 -0
- package/dist/lib/services/event-announcer-service.js.map +1 -0
- package/dist/lib/services/feature-service-potentially-stale.test.d.ts +1 -0
- package/dist/lib/services/feature-service-potentially-stale.test.js +44 -0
- package/dist/lib/services/feature-service-potentially-stale.test.js.map +1 -0
- package/dist/lib/services/feature-toggle-service.d.ts +5 -2
- package/dist/lib/services/feature-toggle-service.js +95 -16
- package/dist/lib/services/feature-toggle-service.js.map +1 -1
- package/dist/lib/services/feature-type-service.d.ts +1 -0
- package/dist/lib/services/feature-type-service.js +14 -0
- package/dist/lib/services/feature-type-service.js.map +1 -1
- package/dist/lib/services/group-service.d.ts +4 -4
- package/dist/lib/services/group-service.js.map +1 -1
- package/dist/lib/services/index.js +9 -1
- package/dist/lib/services/index.js.map +1 -1
- package/dist/lib/services/project-schema.js +1 -0
- package/dist/lib/services/project-schema.js.map +1 -1
- package/dist/lib/services/project-service.d.ts +2 -4
- package/dist/lib/services/project-service.js +4 -9
- package/dist/lib/services/project-service.js.map +1 -1
- package/dist/lib/services/segment-service.d.ts +2 -1
- package/dist/lib/services/segment-service.js +3 -0
- package/dist/lib/services/segment-service.js.map +1 -1
- package/dist/lib/services/tag-type-service.d.ts +2 -2
- package/dist/lib/services/tag-type-service.js +5 -3
- package/dist/lib/services/tag-type-service.js.map +1 -1
- package/dist/lib/services/user-service.js +13 -7
- package/dist/lib/services/user-service.js.map +1 -1
- package/dist/lib/services/version-service.d.ts +1 -2
- package/dist/lib/services/version-service.js +2 -4
- package/dist/lib/services/version-service.js.map +1 -1
- package/dist/lib/services/version-service.test.js +0 -57
- package/dist/lib/services/version-service.test.js.map +1 -1
- package/dist/lib/types/authentication-required.d.ts +1 -0
- package/dist/lib/types/authentication-required.js +1 -0
- package/dist/lib/types/authentication-required.js.map +1 -1
- package/dist/lib/types/events.d.ts +138 -99
- package/dist/lib/types/events.js +136 -3
- package/dist/lib/types/events.js.map +1 -1
- package/dist/lib/types/experimental.d.ts +1 -1
- package/dist/lib/types/experimental.js +5 -5
- package/dist/lib/types/experimental.js.map +1 -1
- package/dist/lib/types/group.d.ts +7 -0
- package/dist/lib/types/group.js.map +1 -1
- package/dist/lib/types/model.d.ts +24 -2
- package/dist/lib/types/model.js.map +1 -1
- package/dist/lib/types/services.d.ts +3 -0
- package/dist/lib/types/stores/event-store.d.ts +1 -0
- package/dist/lib/types/stores/feature-toggle-client-store.d.ts +2 -1
- package/dist/lib/types/stores/feature-toggle-store.d.ts +6 -0
- package/dist/lib/types/stores/feature-type-store.d.ts +1 -0
- package/dist/lib/types/stores/group-store.d.ts +4 -4
- package/dist/lib/types/stores/project-store.d.ts +3 -6
- package/dist/lib/types/stores/segment-store.d.ts +2 -1
- package/dist/lib/util/is-email.d.ts +7 -0
- package/dist/lib/util/is-email.js +9 -0
- package/dist/lib/util/is-email.js.map +1 -1
- package/dist/lib/util/load-index-html.js +1 -1
- package/dist/lib/util/load-index-html.js.map +1 -1
- package/dist/migrations/20230630080126-delete-deprecated-permissions.d.ts +2 -0
- package/dist/migrations/20230630080126-delete-deprecated-permissions.js +15 -0
- package/dist/migrations/20230630080126-delete-deprecated-permissions.js.map +1 -0
- package/dist/migrations/20230706123907-events-announced-column.d.ts +2 -0
- package/dist/migrations/20230706123907-events-announced-column.js +15 -0
- package/dist/migrations/20230706123907-events-announced-column.js.map +1 -0
- package/dist/migrations/20230711094214-add-potentially-stale-flag.d.ts +2 -0
- package/dist/migrations/20230711094214-add-potentially-stale-flag.js +18 -0
- package/dist/migrations/20230711094214-add-potentially-stale-flag.js.map +1 -0
- package/dist/migrations/20230711163311-project-feature-limit.d.ts +2 -0
- package/dist/migrations/20230711163311-project-feature-limit.js +13 -0
- package/dist/migrations/20230711163311-project-feature-limit.js.map +1 -0
- package/dist/migrations/20230712091834-strategy-variants.d.ts +2 -0
- package/dist/migrations/20230712091834-strategy-variants.js +81 -0
- package/dist/migrations/20230712091834-strategy-variants.js.map +1 -0
- package/dist/server-dev.js +5 -3
- package/dist/server-dev.js.map +1 -1
- package/dist/test/arbitraries.test.js +1 -1
- package/dist/test/arbitraries.test.js.map +1 -1
- package/dist/test/e2e/api/admin/addon.e2e.test.js +2 -1
- package/dist/test/e2e/api/admin/addon.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/api-token.e2e.test.js +7 -1
- package/dist/test/e2e/api/admin/api-token.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/archive.test.js +7 -1
- package/dist/test/e2e/api/admin/archive.test.js.map +1 -1
- package/dist/test/e2e/api/admin/config.e2e.test.js +7 -1
- package/dist/test/e2e/api/admin/config.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/favorites.e2e.test.js +7 -1
- package/dist/test/e2e/api/admin/favorites.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/feature-type.test.js +41 -1
- package/dist/test/e2e/api/admin/feature-type.test.js.map +1 -1
- package/dist/test/e2e/api/admin/feedback.e2e.test.js +7 -1
- package/dist/test/e2e/api/admin/feedback.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/playground.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/project/features.e2e.test.js +152 -0
- package/dist/test/e2e/api/admin/project/features.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/project/variants.e2e.test.js +28 -12
- package/dist/test/e2e/api/admin/project/variants.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/splash.e2e.test.js +7 -1
- package/dist/test/e2e/api/admin/splash.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/state.e2e.test.js +6 -6
- package/dist/test/e2e/api/admin/state.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/admin/user-admin.e2e.test.js +7 -1
- package/dist/test/e2e/api/admin/user-admin.e2e.test.js.map +1 -1
- package/dist/test/e2e/api/openapi/openapi.e2e.test.js +9 -6
- package/dist/test/e2e/api/openapi/openapi.e2e.test.js.map +1 -1
- package/dist/test/e2e/services/access-service.e2e.test.js +1 -1
- package/dist/test/e2e/services/access-service.e2e.test.js.map +1 -1
- package/dist/test/e2e/services/feature-toggle-service-v2.e2e.test.js +26 -4
- package/dist/test/e2e/services/feature-toggle-service-v2.e2e.test.js.map +1 -1
- package/dist/test/e2e/services/group-service.e2e.test.js +16 -0
- package/dist/test/e2e/services/group-service.e2e.test.js.map +1 -1
- package/dist/test/e2e/services/user-service.e2e.test.js +2 -2
- package/dist/test/e2e/services/user-service.e2e.test.js.map +1 -1
- package/dist/test/e2e/stores/event-store.e2e.test.js +3 -2
- package/dist/test/e2e/stores/event-store.e2e.test.js.map +1 -1
- package/dist/test/e2e/stores/feature-toggle-store.e2e.test.js +163 -0
- package/dist/test/e2e/stores/feature-toggle-store.e2e.test.js.map +1 -1
- package/dist/test/e2e/stores/feature-type-store.e2e.test.js +13 -0
- package/dist/test/e2e/stores/feature-type-store.e2e.test.js.map +1 -1
- package/dist/test/fixtures/fake-event-store.d.ts +1 -0
- package/dist/test/fixtures/fake-event-store.js +3 -0
- package/dist/test/fixtures/fake-event-store.js.map +1 -1
- package/dist/test/fixtures/fake-feature-toggle-client-store.d.ts +1 -0
- package/dist/test/fixtures/fake-feature-toggle-client-store.js +10 -0
- package/dist/test/fixtures/fake-feature-toggle-client-store.js.map +1 -1
- package/dist/test/fixtures/fake-feature-toggle-store.d.ts +6 -0
- package/dist/test/fixtures/fake-feature-toggle-store.js +6 -0
- package/dist/test/fixtures/fake-feature-toggle-store.js.map +1 -1
- package/dist/test/fixtures/fake-feature-type-store.d.ts +1 -0
- package/dist/test/fixtures/fake-feature-type-store.js +8 -0
- package/dist/test/fixtures/fake-feature-type-store.js.map +1 -1
- package/dist/test/fixtures/fake-group-store.d.ts +4 -4
- package/dist/test/fixtures/fake-group-store.js.map +1 -1
- package/dist/test/fixtures/fake-project-store.d.ts +3 -4
- package/dist/test/fixtures/fake-project-store.js +4 -13
- package/dist/test/fixtures/fake-project-store.js.map +1 -1
- package/dist/test/fixtures/fake-segment-store.d.ts +2 -1
- package/dist/test/fixtures/fake-segment-store.js +3 -0
- package/dist/test/fixtures/fake-segment-store.js.map +1 -1
- package/frontend/build/index.html +2 -2
- package/frontend/build/static/AdvancedPlayground-4c9d02ea.js +13 -0
- package/frontend/build/static/CreateProject-16b35d57.js +4 -0
- package/frontend/build/static/{Error-2c3030da.js → Error-50364f10.js} +1 -1
- package/frontend/build/static/{FeatureArchiveDialog-a529848e.js → FeatureArchiveDialog-fda1aa0c.js} +3 -3
- package/frontend/build/static/{FeatureMetricsChart-e8ede36a.js → FeatureMetricsChart-839cdf1e.js} +2 -2
- package/frontend/build/static/FeatureViewLazyExport-47bb7f13.js +7 -0
- package/frontend/build/static/LazyAdminExport-8ef0ca21.js +37 -0
- package/frontend/build/static/LazyProjectExport-49541c75.js +16 -0
- package/frontend/build/static/{NetworkOverview-e6f0a590.js → NetworkOverview-711050f3.js} +8 -8
- package/frontend/build/static/{NetworkTraffic-d1efc782.js → NetworkTraffic-e587c2c7.js} +1 -1
- package/frontend/build/static/RoleCell-9a62b4ed.js +1 -0
- package/frontend/build/static/StrategyItemContainer-4098c8ef.js +1 -0
- package/frontend/build/static/{chartjs-adapter-date-fns.esm-0d05c046.js → chartjs-adapter-date-fns.esm-d57aaddd.js} +1 -1
- package/frontend/build/static/demo-qr-c2ce85bd.png +0 -0
- package/frontend/build/static/{flowchart-elk-definition-170a3958-cc4ae597.js → flowchart-elk-definition-170a3958-4dece62b.js} +2 -2
- package/frontend/build/static/{index-a563ae6f.js → index-1c8194e0.js} +1 -1
- package/frontend/build/static/index-770afaee.css +1 -0
- package/frontend/build/static/{index-ade82986.js → index-9bb67f88.js} +1 -1
- package/frontend/build/static/index-9c528324.js +453 -0
- package/frontend/build/static/{is_dark-49e2e68f.js → is_dark-ba77f0b9.js} +1 -1
- package/frontend/build/static/{mindmap-definition-44684416-c6d3a96e.js → mindmap-definition-44684416-a4071c9f.js} +3 -3
- package/frontend/build/static/{timeline-definition-8e5a9bc6-920370f9.js → timeline-definition-8e5a9bc6-c996bf40.js} +2 -2
- package/frontend/build/static/{unknownify-30fed5e1.js → unknownify-db48ebae.js} +1 -1
- package/frontend/package.json +16 -16
- package/package.json +15 -13
- package/dist/lib/error/no-access-error.js.map +0 -1
- package/dist/lib/openapi/endpoint-descriptions.d.ts +0 -20
- package/dist/lib/openapi/endpoint-descriptions.js +0 -24
- package/dist/lib/openapi/endpoint-descriptions.js.map +0 -1
- package/dist/lib/openapi/spec/feedback-schema.d.ts +0 -24
- package/dist/lib/openapi/spec/feedback-schema.js +0 -26
- package/dist/lib/openapi/spec/feedback-schema.js.map +0 -1
- package/dist/lib/openapi/spec/splash-schema.d.ts +0 -20
- package/dist/lib/openapi/spec/splash-schema.js +0 -22
- package/dist/lib/openapi/spec/splash-schema.js.map +0 -1
- package/dist/lib/openapi/spec/upsert-strategy-schema.d.ts +0 -39
- package/dist/lib/openapi/spec/upsert-strategy-schema.js +0 -41
- package/dist/lib/openapi/spec/upsert-strategy-schema.js.map +0 -1
- package/frontend/build/static/AdvancedPlayground-bc3db7fd.js +0 -1
- package/frontend/build/static/CreateProject-4013b189.js +0 -4
- package/frontend/build/static/FeatureViewLazyExport-773303d1.js +0 -7
- package/frontend/build/static/LazyAdminExport-a9aeca56.js +0 -37
- package/frontend/build/static/LazyProjectExport-7c849a96.js +0 -13
- package/frontend/build/static/Playground-4fd4e26e.js +0 -1
- package/frontend/build/static/PlaygroundGuidancePopper-c761bfb7.js +0 -13
- package/frontend/build/static/RoleCell-cbb192fa.js +0 -1
- package/frontend/build/static/StrategyItemContainer-128fc163.js +0 -1
- package/frontend/build/static/demo-qr-1bebe2c9.png +0 -0
- package/frontend/build/static/index-66c635eb.css +0 -1
- package/frontend/build/static/index-bd571775.js +0 -450
- package/frontend/build/static/stringify-ec884b6d.js +0 -1
|
@@ -4,12 +4,17 @@ export declare const importTogglesSchema: {
|
|
|
4
4
|
readonly type: "object";
|
|
5
5
|
readonly required: readonly ["project", "environment", "data"];
|
|
6
6
|
readonly additionalProperties: false;
|
|
7
|
+
readonly description: "The result of the export operation for a project and environment, used at import";
|
|
7
8
|
readonly properties: {
|
|
8
9
|
readonly project: {
|
|
9
10
|
readonly type: "string";
|
|
11
|
+
readonly example: "My awesome project";
|
|
12
|
+
readonly description: "The exported [project](https://docs.getunleash.io/reference/projects)";
|
|
10
13
|
};
|
|
11
14
|
readonly environment: {
|
|
12
15
|
readonly type: "string";
|
|
16
|
+
readonly example: "development";
|
|
17
|
+
readonly description: "The exported [environment](https://docs.getunleash.io/reference/environments)";
|
|
13
18
|
};
|
|
14
19
|
readonly data: {
|
|
15
20
|
readonly $ref: "#/components/schemas/exportResultSchema";
|
|
@@ -21,40 +26,105 @@ export declare const importTogglesSchema: {
|
|
|
21
26
|
readonly $id: "#/components/schemas/exportResultSchema";
|
|
22
27
|
readonly type: "object";
|
|
23
28
|
readonly additionalProperties: false;
|
|
29
|
+
readonly description: "The result of the export operation, providing you with the feature toggle definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)";
|
|
24
30
|
readonly required: readonly ["features", "featureStrategies", "tagTypes"];
|
|
25
31
|
readonly properties: {
|
|
26
32
|
readonly features: {
|
|
27
33
|
readonly type: "array";
|
|
34
|
+
readonly description: "All the exported features.";
|
|
35
|
+
readonly example: readonly [{
|
|
36
|
+
readonly name: "my-feature";
|
|
37
|
+
readonly description: "best feature ever";
|
|
38
|
+
readonly type: "release";
|
|
39
|
+
readonly project: "default";
|
|
40
|
+
readonly stale: false;
|
|
41
|
+
readonly impressionData: false;
|
|
42
|
+
readonly archived: false;
|
|
43
|
+
}];
|
|
28
44
|
readonly items: {
|
|
29
45
|
readonly $ref: "#/components/schemas/featureSchema";
|
|
30
46
|
};
|
|
31
47
|
};
|
|
32
48
|
readonly featureStrategies: {
|
|
33
49
|
readonly type: "array";
|
|
50
|
+
readonly description: "All strategy instances that are used by the exported features in the `features` list.";
|
|
51
|
+
readonly example: readonly [{
|
|
52
|
+
readonly name: "flexibleRollout";
|
|
53
|
+
readonly id: "924974d7-8003-43ee-87eb-c5f887c06fd1";
|
|
54
|
+
readonly featureName: "my-feature";
|
|
55
|
+
readonly title: "Rollout 50%";
|
|
56
|
+
readonly parameters: {
|
|
57
|
+
readonly groupId: "default";
|
|
58
|
+
readonly rollout: "50";
|
|
59
|
+
readonly stickiness: "random";
|
|
60
|
+
};
|
|
61
|
+
readonly constraints: readonly [];
|
|
62
|
+
readonly disabled: false;
|
|
63
|
+
readonly segments: readonly [1];
|
|
64
|
+
}];
|
|
34
65
|
readonly items: {
|
|
35
66
|
readonly $ref: "#/components/schemas/featureStrategySchema";
|
|
36
67
|
};
|
|
37
68
|
};
|
|
38
69
|
readonly featureEnvironments: {
|
|
39
70
|
readonly type: "array";
|
|
71
|
+
readonly description: "Environment-specific configuration for all the features in the `features` list. Includes data such as whether the feature is enabled in the selected export environment, whether there are any variants assigned, etc.";
|
|
72
|
+
readonly example: readonly [{
|
|
73
|
+
readonly enabled: true;
|
|
74
|
+
readonly featureName: "my-feature";
|
|
75
|
+
readonly environment: "development";
|
|
76
|
+
readonly variants: readonly [{
|
|
77
|
+
readonly name: "a";
|
|
78
|
+
readonly weight: 500;
|
|
79
|
+
readonly overrides: readonly [];
|
|
80
|
+
readonly stickiness: "random";
|
|
81
|
+
readonly weightType: "variable";
|
|
82
|
+
}, {
|
|
83
|
+
readonly name: "b";
|
|
84
|
+
readonly weight: 500;
|
|
85
|
+
readonly overrides: readonly [];
|
|
86
|
+
readonly stickiness: "random";
|
|
87
|
+
readonly weightType: "variable";
|
|
88
|
+
}];
|
|
89
|
+
readonly name: "variant-testing";
|
|
90
|
+
}];
|
|
40
91
|
readonly items: {
|
|
41
92
|
readonly $ref: "#/components/schemas/featureEnvironmentSchema";
|
|
42
93
|
};
|
|
43
94
|
};
|
|
44
95
|
readonly contextFields: {
|
|
45
96
|
readonly type: "array";
|
|
97
|
+
readonly description: "A list of all the context fields that are in use by any of the strategies in the `featureStrategies` list.";
|
|
98
|
+
readonly example: readonly [{
|
|
99
|
+
readonly name: "appName";
|
|
100
|
+
readonly description: "Allows you to constrain on application name";
|
|
101
|
+
readonly stickiness: false;
|
|
102
|
+
readonly sortOrder: 2;
|
|
103
|
+
readonly legalValues: readonly [];
|
|
104
|
+
}];
|
|
46
105
|
readonly items: {
|
|
47
106
|
readonly $ref: "#/components/schemas/contextFieldSchema";
|
|
48
107
|
};
|
|
49
108
|
};
|
|
50
109
|
readonly featureTags: {
|
|
51
110
|
readonly type: "array";
|
|
111
|
+
readonly description: "A list of all the tags that have been applied to any of the features in the `features` list.";
|
|
112
|
+
readonly example: readonly [{
|
|
113
|
+
readonly featureName: "my-feature";
|
|
114
|
+
readonly tagType: "simple";
|
|
115
|
+
readonly tagValue: "user-facing";
|
|
116
|
+
}];
|
|
52
117
|
readonly items: {
|
|
53
118
|
readonly $ref: "#/components/schemas/featureTagSchema";
|
|
54
119
|
};
|
|
55
120
|
};
|
|
56
121
|
readonly segments: {
|
|
57
122
|
readonly type: "array";
|
|
123
|
+
readonly description: "A list of all the segments that are used by the strategies in the `featureStrategies` list.";
|
|
124
|
+
readonly example: readonly [{
|
|
125
|
+
readonly id: 1;
|
|
126
|
+
readonly name: "new-segment-name";
|
|
127
|
+
}];
|
|
58
128
|
readonly items: {
|
|
59
129
|
readonly type: "object";
|
|
60
130
|
readonly additionalProperties: false;
|
|
@@ -71,6 +141,12 @@ export declare const importTogglesSchema: {
|
|
|
71
141
|
};
|
|
72
142
|
readonly tagTypes: {
|
|
73
143
|
readonly type: "array";
|
|
144
|
+
readonly description: "A list of all of the tag types that are used in the `featureTags` list.";
|
|
145
|
+
readonly example: readonly [{
|
|
146
|
+
readonly name: "simple";
|
|
147
|
+
readonly description: "Used to simplify filtering of features";
|
|
148
|
+
readonly icon: "#";
|
|
149
|
+
}];
|
|
74
150
|
readonly items: {
|
|
75
151
|
readonly $ref: "#/components/schemas/tagTypeSchema";
|
|
76
152
|
};
|
|
@@ -83,6 +159,7 @@ export declare const importTogglesSchema: {
|
|
|
83
159
|
readonly type: "object";
|
|
84
160
|
readonly additionalProperties: false;
|
|
85
161
|
readonly required: readonly ["name"];
|
|
162
|
+
readonly description: "A feature toggle definition";
|
|
86
163
|
readonly properties: {
|
|
87
164
|
readonly name: {
|
|
88
165
|
readonly type: "string";
|
|
@@ -113,6 +190,7 @@ export declare const importTogglesSchema: {
|
|
|
113
190
|
readonly enabled: {
|
|
114
191
|
readonly type: "boolean";
|
|
115
192
|
readonly example: true;
|
|
193
|
+
readonly description: "`true` if the feature is enabled, otherwise `false`.";
|
|
116
194
|
};
|
|
117
195
|
readonly stale: {
|
|
118
196
|
readonly type: "boolean";
|
|
@@ -134,18 +212,21 @@ export declare const importTogglesSchema: {
|
|
|
134
212
|
readonly format: "date-time";
|
|
135
213
|
readonly nullable: true;
|
|
136
214
|
readonly example: "2023-01-28T15:21:39.975Z";
|
|
215
|
+
readonly description: "The date the feature was created";
|
|
137
216
|
};
|
|
138
217
|
readonly archivedAt: {
|
|
139
218
|
readonly type: "string";
|
|
140
219
|
readonly format: "date-time";
|
|
141
220
|
readonly nullable: true;
|
|
142
221
|
readonly example: "2023-01-29T15:21:39.975Z";
|
|
222
|
+
readonly description: "The date the feature was archived";
|
|
143
223
|
};
|
|
144
224
|
readonly lastSeenAt: {
|
|
145
225
|
readonly type: "string";
|
|
146
226
|
readonly format: "date-time";
|
|
147
227
|
readonly nullable: true;
|
|
148
228
|
readonly example: "2023-01-28T16:21:39.975Z";
|
|
229
|
+
readonly description: "The date when metrics where last collected for the feature";
|
|
149
230
|
};
|
|
150
231
|
readonly environments: {
|
|
151
232
|
readonly type: "array";
|
|
@@ -240,9 +321,12 @@ export declare const importTogglesSchema: {
|
|
|
240
321
|
readonly featureName: {
|
|
241
322
|
readonly type: "string";
|
|
242
323
|
readonly example: "disable-comments";
|
|
324
|
+
readonly description: "The name of the feature";
|
|
243
325
|
};
|
|
244
326
|
readonly environment: {
|
|
245
327
|
readonly type: "string";
|
|
328
|
+
readonly example: "development";
|
|
329
|
+
readonly description: "The name of the environment";
|
|
246
330
|
};
|
|
247
331
|
readonly type: {
|
|
248
332
|
readonly type: "string";
|
|
@@ -261,6 +345,7 @@ export declare const importTogglesSchema: {
|
|
|
261
345
|
};
|
|
262
346
|
readonly variantCount: {
|
|
263
347
|
readonly type: "number";
|
|
348
|
+
readonly description: "The number of defined variants";
|
|
264
349
|
};
|
|
265
350
|
readonly strategies: {
|
|
266
351
|
readonly type: "array";
|
|
@@ -326,6 +411,7 @@ export declare const importTogglesSchema: {
|
|
|
326
411
|
readonly parametersSchema: {
|
|
327
412
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
328
413
|
readonly type: "object";
|
|
414
|
+
readonly description: "A list of parameters for a strategy";
|
|
329
415
|
readonly additionalProperties: {
|
|
330
416
|
readonly type: "string";
|
|
331
417
|
};
|
|
@@ -380,11 +466,18 @@ export declare const importTogglesSchema: {
|
|
|
380
466
|
};
|
|
381
467
|
readonly constraints: {
|
|
382
468
|
readonly type: "array";
|
|
383
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
469
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
384
470
|
readonly items: {
|
|
385
471
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
386
472
|
};
|
|
387
473
|
};
|
|
474
|
+
readonly variants: {
|
|
475
|
+
readonly type: "array";
|
|
476
|
+
readonly description: "Strategy level variants";
|
|
477
|
+
readonly items: {
|
|
478
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
479
|
+
};
|
|
480
|
+
};
|
|
388
481
|
readonly parameters: {
|
|
389
482
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
390
483
|
};
|
|
@@ -438,13 +531,118 @@ export declare const importTogglesSchema: {
|
|
|
438
531
|
readonly parametersSchema: {
|
|
439
532
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
440
533
|
readonly type: "object";
|
|
534
|
+
readonly description: "A list of parameters for a strategy";
|
|
441
535
|
readonly additionalProperties: {
|
|
442
536
|
readonly type: "string";
|
|
443
537
|
};
|
|
444
538
|
readonly components: {};
|
|
445
539
|
};
|
|
540
|
+
readonly strategyVariantSchema: {
|
|
541
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
542
|
+
readonly type: "object";
|
|
543
|
+
readonly additionalProperties: false;
|
|
544
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
545
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
546
|
+
readonly properties: {
|
|
547
|
+
readonly name: {
|
|
548
|
+
readonly type: "string";
|
|
549
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
550
|
+
readonly example: "blue_group";
|
|
551
|
+
};
|
|
552
|
+
readonly weight: {
|
|
553
|
+
readonly type: "integer";
|
|
554
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
555
|
+
readonly minimum: 0;
|
|
556
|
+
readonly maximum: 1000;
|
|
557
|
+
};
|
|
558
|
+
readonly weightType: {
|
|
559
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
560
|
+
readonly type: "string";
|
|
561
|
+
readonly example: "fix";
|
|
562
|
+
readonly enum: readonly ["variable", "fix"];
|
|
563
|
+
};
|
|
564
|
+
readonly stickiness: {
|
|
565
|
+
readonly type: "string";
|
|
566
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
567
|
+
readonly example: "custom.context.field";
|
|
568
|
+
};
|
|
569
|
+
readonly payload: {
|
|
570
|
+
readonly type: "object";
|
|
571
|
+
readonly required: readonly ["type", "value"];
|
|
572
|
+
readonly description: "Extra data configured for this variant";
|
|
573
|
+
readonly properties: {
|
|
574
|
+
readonly type: {
|
|
575
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
576
|
+
readonly type: "string";
|
|
577
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
578
|
+
};
|
|
579
|
+
readonly value: {
|
|
580
|
+
readonly description: "The actual value of payload";
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
};
|
|
583
|
+
};
|
|
584
|
+
readonly example: {
|
|
585
|
+
readonly type: "json";
|
|
586
|
+
readonly value: "{\"color\": \"red\"}";
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
readonly components: {};
|
|
591
|
+
};
|
|
592
|
+
};
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
readonly strategyVariantSchema: {
|
|
596
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
597
|
+
readonly type: "object";
|
|
598
|
+
readonly additionalProperties: false;
|
|
599
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
600
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
601
|
+
readonly properties: {
|
|
602
|
+
readonly name: {
|
|
603
|
+
readonly type: "string";
|
|
604
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
605
|
+
readonly example: "blue_group";
|
|
606
|
+
};
|
|
607
|
+
readonly weight: {
|
|
608
|
+
readonly type: "integer";
|
|
609
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
610
|
+
readonly minimum: 0;
|
|
611
|
+
readonly maximum: 1000;
|
|
612
|
+
};
|
|
613
|
+
readonly weightType: {
|
|
614
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
615
|
+
readonly type: "string";
|
|
616
|
+
readonly example: "fix";
|
|
617
|
+
readonly enum: readonly ["variable", "fix"];
|
|
618
|
+
};
|
|
619
|
+
readonly stickiness: {
|
|
620
|
+
readonly type: "string";
|
|
621
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
622
|
+
readonly example: "custom.context.field";
|
|
623
|
+
};
|
|
624
|
+
readonly payload: {
|
|
625
|
+
readonly type: "object";
|
|
626
|
+
readonly required: readonly ["type", "value"];
|
|
627
|
+
readonly description: "Extra data configured for this variant";
|
|
628
|
+
readonly properties: {
|
|
629
|
+
readonly type: {
|
|
630
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
631
|
+
readonly type: "string";
|
|
632
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
633
|
+
};
|
|
634
|
+
readonly value: {
|
|
635
|
+
readonly description: "The actual value of payload";
|
|
636
|
+
readonly type: "string";
|
|
637
|
+
};
|
|
638
|
+
};
|
|
639
|
+
readonly example: {
|
|
640
|
+
readonly type: "json";
|
|
641
|
+
readonly value: "{\"color\": \"red\"}";
|
|
642
|
+
};
|
|
446
643
|
};
|
|
447
644
|
};
|
|
645
|
+
readonly components: {};
|
|
448
646
|
};
|
|
449
647
|
readonly variantSchema: {
|
|
450
648
|
readonly $id: "#/components/schemas/variantSchema";
|
|
@@ -467,7 +665,8 @@ export declare const importTogglesSchema: {
|
|
|
467
665
|
readonly weightType: {
|
|
468
666
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
469
667
|
readonly type: "string";
|
|
470
|
-
readonly example: "
|
|
668
|
+
readonly example: "variable";
|
|
669
|
+
readonly enum: readonly ["variable", "fix"];
|
|
471
670
|
};
|
|
472
671
|
readonly stickiness: {
|
|
473
672
|
readonly type: "string";
|
|
@@ -478,17 +677,21 @@ export declare const importTogglesSchema: {
|
|
|
478
677
|
readonly type: "object";
|
|
479
678
|
readonly required: readonly ["type", "value"];
|
|
480
679
|
readonly description: "Extra data configured for this variant";
|
|
680
|
+
readonly additionalProperties: false;
|
|
481
681
|
readonly properties: {
|
|
482
682
|
readonly type: {
|
|
683
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
483
684
|
readonly type: "string";
|
|
685
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
484
686
|
};
|
|
485
687
|
readonly value: {
|
|
688
|
+
readonly description: "The actual value of payload";
|
|
486
689
|
readonly type: "string";
|
|
487
690
|
};
|
|
488
691
|
};
|
|
489
692
|
readonly example: {
|
|
490
693
|
readonly type: "json";
|
|
491
|
-
readonly value: "{color: red}";
|
|
694
|
+
readonly value: "{\"color\": \"red\"}";
|
|
492
695
|
};
|
|
493
696
|
};
|
|
494
697
|
readonly overrides: {
|
|
@@ -579,11 +782,18 @@ export declare const importTogglesSchema: {
|
|
|
579
782
|
};
|
|
580
783
|
readonly constraints: {
|
|
581
784
|
readonly type: "array";
|
|
582
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
785
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
583
786
|
readonly items: {
|
|
584
787
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
585
788
|
};
|
|
586
789
|
};
|
|
790
|
+
readonly variants: {
|
|
791
|
+
readonly type: "array";
|
|
792
|
+
readonly description: "Strategy level variants";
|
|
793
|
+
readonly items: {
|
|
794
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
795
|
+
};
|
|
796
|
+
};
|
|
587
797
|
readonly parameters: {
|
|
588
798
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
589
799
|
};
|
|
@@ -637,13 +847,118 @@ export declare const importTogglesSchema: {
|
|
|
637
847
|
readonly parametersSchema: {
|
|
638
848
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
639
849
|
readonly type: "object";
|
|
850
|
+
readonly description: "A list of parameters for a strategy";
|
|
640
851
|
readonly additionalProperties: {
|
|
641
852
|
readonly type: "string";
|
|
642
853
|
};
|
|
643
854
|
readonly components: {};
|
|
644
855
|
};
|
|
856
|
+
readonly strategyVariantSchema: {
|
|
857
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
858
|
+
readonly type: "object";
|
|
859
|
+
readonly additionalProperties: false;
|
|
860
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
861
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
862
|
+
readonly properties: {
|
|
863
|
+
readonly name: {
|
|
864
|
+
readonly type: "string";
|
|
865
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
866
|
+
readonly example: "blue_group";
|
|
867
|
+
};
|
|
868
|
+
readonly weight: {
|
|
869
|
+
readonly type: "integer";
|
|
870
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
871
|
+
readonly minimum: 0;
|
|
872
|
+
readonly maximum: 1000;
|
|
873
|
+
};
|
|
874
|
+
readonly weightType: {
|
|
875
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
876
|
+
readonly type: "string";
|
|
877
|
+
readonly example: "fix";
|
|
878
|
+
readonly enum: readonly ["variable", "fix"];
|
|
879
|
+
};
|
|
880
|
+
readonly stickiness: {
|
|
881
|
+
readonly type: "string";
|
|
882
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
883
|
+
readonly example: "custom.context.field";
|
|
884
|
+
};
|
|
885
|
+
readonly payload: {
|
|
886
|
+
readonly type: "object";
|
|
887
|
+
readonly required: readonly ["type", "value"];
|
|
888
|
+
readonly description: "Extra data configured for this variant";
|
|
889
|
+
readonly properties: {
|
|
890
|
+
readonly type: {
|
|
891
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
892
|
+
readonly type: "string";
|
|
893
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
894
|
+
};
|
|
895
|
+
readonly value: {
|
|
896
|
+
readonly description: "The actual value of payload";
|
|
897
|
+
readonly type: "string";
|
|
898
|
+
};
|
|
899
|
+
};
|
|
900
|
+
readonly example: {
|
|
901
|
+
readonly type: "json";
|
|
902
|
+
readonly value: "{\"color\": \"red\"}";
|
|
903
|
+
};
|
|
904
|
+
};
|
|
905
|
+
};
|
|
906
|
+
readonly components: {};
|
|
907
|
+
};
|
|
908
|
+
};
|
|
909
|
+
};
|
|
910
|
+
};
|
|
911
|
+
readonly strategyVariantSchema: {
|
|
912
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
913
|
+
readonly type: "object";
|
|
914
|
+
readonly additionalProperties: false;
|
|
915
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
916
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
917
|
+
readonly properties: {
|
|
918
|
+
readonly name: {
|
|
919
|
+
readonly type: "string";
|
|
920
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
921
|
+
readonly example: "blue_group";
|
|
922
|
+
};
|
|
923
|
+
readonly weight: {
|
|
924
|
+
readonly type: "integer";
|
|
925
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
926
|
+
readonly minimum: 0;
|
|
927
|
+
readonly maximum: 1000;
|
|
928
|
+
};
|
|
929
|
+
readonly weightType: {
|
|
930
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
931
|
+
readonly type: "string";
|
|
932
|
+
readonly example: "fix";
|
|
933
|
+
readonly enum: readonly ["variable", "fix"];
|
|
934
|
+
};
|
|
935
|
+
readonly stickiness: {
|
|
936
|
+
readonly type: "string";
|
|
937
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
938
|
+
readonly example: "custom.context.field";
|
|
939
|
+
};
|
|
940
|
+
readonly payload: {
|
|
941
|
+
readonly type: "object";
|
|
942
|
+
readonly required: readonly ["type", "value"];
|
|
943
|
+
readonly description: "Extra data configured for this variant";
|
|
944
|
+
readonly properties: {
|
|
945
|
+
readonly type: {
|
|
946
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
947
|
+
readonly type: "string";
|
|
948
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
949
|
+
};
|
|
950
|
+
readonly value: {
|
|
951
|
+
readonly description: "The actual value of payload";
|
|
952
|
+
readonly type: "string";
|
|
953
|
+
};
|
|
954
|
+
};
|
|
955
|
+
readonly example: {
|
|
956
|
+
readonly type: "json";
|
|
957
|
+
readonly value: "{\"color\": \"red\"}";
|
|
958
|
+
};
|
|
645
959
|
};
|
|
646
960
|
};
|
|
961
|
+
readonly components: {};
|
|
647
962
|
};
|
|
648
963
|
readonly overrideSchema: {
|
|
649
964
|
readonly $id: "#/components/schemas/overrideSchema";
|
|
@@ -671,6 +986,7 @@ export declare const importTogglesSchema: {
|
|
|
671
986
|
readonly parametersSchema: {
|
|
672
987
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
673
988
|
readonly type: "object";
|
|
989
|
+
readonly description: "A list of parameters for a strategy";
|
|
674
990
|
readonly additionalProperties: {
|
|
675
991
|
readonly type: "string";
|
|
676
992
|
};
|
|
@@ -697,7 +1013,8 @@ export declare const importTogglesSchema: {
|
|
|
697
1013
|
readonly weightType: {
|
|
698
1014
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
699
1015
|
readonly type: "string";
|
|
700
|
-
readonly example: "
|
|
1016
|
+
readonly example: "variable";
|
|
1017
|
+
readonly enum: readonly ["variable", "fix"];
|
|
701
1018
|
};
|
|
702
1019
|
readonly stickiness: {
|
|
703
1020
|
readonly type: "string";
|
|
@@ -708,17 +1025,21 @@ export declare const importTogglesSchema: {
|
|
|
708
1025
|
readonly type: "object";
|
|
709
1026
|
readonly required: readonly ["type", "value"];
|
|
710
1027
|
readonly description: "Extra data configured for this variant";
|
|
1028
|
+
readonly additionalProperties: false;
|
|
711
1029
|
readonly properties: {
|
|
712
1030
|
readonly type: {
|
|
1031
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
713
1032
|
readonly type: "string";
|
|
1033
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
714
1034
|
};
|
|
715
1035
|
readonly value: {
|
|
1036
|
+
readonly description: "The actual value of payload";
|
|
716
1037
|
readonly type: "string";
|
|
717
1038
|
};
|
|
718
1039
|
};
|
|
719
1040
|
readonly example: {
|
|
720
1041
|
readonly type: "json";
|
|
721
|
-
readonly value: "{color: red}";
|
|
1042
|
+
readonly value: "{\"color\": \"red\"}";
|
|
722
1043
|
};
|
|
723
1044
|
};
|
|
724
1045
|
readonly overrides: {
|
|
@@ -834,11 +1155,18 @@ export declare const importTogglesSchema: {
|
|
|
834
1155
|
};
|
|
835
1156
|
readonly constraints: {
|
|
836
1157
|
readonly type: "array";
|
|
837
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
1158
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
838
1159
|
readonly items: {
|
|
839
1160
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
840
1161
|
};
|
|
841
1162
|
};
|
|
1163
|
+
readonly variants: {
|
|
1164
|
+
readonly type: "array";
|
|
1165
|
+
readonly description: "Strategy level variants";
|
|
1166
|
+
readonly items: {
|
|
1167
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
1168
|
+
};
|
|
1169
|
+
};
|
|
842
1170
|
readonly parameters: {
|
|
843
1171
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
844
1172
|
};
|
|
@@ -892,13 +1220,118 @@ export declare const importTogglesSchema: {
|
|
|
892
1220
|
readonly parametersSchema: {
|
|
893
1221
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
894
1222
|
readonly type: "object";
|
|
1223
|
+
readonly description: "A list of parameters for a strategy";
|
|
895
1224
|
readonly additionalProperties: {
|
|
896
1225
|
readonly type: "string";
|
|
897
1226
|
};
|
|
898
1227
|
readonly components: {};
|
|
899
1228
|
};
|
|
1229
|
+
readonly strategyVariantSchema: {
|
|
1230
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
1231
|
+
readonly type: "object";
|
|
1232
|
+
readonly additionalProperties: false;
|
|
1233
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
1234
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
1235
|
+
readonly properties: {
|
|
1236
|
+
readonly name: {
|
|
1237
|
+
readonly type: "string";
|
|
1238
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
1239
|
+
readonly example: "blue_group";
|
|
1240
|
+
};
|
|
1241
|
+
readonly weight: {
|
|
1242
|
+
readonly type: "integer";
|
|
1243
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
1244
|
+
readonly minimum: 0;
|
|
1245
|
+
readonly maximum: 1000;
|
|
1246
|
+
};
|
|
1247
|
+
readonly weightType: {
|
|
1248
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
1249
|
+
readonly type: "string";
|
|
1250
|
+
readonly example: "fix";
|
|
1251
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1252
|
+
};
|
|
1253
|
+
readonly stickiness: {
|
|
1254
|
+
readonly type: "string";
|
|
1255
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
1256
|
+
readonly example: "custom.context.field";
|
|
1257
|
+
};
|
|
1258
|
+
readonly payload: {
|
|
1259
|
+
readonly type: "object";
|
|
1260
|
+
readonly required: readonly ["type", "value"];
|
|
1261
|
+
readonly description: "Extra data configured for this variant";
|
|
1262
|
+
readonly properties: {
|
|
1263
|
+
readonly type: {
|
|
1264
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1265
|
+
readonly type: "string";
|
|
1266
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1267
|
+
};
|
|
1268
|
+
readonly value: {
|
|
1269
|
+
readonly description: "The actual value of payload";
|
|
1270
|
+
readonly type: "string";
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
readonly example: {
|
|
1274
|
+
readonly type: "json";
|
|
1275
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
};
|
|
1279
|
+
readonly components: {};
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
readonly strategyVariantSchema: {
|
|
1285
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
1286
|
+
readonly type: "object";
|
|
1287
|
+
readonly additionalProperties: false;
|
|
1288
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
1289
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
1290
|
+
readonly properties: {
|
|
1291
|
+
readonly name: {
|
|
1292
|
+
readonly type: "string";
|
|
1293
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
1294
|
+
readonly example: "blue_group";
|
|
1295
|
+
};
|
|
1296
|
+
readonly weight: {
|
|
1297
|
+
readonly type: "integer";
|
|
1298
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
1299
|
+
readonly minimum: 0;
|
|
1300
|
+
readonly maximum: 1000;
|
|
1301
|
+
};
|
|
1302
|
+
readonly weightType: {
|
|
1303
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
1304
|
+
readonly type: "string";
|
|
1305
|
+
readonly example: "fix";
|
|
1306
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1307
|
+
};
|
|
1308
|
+
readonly stickiness: {
|
|
1309
|
+
readonly type: "string";
|
|
1310
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
1311
|
+
readonly example: "custom.context.field";
|
|
1312
|
+
};
|
|
1313
|
+
readonly payload: {
|
|
1314
|
+
readonly type: "object";
|
|
1315
|
+
readonly required: readonly ["type", "value"];
|
|
1316
|
+
readonly description: "Extra data configured for this variant";
|
|
1317
|
+
readonly properties: {
|
|
1318
|
+
readonly type: {
|
|
1319
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1320
|
+
readonly type: "string";
|
|
1321
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1322
|
+
};
|
|
1323
|
+
readonly value: {
|
|
1324
|
+
readonly description: "The actual value of payload";
|
|
1325
|
+
readonly type: "string";
|
|
1326
|
+
};
|
|
1327
|
+
};
|
|
1328
|
+
readonly example: {
|
|
1329
|
+
readonly type: "json";
|
|
1330
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1331
|
+
};
|
|
900
1332
|
};
|
|
901
1333
|
};
|
|
1334
|
+
readonly components: {};
|
|
902
1335
|
};
|
|
903
1336
|
readonly featureEnvironmentSchema: {
|
|
904
1337
|
readonly $id: "#/components/schemas/featureEnvironmentSchema";
|
|
@@ -915,9 +1348,12 @@ export declare const importTogglesSchema: {
|
|
|
915
1348
|
readonly featureName: {
|
|
916
1349
|
readonly type: "string";
|
|
917
1350
|
readonly example: "disable-comments";
|
|
1351
|
+
readonly description: "The name of the feature";
|
|
918
1352
|
};
|
|
919
1353
|
readonly environment: {
|
|
920
1354
|
readonly type: "string";
|
|
1355
|
+
readonly example: "development";
|
|
1356
|
+
readonly description: "The name of the environment";
|
|
921
1357
|
};
|
|
922
1358
|
readonly type: {
|
|
923
1359
|
readonly type: "string";
|
|
@@ -936,6 +1372,7 @@ export declare const importTogglesSchema: {
|
|
|
936
1372
|
};
|
|
937
1373
|
readonly variantCount: {
|
|
938
1374
|
readonly type: "number";
|
|
1375
|
+
readonly description: "The number of defined variants";
|
|
939
1376
|
};
|
|
940
1377
|
readonly strategies: {
|
|
941
1378
|
readonly type: "array";
|
|
@@ -1001,6 +1438,7 @@ export declare const importTogglesSchema: {
|
|
|
1001
1438
|
readonly parametersSchema: {
|
|
1002
1439
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
1003
1440
|
readonly type: "object";
|
|
1441
|
+
readonly description: "A list of parameters for a strategy";
|
|
1004
1442
|
readonly additionalProperties: {
|
|
1005
1443
|
readonly type: "string";
|
|
1006
1444
|
};
|
|
@@ -1055,11 +1493,18 @@ export declare const importTogglesSchema: {
|
|
|
1055
1493
|
};
|
|
1056
1494
|
readonly constraints: {
|
|
1057
1495
|
readonly type: "array";
|
|
1058
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
1496
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
1059
1497
|
readonly items: {
|
|
1060
1498
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
1061
1499
|
};
|
|
1062
1500
|
};
|
|
1501
|
+
readonly variants: {
|
|
1502
|
+
readonly type: "array";
|
|
1503
|
+
readonly description: "Strategy level variants";
|
|
1504
|
+
readonly items: {
|
|
1505
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
1506
|
+
};
|
|
1507
|
+
};
|
|
1063
1508
|
readonly parameters: {
|
|
1064
1509
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
1065
1510
|
};
|
|
@@ -1113,36 +1558,142 @@ export declare const importTogglesSchema: {
|
|
|
1113
1558
|
readonly parametersSchema: {
|
|
1114
1559
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
1115
1560
|
readonly type: "object";
|
|
1561
|
+
readonly description: "A list of parameters for a strategy";
|
|
1116
1562
|
readonly additionalProperties: {
|
|
1117
1563
|
readonly type: "string";
|
|
1118
1564
|
};
|
|
1119
1565
|
readonly components: {};
|
|
1120
1566
|
};
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1567
|
+
readonly strategyVariantSchema: {
|
|
1568
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
1569
|
+
readonly type: "object";
|
|
1570
|
+
readonly additionalProperties: false;
|
|
1571
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
1572
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
1573
|
+
readonly properties: {
|
|
1574
|
+
readonly name: {
|
|
1575
|
+
readonly type: "string";
|
|
1576
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
1577
|
+
readonly example: "blue_group";
|
|
1578
|
+
};
|
|
1579
|
+
readonly weight: {
|
|
1580
|
+
readonly type: "integer";
|
|
1581
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
1582
|
+
readonly minimum: 0;
|
|
1583
|
+
readonly maximum: 1000;
|
|
1584
|
+
};
|
|
1585
|
+
readonly weightType: {
|
|
1586
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
1587
|
+
readonly type: "string";
|
|
1588
|
+
readonly example: "fix";
|
|
1589
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1590
|
+
};
|
|
1591
|
+
readonly stickiness: {
|
|
1592
|
+
readonly type: "string";
|
|
1593
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
1594
|
+
readonly example: "custom.context.field";
|
|
1595
|
+
};
|
|
1596
|
+
readonly payload: {
|
|
1597
|
+
readonly type: "object";
|
|
1598
|
+
readonly required: readonly ["type", "value"];
|
|
1599
|
+
readonly description: "Extra data configured for this variant";
|
|
1600
|
+
readonly properties: {
|
|
1601
|
+
readonly type: {
|
|
1602
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1603
|
+
readonly type: "string";
|
|
1604
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1605
|
+
};
|
|
1606
|
+
readonly value: {
|
|
1607
|
+
readonly description: "The actual value of payload";
|
|
1608
|
+
readonly type: "string";
|
|
1609
|
+
};
|
|
1610
|
+
};
|
|
1611
|
+
readonly example: {
|
|
1612
|
+
readonly type: "json";
|
|
1613
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1614
|
+
};
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
readonly components: {};
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
};
|
|
1622
|
+
readonly strategyVariantSchema: {
|
|
1623
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
1624
|
+
readonly type: "object";
|
|
1625
|
+
readonly additionalProperties: false;
|
|
1626
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
1627
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
1628
|
+
readonly properties: {
|
|
1629
|
+
readonly name: {
|
|
1630
|
+
readonly type: "string";
|
|
1631
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
1632
|
+
readonly example: "blue_group";
|
|
1633
|
+
};
|
|
1634
|
+
readonly weight: {
|
|
1635
|
+
readonly type: "integer";
|
|
1636
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
1637
|
+
readonly minimum: 0;
|
|
1638
|
+
readonly maximum: 1000;
|
|
1639
|
+
};
|
|
1640
|
+
readonly weightType: {
|
|
1641
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
1642
|
+
readonly type: "string";
|
|
1145
1643
|
readonly example: "fix";
|
|
1644
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1645
|
+
};
|
|
1646
|
+
readonly stickiness: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
1649
|
+
readonly example: "custom.context.field";
|
|
1650
|
+
};
|
|
1651
|
+
readonly payload: {
|
|
1652
|
+
readonly type: "object";
|
|
1653
|
+
readonly required: readonly ["type", "value"];
|
|
1654
|
+
readonly description: "Extra data configured for this variant";
|
|
1655
|
+
readonly properties: {
|
|
1656
|
+
readonly type: {
|
|
1657
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1658
|
+
readonly type: "string";
|
|
1659
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1660
|
+
};
|
|
1661
|
+
readonly value: {
|
|
1662
|
+
readonly description: "The actual value of payload";
|
|
1663
|
+
readonly type: "string";
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
readonly example: {
|
|
1667
|
+
readonly type: "json";
|
|
1668
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
readonly components: {};
|
|
1673
|
+
};
|
|
1674
|
+
readonly variantSchema: {
|
|
1675
|
+
readonly $id: "#/components/schemas/variantSchema";
|
|
1676
|
+
readonly type: "object";
|
|
1677
|
+
readonly additionalProperties: false;
|
|
1678
|
+
readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
|
|
1679
|
+
readonly required: readonly ["name", "weight"];
|
|
1680
|
+
readonly properties: {
|
|
1681
|
+
readonly name: {
|
|
1682
|
+
readonly type: "string";
|
|
1683
|
+
readonly description: "The variants name. Is unique for this feature toggle";
|
|
1684
|
+
readonly example: "blue_group";
|
|
1685
|
+
};
|
|
1686
|
+
readonly weight: {
|
|
1687
|
+
readonly type: "number";
|
|
1688
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
1689
|
+
readonly minimum: 0;
|
|
1690
|
+
readonly maximum: 1000;
|
|
1691
|
+
};
|
|
1692
|
+
readonly weightType: {
|
|
1693
|
+
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
1694
|
+
readonly type: "string";
|
|
1695
|
+
readonly example: "variable";
|
|
1696
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1146
1697
|
};
|
|
1147
1698
|
readonly stickiness: {
|
|
1148
1699
|
readonly type: "string";
|
|
@@ -1153,17 +1704,21 @@ export declare const importTogglesSchema: {
|
|
|
1153
1704
|
readonly type: "object";
|
|
1154
1705
|
readonly required: readonly ["type", "value"];
|
|
1155
1706
|
readonly description: "Extra data configured for this variant";
|
|
1707
|
+
readonly additionalProperties: false;
|
|
1156
1708
|
readonly properties: {
|
|
1157
1709
|
readonly type: {
|
|
1710
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1158
1711
|
readonly type: "string";
|
|
1712
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1159
1713
|
};
|
|
1160
1714
|
readonly value: {
|
|
1715
|
+
readonly description: "The actual value of payload";
|
|
1161
1716
|
readonly type: "string";
|
|
1162
1717
|
};
|
|
1163
1718
|
};
|
|
1164
1719
|
readonly example: {
|
|
1165
1720
|
readonly type: "json";
|
|
1166
|
-
readonly value: "{color: red}";
|
|
1721
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1167
1722
|
};
|
|
1168
1723
|
};
|
|
1169
1724
|
readonly overrides: {
|
|
@@ -1209,39 +1764,53 @@ export declare const importTogglesSchema: {
|
|
|
1209
1764
|
readonly $id: "#/components/schemas/contextFieldSchema";
|
|
1210
1765
|
readonly type: "object";
|
|
1211
1766
|
readonly additionalProperties: false;
|
|
1767
|
+
readonly description: "A representation of a [context field](https://docs.getunleash.io/reference/unleash-context).";
|
|
1212
1768
|
readonly required: readonly ["name"];
|
|
1213
1769
|
readonly properties: {
|
|
1214
1770
|
readonly name: {
|
|
1771
|
+
readonly description: "The name of the context field";
|
|
1215
1772
|
readonly type: "string";
|
|
1773
|
+
readonly example: "userId";
|
|
1216
1774
|
};
|
|
1217
1775
|
readonly description: {
|
|
1776
|
+
readonly description: "The description of the context field.";
|
|
1218
1777
|
readonly type: "string";
|
|
1219
1778
|
readonly nullable: true;
|
|
1779
|
+
readonly example: "Used to uniquely identify users";
|
|
1220
1780
|
};
|
|
1221
1781
|
readonly stickiness: {
|
|
1782
|
+
readonly description: "Does this context field support being used for [stickiness](https://docs.getunleash.io/reference/stickiness) calculations";
|
|
1222
1783
|
readonly type: "boolean";
|
|
1784
|
+
readonly example: true;
|
|
1223
1785
|
};
|
|
1224
1786
|
readonly sortOrder: {
|
|
1225
|
-
readonly
|
|
1787
|
+
readonly description: "Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.";
|
|
1788
|
+
readonly type: "integer";
|
|
1789
|
+
readonly example: 900;
|
|
1226
1790
|
};
|
|
1227
1791
|
readonly createdAt: {
|
|
1792
|
+
readonly description: "When this context field was created";
|
|
1228
1793
|
readonly type: "string";
|
|
1229
1794
|
readonly format: "date-time";
|
|
1230
1795
|
readonly nullable: true;
|
|
1796
|
+
readonly example: "2023-06-29T10:19:00.000Z";
|
|
1231
1797
|
};
|
|
1232
1798
|
readonly usedInFeatures: {
|
|
1233
|
-
readonly type: "
|
|
1799
|
+
readonly type: "integer";
|
|
1234
1800
|
readonly description: "Number of projects where this context field is used in";
|
|
1235
1801
|
readonly example: 3;
|
|
1236
1802
|
readonly nullable: true;
|
|
1803
|
+
readonly minimum: 0;
|
|
1237
1804
|
};
|
|
1238
1805
|
readonly usedInProjects: {
|
|
1239
|
-
readonly type: "
|
|
1806
|
+
readonly type: "integer";
|
|
1240
1807
|
readonly description: "Number of projects where this context field is used in";
|
|
1241
1808
|
readonly example: 2;
|
|
1242
1809
|
readonly nullable: true;
|
|
1810
|
+
readonly minimum: 0;
|
|
1243
1811
|
};
|
|
1244
1812
|
readonly legalValues: {
|
|
1813
|
+
readonly description: "Allowed values for this context field schema. Can be used to narrow down accepted input";
|
|
1245
1814
|
readonly type: "array";
|
|
1246
1815
|
readonly items: {
|
|
1247
1816
|
readonly $ref: "#/components/schemas/legalValueSchema";
|
|
@@ -1254,13 +1823,18 @@ export declare const importTogglesSchema: {
|
|
|
1254
1823
|
readonly $id: "#/components/schemas/legalValueSchema";
|
|
1255
1824
|
readonly type: "object";
|
|
1256
1825
|
readonly additionalProperties: false;
|
|
1826
|
+
readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
|
|
1257
1827
|
readonly required: readonly ["value"];
|
|
1258
1828
|
readonly properties: {
|
|
1259
1829
|
readonly value: {
|
|
1830
|
+
readonly description: "The valid value";
|
|
1260
1831
|
readonly type: "string";
|
|
1832
|
+
readonly example: "#c154c1";
|
|
1261
1833
|
};
|
|
1262
1834
|
readonly description: {
|
|
1835
|
+
readonly description: "Describes this specific legal value";
|
|
1263
1836
|
readonly type: "string";
|
|
1837
|
+
readonly example: "Deep fuchsia";
|
|
1264
1838
|
};
|
|
1265
1839
|
};
|
|
1266
1840
|
readonly components: {};
|
|
@@ -1332,7 +1906,8 @@ export declare const importTogglesSchema: {
|
|
|
1332
1906
|
readonly weightType: {
|
|
1333
1907
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
1334
1908
|
readonly type: "string";
|
|
1335
|
-
readonly example: "
|
|
1909
|
+
readonly example: "variable";
|
|
1910
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1336
1911
|
};
|
|
1337
1912
|
readonly stickiness: {
|
|
1338
1913
|
readonly type: "string";
|
|
@@ -1343,17 +1918,21 @@ export declare const importTogglesSchema: {
|
|
|
1343
1918
|
readonly type: "object";
|
|
1344
1919
|
readonly required: readonly ["type", "value"];
|
|
1345
1920
|
readonly description: "Extra data configured for this variant";
|
|
1921
|
+
readonly additionalProperties: false;
|
|
1346
1922
|
readonly properties: {
|
|
1347
1923
|
readonly type: {
|
|
1924
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1348
1925
|
readonly type: "string";
|
|
1926
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1349
1927
|
};
|
|
1350
1928
|
readonly value: {
|
|
1929
|
+
readonly description: "The actual value of payload";
|
|
1351
1930
|
readonly type: "string";
|
|
1352
1931
|
};
|
|
1353
1932
|
};
|
|
1354
1933
|
readonly example: {
|
|
1355
1934
|
readonly type: "json";
|
|
1356
|
-
readonly value: "{color: red}";
|
|
1935
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1357
1936
|
};
|
|
1358
1937
|
};
|
|
1359
1938
|
readonly overrides: {
|
|
@@ -1439,7 +2018,8 @@ export declare const importTogglesSchema: {
|
|
|
1439
2018
|
readonly weightType: {
|
|
1440
2019
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
1441
2020
|
readonly type: "string";
|
|
1442
|
-
readonly example: "
|
|
2021
|
+
readonly example: "variable";
|
|
2022
|
+
readonly enum: readonly ["variable", "fix"];
|
|
1443
2023
|
};
|
|
1444
2024
|
readonly stickiness: {
|
|
1445
2025
|
readonly type: "string";
|
|
@@ -1450,17 +2030,21 @@ export declare const importTogglesSchema: {
|
|
|
1450
2030
|
readonly type: "object";
|
|
1451
2031
|
readonly required: readonly ["type", "value"];
|
|
1452
2032
|
readonly description: "Extra data configured for this variant";
|
|
2033
|
+
readonly additionalProperties: false;
|
|
1453
2034
|
readonly properties: {
|
|
1454
2035
|
readonly type: {
|
|
2036
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
1455
2037
|
readonly type: "string";
|
|
2038
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
1456
2039
|
};
|
|
1457
2040
|
readonly value: {
|
|
2041
|
+
readonly description: "The actual value of payload";
|
|
1458
2042
|
readonly type: "string";
|
|
1459
2043
|
};
|
|
1460
2044
|
};
|
|
1461
2045
|
readonly example: {
|
|
1462
2046
|
readonly type: "json";
|
|
1463
|
-
readonly value: "{color: red}";
|
|
2047
|
+
readonly value: "{\"color\": \"red\"}";
|
|
1464
2048
|
};
|
|
1465
2049
|
};
|
|
1466
2050
|
readonly overrides: {
|
|
@@ -1569,6 +2153,7 @@ export declare const importTogglesSchema: {
|
|
|
1569
2153
|
readonly parametersSchema: {
|
|
1570
2154
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
1571
2155
|
readonly type: "object";
|
|
2156
|
+
readonly description: "A list of parameters for a strategy";
|
|
1572
2157
|
readonly additionalProperties: {
|
|
1573
2158
|
readonly type: "string";
|
|
1574
2159
|
};
|
|
@@ -1578,13 +2163,18 @@ export declare const importTogglesSchema: {
|
|
|
1578
2163
|
readonly $id: "#/components/schemas/legalValueSchema";
|
|
1579
2164
|
readonly type: "object";
|
|
1580
2165
|
readonly additionalProperties: false;
|
|
2166
|
+
readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
|
|
1581
2167
|
readonly required: readonly ["value"];
|
|
1582
2168
|
readonly properties: {
|
|
1583
2169
|
readonly value: {
|
|
2170
|
+
readonly description: "The valid value";
|
|
1584
2171
|
readonly type: "string";
|
|
2172
|
+
readonly example: "#c154c1";
|
|
1585
2173
|
};
|
|
1586
2174
|
readonly description: {
|
|
2175
|
+
readonly description: "Describes this specific legal value";
|
|
1587
2176
|
readonly type: "string";
|
|
2177
|
+
readonly example: "Deep fuchsia";
|
|
1588
2178
|
};
|
|
1589
2179
|
};
|
|
1590
2180
|
readonly components: {};
|
|
@@ -1593,17 +2183,24 @@ export declare const importTogglesSchema: {
|
|
|
1593
2183
|
readonly $id: "#/components/schemas/tagTypeSchema";
|
|
1594
2184
|
readonly type: "object";
|
|
1595
2185
|
readonly additionalProperties: false;
|
|
2186
|
+
readonly description: "A tag type.";
|
|
1596
2187
|
readonly required: readonly ["name"];
|
|
1597
2188
|
readonly properties: {
|
|
1598
2189
|
readonly name: {
|
|
1599
2190
|
readonly type: "string";
|
|
2191
|
+
readonly description: "The name of the tag type.";
|
|
2192
|
+
readonly example: "color";
|
|
1600
2193
|
};
|
|
1601
2194
|
readonly description: {
|
|
1602
2195
|
readonly type: "string";
|
|
2196
|
+
readonly description: "The description of the tag type.";
|
|
2197
|
+
readonly example: "A tag type for describing the color of a tag.";
|
|
1603
2198
|
};
|
|
1604
2199
|
readonly icon: {
|
|
1605
2200
|
readonly type: "string";
|
|
1606
2201
|
readonly nullable: true;
|
|
2202
|
+
readonly description: "The icon of the tag type.";
|
|
2203
|
+
readonly example: "not-really-used";
|
|
1607
2204
|
};
|
|
1608
2205
|
};
|
|
1609
2206
|
readonly components: {};
|
|
@@ -1616,6 +2213,7 @@ export declare const importTogglesSchema: {
|
|
|
1616
2213
|
readonly type: "object";
|
|
1617
2214
|
readonly additionalProperties: false;
|
|
1618
2215
|
readonly required: readonly ["name"];
|
|
2216
|
+
readonly description: "A feature toggle definition";
|
|
1619
2217
|
readonly properties: {
|
|
1620
2218
|
readonly name: {
|
|
1621
2219
|
readonly type: "string";
|
|
@@ -1646,6 +2244,7 @@ export declare const importTogglesSchema: {
|
|
|
1646
2244
|
readonly enabled: {
|
|
1647
2245
|
readonly type: "boolean";
|
|
1648
2246
|
readonly example: true;
|
|
2247
|
+
readonly description: "`true` if the feature is enabled, otherwise `false`.";
|
|
1649
2248
|
};
|
|
1650
2249
|
readonly stale: {
|
|
1651
2250
|
readonly type: "boolean";
|
|
@@ -1667,18 +2266,21 @@ export declare const importTogglesSchema: {
|
|
|
1667
2266
|
readonly format: "date-time";
|
|
1668
2267
|
readonly nullable: true;
|
|
1669
2268
|
readonly example: "2023-01-28T15:21:39.975Z";
|
|
2269
|
+
readonly description: "The date the feature was created";
|
|
1670
2270
|
};
|
|
1671
2271
|
readonly archivedAt: {
|
|
1672
2272
|
readonly type: "string";
|
|
1673
2273
|
readonly format: "date-time";
|
|
1674
2274
|
readonly nullable: true;
|
|
1675
2275
|
readonly example: "2023-01-29T15:21:39.975Z";
|
|
2276
|
+
readonly description: "The date the feature was archived";
|
|
1676
2277
|
};
|
|
1677
2278
|
readonly lastSeenAt: {
|
|
1678
2279
|
readonly type: "string";
|
|
1679
2280
|
readonly format: "date-time";
|
|
1680
2281
|
readonly nullable: true;
|
|
1681
2282
|
readonly example: "2023-01-28T16:21:39.975Z";
|
|
2283
|
+
readonly description: "The date when metrics where last collected for the feature";
|
|
1682
2284
|
};
|
|
1683
2285
|
readonly environments: {
|
|
1684
2286
|
readonly type: "array";
|
|
@@ -1773,9 +2375,12 @@ export declare const importTogglesSchema: {
|
|
|
1773
2375
|
readonly featureName: {
|
|
1774
2376
|
readonly type: "string";
|
|
1775
2377
|
readonly example: "disable-comments";
|
|
2378
|
+
readonly description: "The name of the feature";
|
|
1776
2379
|
};
|
|
1777
2380
|
readonly environment: {
|
|
1778
2381
|
readonly type: "string";
|
|
2382
|
+
readonly example: "development";
|
|
2383
|
+
readonly description: "The name of the environment";
|
|
1779
2384
|
};
|
|
1780
2385
|
readonly type: {
|
|
1781
2386
|
readonly type: "string";
|
|
@@ -1794,6 +2399,7 @@ export declare const importTogglesSchema: {
|
|
|
1794
2399
|
};
|
|
1795
2400
|
readonly variantCount: {
|
|
1796
2401
|
readonly type: "number";
|
|
2402
|
+
readonly description: "The number of defined variants";
|
|
1797
2403
|
};
|
|
1798
2404
|
readonly strategies: {
|
|
1799
2405
|
readonly type: "array";
|
|
@@ -1859,6 +2465,7 @@ export declare const importTogglesSchema: {
|
|
|
1859
2465
|
readonly parametersSchema: {
|
|
1860
2466
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
1861
2467
|
readonly type: "object";
|
|
2468
|
+
readonly description: "A list of parameters for a strategy";
|
|
1862
2469
|
readonly additionalProperties: {
|
|
1863
2470
|
readonly type: "string";
|
|
1864
2471
|
};
|
|
@@ -1913,11 +2520,18 @@ export declare const importTogglesSchema: {
|
|
|
1913
2520
|
};
|
|
1914
2521
|
readonly constraints: {
|
|
1915
2522
|
readonly type: "array";
|
|
1916
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
2523
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
1917
2524
|
readonly items: {
|
|
1918
2525
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
1919
2526
|
};
|
|
1920
2527
|
};
|
|
2528
|
+
readonly variants: {
|
|
2529
|
+
readonly type: "array";
|
|
2530
|
+
readonly description: "Strategy level variants";
|
|
2531
|
+
readonly items: {
|
|
2532
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
2533
|
+
};
|
|
2534
|
+
};
|
|
1921
2535
|
readonly parameters: {
|
|
1922
2536
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
1923
2537
|
};
|
|
@@ -1971,14 +2585,119 @@ export declare const importTogglesSchema: {
|
|
|
1971
2585
|
readonly parametersSchema: {
|
|
1972
2586
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
1973
2587
|
readonly type: "object";
|
|
2588
|
+
readonly description: "A list of parameters for a strategy";
|
|
1974
2589
|
readonly additionalProperties: {
|
|
1975
2590
|
readonly type: "string";
|
|
1976
2591
|
};
|
|
1977
2592
|
readonly components: {};
|
|
1978
2593
|
};
|
|
2594
|
+
readonly strategyVariantSchema: {
|
|
2595
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
2596
|
+
readonly type: "object";
|
|
2597
|
+
readonly additionalProperties: false;
|
|
2598
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
2599
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
2600
|
+
readonly properties: {
|
|
2601
|
+
readonly name: {
|
|
2602
|
+
readonly type: "string";
|
|
2603
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
2604
|
+
readonly example: "blue_group";
|
|
2605
|
+
};
|
|
2606
|
+
readonly weight: {
|
|
2607
|
+
readonly type: "integer";
|
|
2608
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
2609
|
+
readonly minimum: 0;
|
|
2610
|
+
readonly maximum: 1000;
|
|
2611
|
+
};
|
|
2612
|
+
readonly weightType: {
|
|
2613
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
2614
|
+
readonly type: "string";
|
|
2615
|
+
readonly example: "fix";
|
|
2616
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2617
|
+
};
|
|
2618
|
+
readonly stickiness: {
|
|
2619
|
+
readonly type: "string";
|
|
2620
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
2621
|
+
readonly example: "custom.context.field";
|
|
2622
|
+
};
|
|
2623
|
+
readonly payload: {
|
|
2624
|
+
readonly type: "object";
|
|
2625
|
+
readonly required: readonly ["type", "value"];
|
|
2626
|
+
readonly description: "Extra data configured for this variant";
|
|
2627
|
+
readonly properties: {
|
|
2628
|
+
readonly type: {
|
|
2629
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2630
|
+
readonly type: "string";
|
|
2631
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2632
|
+
};
|
|
2633
|
+
readonly value: {
|
|
2634
|
+
readonly description: "The actual value of payload";
|
|
2635
|
+
readonly type: "string";
|
|
2636
|
+
};
|
|
2637
|
+
};
|
|
2638
|
+
readonly example: {
|
|
2639
|
+
readonly type: "json";
|
|
2640
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2641
|
+
};
|
|
2642
|
+
};
|
|
2643
|
+
};
|
|
2644
|
+
readonly components: {};
|
|
2645
|
+
};
|
|
1979
2646
|
};
|
|
1980
2647
|
};
|
|
1981
2648
|
};
|
|
2649
|
+
readonly strategyVariantSchema: {
|
|
2650
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
2651
|
+
readonly type: "object";
|
|
2652
|
+
readonly additionalProperties: false;
|
|
2653
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
2654
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
2655
|
+
readonly properties: {
|
|
2656
|
+
readonly name: {
|
|
2657
|
+
readonly type: "string";
|
|
2658
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
2659
|
+
readonly example: "blue_group";
|
|
2660
|
+
};
|
|
2661
|
+
readonly weight: {
|
|
2662
|
+
readonly type: "integer";
|
|
2663
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
2664
|
+
readonly minimum: 0;
|
|
2665
|
+
readonly maximum: 1000;
|
|
2666
|
+
};
|
|
2667
|
+
readonly weightType: {
|
|
2668
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
2669
|
+
readonly type: "string";
|
|
2670
|
+
readonly example: "fix";
|
|
2671
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2672
|
+
};
|
|
2673
|
+
readonly stickiness: {
|
|
2674
|
+
readonly type: "string";
|
|
2675
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
2676
|
+
readonly example: "custom.context.field";
|
|
2677
|
+
};
|
|
2678
|
+
readonly payload: {
|
|
2679
|
+
readonly type: "object";
|
|
2680
|
+
readonly required: readonly ["type", "value"];
|
|
2681
|
+
readonly description: "Extra data configured for this variant";
|
|
2682
|
+
readonly properties: {
|
|
2683
|
+
readonly type: {
|
|
2684
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2685
|
+
readonly type: "string";
|
|
2686
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2687
|
+
};
|
|
2688
|
+
readonly value: {
|
|
2689
|
+
readonly description: "The actual value of payload";
|
|
2690
|
+
readonly type: "string";
|
|
2691
|
+
};
|
|
2692
|
+
};
|
|
2693
|
+
readonly example: {
|
|
2694
|
+
readonly type: "json";
|
|
2695
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2696
|
+
};
|
|
2697
|
+
};
|
|
2698
|
+
};
|
|
2699
|
+
readonly components: {};
|
|
2700
|
+
};
|
|
1982
2701
|
readonly variantSchema: {
|
|
1983
2702
|
readonly $id: "#/components/schemas/variantSchema";
|
|
1984
2703
|
readonly type: "object";
|
|
@@ -2000,7 +2719,8 @@ export declare const importTogglesSchema: {
|
|
|
2000
2719
|
readonly weightType: {
|
|
2001
2720
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
2002
2721
|
readonly type: "string";
|
|
2003
|
-
readonly example: "
|
|
2722
|
+
readonly example: "variable";
|
|
2723
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2004
2724
|
};
|
|
2005
2725
|
readonly stickiness: {
|
|
2006
2726
|
readonly type: "string";
|
|
@@ -2011,17 +2731,21 @@ export declare const importTogglesSchema: {
|
|
|
2011
2731
|
readonly type: "object";
|
|
2012
2732
|
readonly required: readonly ["type", "value"];
|
|
2013
2733
|
readonly description: "Extra data configured for this variant";
|
|
2734
|
+
readonly additionalProperties: false;
|
|
2014
2735
|
readonly properties: {
|
|
2015
2736
|
readonly type: {
|
|
2737
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2016
2738
|
readonly type: "string";
|
|
2739
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2017
2740
|
};
|
|
2018
2741
|
readonly value: {
|
|
2742
|
+
readonly description: "The actual value of payload";
|
|
2019
2743
|
readonly type: "string";
|
|
2020
2744
|
};
|
|
2021
2745
|
};
|
|
2022
2746
|
readonly example: {
|
|
2023
2747
|
readonly type: "json";
|
|
2024
|
-
readonly value: "{color: red}";
|
|
2748
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2025
2749
|
};
|
|
2026
2750
|
};
|
|
2027
2751
|
readonly overrides: {
|
|
@@ -2112,11 +2836,18 @@ export declare const importTogglesSchema: {
|
|
|
2112
2836
|
};
|
|
2113
2837
|
readonly constraints: {
|
|
2114
2838
|
readonly type: "array";
|
|
2115
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
2839
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
2116
2840
|
readonly items: {
|
|
2117
2841
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
2118
2842
|
};
|
|
2119
2843
|
};
|
|
2844
|
+
readonly variants: {
|
|
2845
|
+
readonly type: "array";
|
|
2846
|
+
readonly description: "Strategy level variants";
|
|
2847
|
+
readonly items: {
|
|
2848
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
2849
|
+
};
|
|
2850
|
+
};
|
|
2120
2851
|
readonly parameters: {
|
|
2121
2852
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
2122
2853
|
};
|
|
@@ -2170,14 +2901,119 @@ export declare const importTogglesSchema: {
|
|
|
2170
2901
|
readonly parametersSchema: {
|
|
2171
2902
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
2172
2903
|
readonly type: "object";
|
|
2904
|
+
readonly description: "A list of parameters for a strategy";
|
|
2173
2905
|
readonly additionalProperties: {
|
|
2174
2906
|
readonly type: "string";
|
|
2175
2907
|
};
|
|
2176
2908
|
readonly components: {};
|
|
2177
2909
|
};
|
|
2910
|
+
readonly strategyVariantSchema: {
|
|
2911
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
2912
|
+
readonly type: "object";
|
|
2913
|
+
readonly additionalProperties: false;
|
|
2914
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
2915
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
2916
|
+
readonly properties: {
|
|
2917
|
+
readonly name: {
|
|
2918
|
+
readonly type: "string";
|
|
2919
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
2920
|
+
readonly example: "blue_group";
|
|
2921
|
+
};
|
|
2922
|
+
readonly weight: {
|
|
2923
|
+
readonly type: "integer";
|
|
2924
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
2925
|
+
readonly minimum: 0;
|
|
2926
|
+
readonly maximum: 1000;
|
|
2927
|
+
};
|
|
2928
|
+
readonly weightType: {
|
|
2929
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
2930
|
+
readonly type: "string";
|
|
2931
|
+
readonly example: "fix";
|
|
2932
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2933
|
+
};
|
|
2934
|
+
readonly stickiness: {
|
|
2935
|
+
readonly type: "string";
|
|
2936
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
2937
|
+
readonly example: "custom.context.field";
|
|
2938
|
+
};
|
|
2939
|
+
readonly payload: {
|
|
2940
|
+
readonly type: "object";
|
|
2941
|
+
readonly required: readonly ["type", "value"];
|
|
2942
|
+
readonly description: "Extra data configured for this variant";
|
|
2943
|
+
readonly properties: {
|
|
2944
|
+
readonly type: {
|
|
2945
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2946
|
+
readonly type: "string";
|
|
2947
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2948
|
+
};
|
|
2949
|
+
readonly value: {
|
|
2950
|
+
readonly description: "The actual value of payload";
|
|
2951
|
+
readonly type: "string";
|
|
2952
|
+
};
|
|
2953
|
+
};
|
|
2954
|
+
readonly example: {
|
|
2955
|
+
readonly type: "json";
|
|
2956
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2957
|
+
};
|
|
2958
|
+
};
|
|
2959
|
+
};
|
|
2960
|
+
readonly components: {};
|
|
2961
|
+
};
|
|
2178
2962
|
};
|
|
2179
2963
|
};
|
|
2180
2964
|
};
|
|
2965
|
+
readonly strategyVariantSchema: {
|
|
2966
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
2967
|
+
readonly type: "object";
|
|
2968
|
+
readonly additionalProperties: false;
|
|
2969
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
2970
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
2971
|
+
readonly properties: {
|
|
2972
|
+
readonly name: {
|
|
2973
|
+
readonly type: "string";
|
|
2974
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
2975
|
+
readonly example: "blue_group";
|
|
2976
|
+
};
|
|
2977
|
+
readonly weight: {
|
|
2978
|
+
readonly type: "integer";
|
|
2979
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
2980
|
+
readonly minimum: 0;
|
|
2981
|
+
readonly maximum: 1000;
|
|
2982
|
+
};
|
|
2983
|
+
readonly weightType: {
|
|
2984
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
2985
|
+
readonly type: "string";
|
|
2986
|
+
readonly example: "fix";
|
|
2987
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2988
|
+
};
|
|
2989
|
+
readonly stickiness: {
|
|
2990
|
+
readonly type: "string";
|
|
2991
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
2992
|
+
readonly example: "custom.context.field";
|
|
2993
|
+
};
|
|
2994
|
+
readonly payload: {
|
|
2995
|
+
readonly type: "object";
|
|
2996
|
+
readonly required: readonly ["type", "value"];
|
|
2997
|
+
readonly description: "Extra data configured for this variant";
|
|
2998
|
+
readonly properties: {
|
|
2999
|
+
readonly type: {
|
|
3000
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
3001
|
+
readonly type: "string";
|
|
3002
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
3003
|
+
};
|
|
3004
|
+
readonly value: {
|
|
3005
|
+
readonly description: "The actual value of payload";
|
|
3006
|
+
readonly type: "string";
|
|
3007
|
+
};
|
|
3008
|
+
};
|
|
3009
|
+
readonly example: {
|
|
3010
|
+
readonly type: "json";
|
|
3011
|
+
readonly value: "{\"color\": \"red\"}";
|
|
3012
|
+
};
|
|
3013
|
+
};
|
|
3014
|
+
};
|
|
3015
|
+
readonly components: {};
|
|
3016
|
+
};
|
|
2181
3017
|
readonly overrideSchema: {
|
|
2182
3018
|
readonly $id: "#/components/schemas/overrideSchema";
|
|
2183
3019
|
readonly type: "object";
|
|
@@ -2204,6 +3040,7 @@ export declare const importTogglesSchema: {
|
|
|
2204
3040
|
readonly parametersSchema: {
|
|
2205
3041
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
2206
3042
|
readonly type: "object";
|
|
3043
|
+
readonly description: "A list of parameters for a strategy";
|
|
2207
3044
|
readonly additionalProperties: {
|
|
2208
3045
|
readonly type: "string";
|
|
2209
3046
|
};
|
|
@@ -2230,7 +3067,8 @@ export declare const importTogglesSchema: {
|
|
|
2230
3067
|
readonly weightType: {
|
|
2231
3068
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
2232
3069
|
readonly type: "string";
|
|
2233
|
-
readonly example: "
|
|
3070
|
+
readonly example: "variable";
|
|
3071
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2234
3072
|
};
|
|
2235
3073
|
readonly stickiness: {
|
|
2236
3074
|
readonly type: "string";
|
|
@@ -2241,17 +3079,21 @@ export declare const importTogglesSchema: {
|
|
|
2241
3079
|
readonly type: "object";
|
|
2242
3080
|
readonly required: readonly ["type", "value"];
|
|
2243
3081
|
readonly description: "Extra data configured for this variant";
|
|
3082
|
+
readonly additionalProperties: false;
|
|
2244
3083
|
readonly properties: {
|
|
2245
3084
|
readonly type: {
|
|
3085
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2246
3086
|
readonly type: "string";
|
|
3087
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2247
3088
|
};
|
|
2248
3089
|
readonly value: {
|
|
3090
|
+
readonly description: "The actual value of payload";
|
|
2249
3091
|
readonly type: "string";
|
|
2250
3092
|
};
|
|
2251
3093
|
};
|
|
2252
3094
|
readonly example: {
|
|
2253
3095
|
readonly type: "json";
|
|
2254
|
-
readonly value: "{color: red}";
|
|
3096
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2255
3097
|
};
|
|
2256
3098
|
};
|
|
2257
3099
|
readonly overrides: {
|
|
@@ -2367,11 +3209,18 @@ export declare const importTogglesSchema: {
|
|
|
2367
3209
|
};
|
|
2368
3210
|
readonly constraints: {
|
|
2369
3211
|
readonly type: "array";
|
|
2370
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
3212
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
2371
3213
|
readonly items: {
|
|
2372
3214
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
2373
3215
|
};
|
|
2374
3216
|
};
|
|
3217
|
+
readonly variants: {
|
|
3218
|
+
readonly type: "array";
|
|
3219
|
+
readonly description: "Strategy level variants";
|
|
3220
|
+
readonly items: {
|
|
3221
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
3222
|
+
};
|
|
3223
|
+
};
|
|
2375
3224
|
readonly parameters: {
|
|
2376
3225
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
2377
3226
|
};
|
|
@@ -2425,14 +3274,119 @@ export declare const importTogglesSchema: {
|
|
|
2425
3274
|
readonly parametersSchema: {
|
|
2426
3275
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
2427
3276
|
readonly type: "object";
|
|
3277
|
+
readonly description: "A list of parameters for a strategy";
|
|
2428
3278
|
readonly additionalProperties: {
|
|
2429
3279
|
readonly type: "string";
|
|
2430
3280
|
};
|
|
2431
3281
|
readonly components: {};
|
|
2432
3282
|
};
|
|
3283
|
+
readonly strategyVariantSchema: {
|
|
3284
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
3285
|
+
readonly type: "object";
|
|
3286
|
+
readonly additionalProperties: false;
|
|
3287
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
3288
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
3289
|
+
readonly properties: {
|
|
3290
|
+
readonly name: {
|
|
3291
|
+
readonly type: "string";
|
|
3292
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
3293
|
+
readonly example: "blue_group";
|
|
3294
|
+
};
|
|
3295
|
+
readonly weight: {
|
|
3296
|
+
readonly type: "integer";
|
|
3297
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
3298
|
+
readonly minimum: 0;
|
|
3299
|
+
readonly maximum: 1000;
|
|
3300
|
+
};
|
|
3301
|
+
readonly weightType: {
|
|
3302
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
3303
|
+
readonly type: "string";
|
|
3304
|
+
readonly example: "fix";
|
|
3305
|
+
readonly enum: readonly ["variable", "fix"];
|
|
3306
|
+
};
|
|
3307
|
+
readonly stickiness: {
|
|
3308
|
+
readonly type: "string";
|
|
3309
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
3310
|
+
readonly example: "custom.context.field";
|
|
3311
|
+
};
|
|
3312
|
+
readonly payload: {
|
|
3313
|
+
readonly type: "object";
|
|
3314
|
+
readonly required: readonly ["type", "value"];
|
|
3315
|
+
readonly description: "Extra data configured for this variant";
|
|
3316
|
+
readonly properties: {
|
|
3317
|
+
readonly type: {
|
|
3318
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
3319
|
+
readonly type: "string";
|
|
3320
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
3321
|
+
};
|
|
3322
|
+
readonly value: {
|
|
3323
|
+
readonly description: "The actual value of payload";
|
|
3324
|
+
readonly type: "string";
|
|
3325
|
+
};
|
|
3326
|
+
};
|
|
3327
|
+
readonly example: {
|
|
3328
|
+
readonly type: "json";
|
|
3329
|
+
readonly value: "{\"color\": \"red\"}";
|
|
3330
|
+
};
|
|
3331
|
+
};
|
|
3332
|
+
};
|
|
3333
|
+
readonly components: {};
|
|
3334
|
+
};
|
|
2433
3335
|
};
|
|
2434
3336
|
};
|
|
2435
3337
|
};
|
|
3338
|
+
readonly strategyVariantSchema: {
|
|
3339
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
3340
|
+
readonly type: "object";
|
|
3341
|
+
readonly additionalProperties: false;
|
|
3342
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
3343
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
3344
|
+
readonly properties: {
|
|
3345
|
+
readonly name: {
|
|
3346
|
+
readonly type: "string";
|
|
3347
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
3348
|
+
readonly example: "blue_group";
|
|
3349
|
+
};
|
|
3350
|
+
readonly weight: {
|
|
3351
|
+
readonly type: "integer";
|
|
3352
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
3353
|
+
readonly minimum: 0;
|
|
3354
|
+
readonly maximum: 1000;
|
|
3355
|
+
};
|
|
3356
|
+
readonly weightType: {
|
|
3357
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
3358
|
+
readonly type: "string";
|
|
3359
|
+
readonly example: "fix";
|
|
3360
|
+
readonly enum: readonly ["variable", "fix"];
|
|
3361
|
+
};
|
|
3362
|
+
readonly stickiness: {
|
|
3363
|
+
readonly type: "string";
|
|
3364
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
3365
|
+
readonly example: "custom.context.field";
|
|
3366
|
+
};
|
|
3367
|
+
readonly payload: {
|
|
3368
|
+
readonly type: "object";
|
|
3369
|
+
readonly required: readonly ["type", "value"];
|
|
3370
|
+
readonly description: "Extra data configured for this variant";
|
|
3371
|
+
readonly properties: {
|
|
3372
|
+
readonly type: {
|
|
3373
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
3374
|
+
readonly type: "string";
|
|
3375
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
3376
|
+
};
|
|
3377
|
+
readonly value: {
|
|
3378
|
+
readonly description: "The actual value of payload";
|
|
3379
|
+
readonly type: "string";
|
|
3380
|
+
};
|
|
3381
|
+
};
|
|
3382
|
+
readonly example: {
|
|
3383
|
+
readonly type: "json";
|
|
3384
|
+
readonly value: "{\"color\": \"red\"}";
|
|
3385
|
+
};
|
|
3386
|
+
};
|
|
3387
|
+
};
|
|
3388
|
+
readonly components: {};
|
|
3389
|
+
};
|
|
2436
3390
|
readonly featureEnvironmentSchema: {
|
|
2437
3391
|
readonly $id: "#/components/schemas/featureEnvironmentSchema";
|
|
2438
3392
|
readonly type: "object";
|
|
@@ -2448,9 +3402,12 @@ export declare const importTogglesSchema: {
|
|
|
2448
3402
|
readonly featureName: {
|
|
2449
3403
|
readonly type: "string";
|
|
2450
3404
|
readonly example: "disable-comments";
|
|
3405
|
+
readonly description: "The name of the feature";
|
|
2451
3406
|
};
|
|
2452
3407
|
readonly environment: {
|
|
2453
3408
|
readonly type: "string";
|
|
3409
|
+
readonly example: "development";
|
|
3410
|
+
readonly description: "The name of the environment";
|
|
2454
3411
|
};
|
|
2455
3412
|
readonly type: {
|
|
2456
3413
|
readonly type: "string";
|
|
@@ -2469,6 +3426,7 @@ export declare const importTogglesSchema: {
|
|
|
2469
3426
|
};
|
|
2470
3427
|
readonly variantCount: {
|
|
2471
3428
|
readonly type: "number";
|
|
3429
|
+
readonly description: "The number of defined variants";
|
|
2472
3430
|
};
|
|
2473
3431
|
readonly strategies: {
|
|
2474
3432
|
readonly type: "array";
|
|
@@ -2534,6 +3492,7 @@ export declare const importTogglesSchema: {
|
|
|
2534
3492
|
readonly parametersSchema: {
|
|
2535
3493
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
2536
3494
|
readonly type: "object";
|
|
3495
|
+
readonly description: "A list of parameters for a strategy";
|
|
2537
3496
|
readonly additionalProperties: {
|
|
2538
3497
|
readonly type: "string";
|
|
2539
3498
|
};
|
|
@@ -2588,11 +3547,18 @@ export declare const importTogglesSchema: {
|
|
|
2588
3547
|
};
|
|
2589
3548
|
readonly constraints: {
|
|
2590
3549
|
readonly type: "array";
|
|
2591
|
-
readonly description: "A list of the constraints attached to the strategy";
|
|
3550
|
+
readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
|
|
2592
3551
|
readonly items: {
|
|
2593
3552
|
readonly $ref: "#/components/schemas/constraintSchema";
|
|
2594
3553
|
};
|
|
2595
3554
|
};
|
|
3555
|
+
readonly variants: {
|
|
3556
|
+
readonly type: "array";
|
|
3557
|
+
readonly description: "Strategy level variants";
|
|
3558
|
+
readonly items: {
|
|
3559
|
+
readonly $ref: "#/components/schemas/strategyVariantSchema";
|
|
3560
|
+
};
|
|
3561
|
+
};
|
|
2596
3562
|
readonly parameters: {
|
|
2597
3563
|
readonly $ref: "#/components/schemas/parametersSchema";
|
|
2598
3564
|
};
|
|
@@ -2646,14 +3612,119 @@ export declare const importTogglesSchema: {
|
|
|
2646
3612
|
readonly parametersSchema: {
|
|
2647
3613
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
2648
3614
|
readonly type: "object";
|
|
3615
|
+
readonly description: "A list of parameters for a strategy";
|
|
2649
3616
|
readonly additionalProperties: {
|
|
2650
3617
|
readonly type: "string";
|
|
2651
3618
|
};
|
|
2652
3619
|
readonly components: {};
|
|
2653
3620
|
};
|
|
3621
|
+
readonly strategyVariantSchema: {
|
|
3622
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
3623
|
+
readonly type: "object";
|
|
3624
|
+
readonly additionalProperties: false;
|
|
3625
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
3626
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
3627
|
+
readonly properties: {
|
|
3628
|
+
readonly name: {
|
|
3629
|
+
readonly type: "string";
|
|
3630
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
3631
|
+
readonly example: "blue_group";
|
|
3632
|
+
};
|
|
3633
|
+
readonly weight: {
|
|
3634
|
+
readonly type: "integer";
|
|
3635
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
3636
|
+
readonly minimum: 0;
|
|
3637
|
+
readonly maximum: 1000;
|
|
3638
|
+
};
|
|
3639
|
+
readonly weightType: {
|
|
3640
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
3641
|
+
readonly type: "string";
|
|
3642
|
+
readonly example: "fix";
|
|
3643
|
+
readonly enum: readonly ["variable", "fix"];
|
|
3644
|
+
};
|
|
3645
|
+
readonly stickiness: {
|
|
3646
|
+
readonly type: "string";
|
|
3647
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
3648
|
+
readonly example: "custom.context.field";
|
|
3649
|
+
};
|
|
3650
|
+
readonly payload: {
|
|
3651
|
+
readonly type: "object";
|
|
3652
|
+
readonly required: readonly ["type", "value"];
|
|
3653
|
+
readonly description: "Extra data configured for this variant";
|
|
3654
|
+
readonly properties: {
|
|
3655
|
+
readonly type: {
|
|
3656
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
3657
|
+
readonly type: "string";
|
|
3658
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
3659
|
+
};
|
|
3660
|
+
readonly value: {
|
|
3661
|
+
readonly description: "The actual value of payload";
|
|
3662
|
+
readonly type: "string";
|
|
3663
|
+
};
|
|
3664
|
+
};
|
|
3665
|
+
readonly example: {
|
|
3666
|
+
readonly type: "json";
|
|
3667
|
+
readonly value: "{\"color\": \"red\"}";
|
|
3668
|
+
};
|
|
3669
|
+
};
|
|
3670
|
+
};
|
|
3671
|
+
readonly components: {};
|
|
3672
|
+
};
|
|
2654
3673
|
};
|
|
2655
3674
|
};
|
|
2656
3675
|
};
|
|
3676
|
+
readonly strategyVariantSchema: {
|
|
3677
|
+
readonly $id: "#/components/schemas/strategyVariantSchema";
|
|
3678
|
+
readonly type: "object";
|
|
3679
|
+
readonly additionalProperties: false;
|
|
3680
|
+
readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
|
|
3681
|
+
readonly required: readonly ["name", "weight", "weightType", "stickiness"];
|
|
3682
|
+
readonly properties: {
|
|
3683
|
+
readonly name: {
|
|
3684
|
+
readonly type: "string";
|
|
3685
|
+
readonly description: "The variant name. Must be unique for this feature toggle";
|
|
3686
|
+
readonly example: "blue_group";
|
|
3687
|
+
};
|
|
3688
|
+
readonly weight: {
|
|
3689
|
+
readonly type: "integer";
|
|
3690
|
+
readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
|
|
3691
|
+
readonly minimum: 0;
|
|
3692
|
+
readonly maximum: 1000;
|
|
3693
|
+
};
|
|
3694
|
+
readonly weightType: {
|
|
3695
|
+
readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
|
|
3696
|
+
readonly type: "string";
|
|
3697
|
+
readonly example: "fix";
|
|
3698
|
+
readonly enum: readonly ["variable", "fix"];
|
|
3699
|
+
};
|
|
3700
|
+
readonly stickiness: {
|
|
3701
|
+
readonly type: "string";
|
|
3702
|
+
readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
|
|
3703
|
+
readonly example: "custom.context.field";
|
|
3704
|
+
};
|
|
3705
|
+
readonly payload: {
|
|
3706
|
+
readonly type: "object";
|
|
3707
|
+
readonly required: readonly ["type", "value"];
|
|
3708
|
+
readonly description: "Extra data configured for this variant";
|
|
3709
|
+
readonly properties: {
|
|
3710
|
+
readonly type: {
|
|
3711
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
3712
|
+
readonly type: "string";
|
|
3713
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
3714
|
+
};
|
|
3715
|
+
readonly value: {
|
|
3716
|
+
readonly description: "The actual value of payload";
|
|
3717
|
+
readonly type: "string";
|
|
3718
|
+
};
|
|
3719
|
+
};
|
|
3720
|
+
readonly example: {
|
|
3721
|
+
readonly type: "json";
|
|
3722
|
+
readonly value: "{\"color\": \"red\"}";
|
|
3723
|
+
};
|
|
3724
|
+
};
|
|
3725
|
+
};
|
|
3726
|
+
readonly components: {};
|
|
3727
|
+
};
|
|
2657
3728
|
readonly variantSchema: {
|
|
2658
3729
|
readonly $id: "#/components/schemas/variantSchema";
|
|
2659
3730
|
readonly type: "object";
|
|
@@ -2675,7 +3746,8 @@ export declare const importTogglesSchema: {
|
|
|
2675
3746
|
readonly weightType: {
|
|
2676
3747
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
2677
3748
|
readonly type: "string";
|
|
2678
|
-
readonly example: "
|
|
3749
|
+
readonly example: "variable";
|
|
3750
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2679
3751
|
};
|
|
2680
3752
|
readonly stickiness: {
|
|
2681
3753
|
readonly type: "string";
|
|
@@ -2686,17 +3758,21 @@ export declare const importTogglesSchema: {
|
|
|
2686
3758
|
readonly type: "object";
|
|
2687
3759
|
readonly required: readonly ["type", "value"];
|
|
2688
3760
|
readonly description: "Extra data configured for this variant";
|
|
3761
|
+
readonly additionalProperties: false;
|
|
2689
3762
|
readonly properties: {
|
|
2690
3763
|
readonly type: {
|
|
3764
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2691
3765
|
readonly type: "string";
|
|
3766
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2692
3767
|
};
|
|
2693
3768
|
readonly value: {
|
|
3769
|
+
readonly description: "The actual value of payload";
|
|
2694
3770
|
readonly type: "string";
|
|
2695
3771
|
};
|
|
2696
3772
|
};
|
|
2697
3773
|
readonly example: {
|
|
2698
3774
|
readonly type: "json";
|
|
2699
|
-
readonly value: "{color: red}";
|
|
3775
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2700
3776
|
};
|
|
2701
3777
|
};
|
|
2702
3778
|
readonly overrides: {
|
|
@@ -2742,39 +3818,53 @@ export declare const importTogglesSchema: {
|
|
|
2742
3818
|
readonly $id: "#/components/schemas/contextFieldSchema";
|
|
2743
3819
|
readonly type: "object";
|
|
2744
3820
|
readonly additionalProperties: false;
|
|
3821
|
+
readonly description: "A representation of a [context field](https://docs.getunleash.io/reference/unleash-context).";
|
|
2745
3822
|
readonly required: readonly ["name"];
|
|
2746
3823
|
readonly properties: {
|
|
2747
3824
|
readonly name: {
|
|
3825
|
+
readonly description: "The name of the context field";
|
|
2748
3826
|
readonly type: "string";
|
|
3827
|
+
readonly example: "userId";
|
|
2749
3828
|
};
|
|
2750
3829
|
readonly description: {
|
|
3830
|
+
readonly description: "The description of the context field.";
|
|
2751
3831
|
readonly type: "string";
|
|
2752
3832
|
readonly nullable: true;
|
|
3833
|
+
readonly example: "Used to uniquely identify users";
|
|
2753
3834
|
};
|
|
2754
3835
|
readonly stickiness: {
|
|
3836
|
+
readonly description: "Does this context field support being used for [stickiness](https://docs.getunleash.io/reference/stickiness) calculations";
|
|
2755
3837
|
readonly type: "boolean";
|
|
3838
|
+
readonly example: true;
|
|
2756
3839
|
};
|
|
2757
3840
|
readonly sortOrder: {
|
|
2758
|
-
readonly
|
|
3841
|
+
readonly description: "Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.";
|
|
3842
|
+
readonly type: "integer";
|
|
3843
|
+
readonly example: 900;
|
|
2759
3844
|
};
|
|
2760
3845
|
readonly createdAt: {
|
|
3846
|
+
readonly description: "When this context field was created";
|
|
2761
3847
|
readonly type: "string";
|
|
2762
3848
|
readonly format: "date-time";
|
|
2763
3849
|
readonly nullable: true;
|
|
3850
|
+
readonly example: "2023-06-29T10:19:00.000Z";
|
|
2764
3851
|
};
|
|
2765
3852
|
readonly usedInFeatures: {
|
|
2766
|
-
readonly type: "
|
|
3853
|
+
readonly type: "integer";
|
|
2767
3854
|
readonly description: "Number of projects where this context field is used in";
|
|
2768
3855
|
readonly example: 3;
|
|
2769
3856
|
readonly nullable: true;
|
|
3857
|
+
readonly minimum: 0;
|
|
2770
3858
|
};
|
|
2771
3859
|
readonly usedInProjects: {
|
|
2772
|
-
readonly type: "
|
|
3860
|
+
readonly type: "integer";
|
|
2773
3861
|
readonly description: "Number of projects where this context field is used in";
|
|
2774
3862
|
readonly example: 2;
|
|
2775
3863
|
readonly nullable: true;
|
|
3864
|
+
readonly minimum: 0;
|
|
2776
3865
|
};
|
|
2777
3866
|
readonly legalValues: {
|
|
3867
|
+
readonly description: "Allowed values for this context field schema. Can be used to narrow down accepted input";
|
|
2778
3868
|
readonly type: "array";
|
|
2779
3869
|
readonly items: {
|
|
2780
3870
|
readonly $ref: "#/components/schemas/legalValueSchema";
|
|
@@ -2787,13 +3877,18 @@ export declare const importTogglesSchema: {
|
|
|
2787
3877
|
readonly $id: "#/components/schemas/legalValueSchema";
|
|
2788
3878
|
readonly type: "object";
|
|
2789
3879
|
readonly additionalProperties: false;
|
|
3880
|
+
readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
|
|
2790
3881
|
readonly required: readonly ["value"];
|
|
2791
3882
|
readonly properties: {
|
|
2792
3883
|
readonly value: {
|
|
3884
|
+
readonly description: "The valid value";
|
|
2793
3885
|
readonly type: "string";
|
|
3886
|
+
readonly example: "#c154c1";
|
|
2794
3887
|
};
|
|
2795
3888
|
readonly description: {
|
|
3889
|
+
readonly description: "Describes this specific legal value";
|
|
2796
3890
|
readonly type: "string";
|
|
3891
|
+
readonly example: "Deep fuchsia";
|
|
2797
3892
|
};
|
|
2798
3893
|
};
|
|
2799
3894
|
readonly components: {};
|
|
@@ -2843,6 +3938,29 @@ export declare const importTogglesSchema: {
|
|
|
2843
3938
|
readonly additionalProperties: false;
|
|
2844
3939
|
readonly required: readonly ["id", "constraints"];
|
|
2845
3940
|
readonly properties: {
|
|
3941
|
+
readonly description: {
|
|
3942
|
+
readonly type: "string";
|
|
3943
|
+
readonly nullable: true;
|
|
3944
|
+
readonly description: "The description of the segment.";
|
|
3945
|
+
readonly example: "Segment A description";
|
|
3946
|
+
};
|
|
3947
|
+
readonly createdAt: {
|
|
3948
|
+
readonly type: "string";
|
|
3949
|
+
readonly format: "date-time";
|
|
3950
|
+
readonly description: "The time the segment was created as a RFC 3339-conformant timestamp.";
|
|
3951
|
+
readonly example: "2023-07-05T12:56:00.000Z";
|
|
3952
|
+
};
|
|
3953
|
+
readonly createdBy: {
|
|
3954
|
+
readonly type: "string";
|
|
3955
|
+
readonly description: "Which user created this segment";
|
|
3956
|
+
readonly example: "johndoe";
|
|
3957
|
+
};
|
|
3958
|
+
readonly project: {
|
|
3959
|
+
readonly type: "string";
|
|
3960
|
+
readonly nullable: true;
|
|
3961
|
+
readonly description: "The project the segment relates to, if applicable.";
|
|
3962
|
+
readonly example: "default";
|
|
3963
|
+
};
|
|
2846
3964
|
readonly id: {
|
|
2847
3965
|
readonly type: "number";
|
|
2848
3966
|
readonly description: "The segment's id.";
|
|
@@ -2852,12 +3970,6 @@ export declare const importTogglesSchema: {
|
|
|
2852
3970
|
readonly description: "The name of the segment.";
|
|
2853
3971
|
readonly example: "segment A";
|
|
2854
3972
|
};
|
|
2855
|
-
readonly description: {
|
|
2856
|
-
readonly type: "string";
|
|
2857
|
-
readonly nullable: true;
|
|
2858
|
-
readonly description: "The description of the segment.";
|
|
2859
|
-
readonly example: "Segment A description";
|
|
2860
|
-
};
|
|
2861
3973
|
readonly constraints: {
|
|
2862
3974
|
readonly type: "array";
|
|
2863
3975
|
readonly description: "List of constraints that determine which users are part of the segment";
|
|
@@ -2944,7 +4056,8 @@ export declare const importTogglesSchema: {
|
|
|
2944
4056
|
readonly weightType: {
|
|
2945
4057
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
2946
4058
|
readonly type: "string";
|
|
2947
|
-
readonly example: "
|
|
4059
|
+
readonly example: "variable";
|
|
4060
|
+
readonly enum: readonly ["variable", "fix"];
|
|
2948
4061
|
};
|
|
2949
4062
|
readonly stickiness: {
|
|
2950
4063
|
readonly type: "string";
|
|
@@ -2955,17 +4068,21 @@ export declare const importTogglesSchema: {
|
|
|
2955
4068
|
readonly type: "object";
|
|
2956
4069
|
readonly required: readonly ["type", "value"];
|
|
2957
4070
|
readonly description: "Extra data configured for this variant";
|
|
4071
|
+
readonly additionalProperties: false;
|
|
2958
4072
|
readonly properties: {
|
|
2959
4073
|
readonly type: {
|
|
4074
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
2960
4075
|
readonly type: "string";
|
|
4076
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
2961
4077
|
};
|
|
2962
4078
|
readonly value: {
|
|
4079
|
+
readonly description: "The actual value of payload";
|
|
2963
4080
|
readonly type: "string";
|
|
2964
4081
|
};
|
|
2965
4082
|
};
|
|
2966
4083
|
readonly example: {
|
|
2967
4084
|
readonly type: "json";
|
|
2968
|
-
readonly value: "{color: red}";
|
|
4085
|
+
readonly value: "{\"color\": \"red\"}";
|
|
2969
4086
|
};
|
|
2970
4087
|
};
|
|
2971
4088
|
readonly overrides: {
|
|
@@ -3051,7 +4168,8 @@ export declare const importTogglesSchema: {
|
|
|
3051
4168
|
readonly weightType: {
|
|
3052
4169
|
readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
|
|
3053
4170
|
readonly type: "string";
|
|
3054
|
-
readonly example: "
|
|
4171
|
+
readonly example: "variable";
|
|
4172
|
+
readonly enum: readonly ["variable", "fix"];
|
|
3055
4173
|
};
|
|
3056
4174
|
readonly stickiness: {
|
|
3057
4175
|
readonly type: "string";
|
|
@@ -3062,17 +4180,21 @@ export declare const importTogglesSchema: {
|
|
|
3062
4180
|
readonly type: "object";
|
|
3063
4181
|
readonly required: readonly ["type", "value"];
|
|
3064
4182
|
readonly description: "Extra data configured for this variant";
|
|
4183
|
+
readonly additionalProperties: false;
|
|
3065
4184
|
readonly properties: {
|
|
3066
4185
|
readonly type: {
|
|
4186
|
+
readonly description: "The type of the value. Commonly used types are string, json and csv.";
|
|
3067
4187
|
readonly type: "string";
|
|
4188
|
+
readonly enum: readonly ["json", "csv", "string"];
|
|
3068
4189
|
};
|
|
3069
4190
|
readonly value: {
|
|
4191
|
+
readonly description: "The actual value of payload";
|
|
3070
4192
|
readonly type: "string";
|
|
3071
4193
|
};
|
|
3072
4194
|
};
|
|
3073
4195
|
readonly example: {
|
|
3074
4196
|
readonly type: "json";
|
|
3075
|
-
readonly value: "{color: red}";
|
|
4197
|
+
readonly value: "{\"color\": \"red\"}";
|
|
3076
4198
|
};
|
|
3077
4199
|
};
|
|
3078
4200
|
readonly overrides: {
|
|
@@ -3181,6 +4303,7 @@ export declare const importTogglesSchema: {
|
|
|
3181
4303
|
readonly parametersSchema: {
|
|
3182
4304
|
readonly $id: "#/components/schemas/parametersSchema";
|
|
3183
4305
|
readonly type: "object";
|
|
4306
|
+
readonly description: "A list of parameters for a strategy";
|
|
3184
4307
|
readonly additionalProperties: {
|
|
3185
4308
|
readonly type: "string";
|
|
3186
4309
|
};
|
|
@@ -3190,13 +4313,18 @@ export declare const importTogglesSchema: {
|
|
|
3190
4313
|
readonly $id: "#/components/schemas/legalValueSchema";
|
|
3191
4314
|
readonly type: "object";
|
|
3192
4315
|
readonly additionalProperties: false;
|
|
4316
|
+
readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
|
|
3193
4317
|
readonly required: readonly ["value"];
|
|
3194
4318
|
readonly properties: {
|
|
3195
4319
|
readonly value: {
|
|
4320
|
+
readonly description: "The valid value";
|
|
3196
4321
|
readonly type: "string";
|
|
4322
|
+
readonly example: "#c154c1";
|
|
3197
4323
|
};
|
|
3198
4324
|
readonly description: {
|
|
4325
|
+
readonly description: "Describes this specific legal value";
|
|
3199
4326
|
readonly type: "string";
|
|
4327
|
+
readonly example: "Deep fuchsia";
|
|
3200
4328
|
};
|
|
3201
4329
|
};
|
|
3202
4330
|
readonly components: {};
|
|
@@ -3205,17 +4333,24 @@ export declare const importTogglesSchema: {
|
|
|
3205
4333
|
readonly $id: "#/components/schemas/tagTypeSchema";
|
|
3206
4334
|
readonly type: "object";
|
|
3207
4335
|
readonly additionalProperties: false;
|
|
4336
|
+
readonly description: "A tag type.";
|
|
3208
4337
|
readonly required: readonly ["name"];
|
|
3209
4338
|
readonly properties: {
|
|
3210
4339
|
readonly name: {
|
|
3211
4340
|
readonly type: "string";
|
|
4341
|
+
readonly description: "The name of the tag type.";
|
|
4342
|
+
readonly example: "color";
|
|
3212
4343
|
};
|
|
3213
4344
|
readonly description: {
|
|
3214
4345
|
readonly type: "string";
|
|
4346
|
+
readonly description: "The description of the tag type.";
|
|
4347
|
+
readonly example: "A tag type for describing the color of a tag.";
|
|
3215
4348
|
};
|
|
3216
4349
|
readonly icon: {
|
|
3217
4350
|
readonly type: "string";
|
|
3218
4351
|
readonly nullable: true;
|
|
4352
|
+
readonly description: "The icon of the tag type.";
|
|
4353
|
+
readonly example: "not-really-used";
|
|
3219
4354
|
};
|
|
3220
4355
|
};
|
|
3221
4356
|
readonly components: {};
|