unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
52 lines • 1.79 kB
JavaScript
export const sdkContextSchema = {
$id: '#/components/schemas/sdkContextSchema',
description: 'The Unleash context as modeled in client SDKs',
type: 'object',
required: ['appName'],
additionalProperties: true,
properties: {
appName: {
type: 'string',
minLength: 1,
example: 'My cool application.',
description: 'The name of the application.',
},
currentTime: {
type: 'string',
format: 'date-time',
example: '2022-07-05T12:56:41+02:00',
description: 'A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.',
},
environment: {
type: 'string',
deprecated: true,
description: 'The environment the app is running in.',
},
properties: {
type: 'object',
additionalProperties: { type: 'string' },
description: 'Additional Unleash context properties',
example: {
customContextField: 'this is one!',
otherCustomField: '3',
},
},
remoteAddress: {
type: 'string',
example: '192.168.1.1',
description: "The app's IP address",
},
sessionId: {
type: 'string',
example: 'b65e7b23-fec0-4814-a129-0e9861ef18fc',
description: 'An identifier for the current session',
},
userId: {
type: 'string',
example: 'username@provider.com',
description: 'An identifier for the current user',
},
},
components: {},
};
//# sourceMappingURL=sdk-context-schema.js.map