mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-06 00:07:44 +01:00
7ea4e5d5b9
Unless you set `additionalProperties` to `false`, additional properties
are always
allowed. By explicitly setting it to `true` the generated
examples contain additional properties, e.g.:
```json
{
"tokens": [
"aproject:development.randomstring",
"[]:production.randomstring"
],
"additionalProp1": {}
}
```
By removing the explicit annotation, we still allow additional
properties, but we don't get them in examples:
```json
{
"tokens": [
"aproject:development.randomstring",
"[]:production.randomstring"
]
}
```
99 lines
3.1 KiB
TypeScript
99 lines
3.1 KiB
TypeScript
import { FromSchema } from 'json-schema-to-ts';
|
|
import { tagSchema } from './tag-schema';
|
|
import { IEventTypes } from '../../types';
|
|
import { variantSchema } from './variant-schema';
|
|
|
|
const eventDataSchema = {
|
|
type: 'object',
|
|
nullable: true,
|
|
'x-enforcer-exception-skip-codes': 'WSCH006', // allow additional properties in example (openapi enforcer)
|
|
description:
|
|
'Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.',
|
|
example: {
|
|
name: 'new-feature',
|
|
description: 'Toggle description',
|
|
type: 'release',
|
|
project: 'my-project',
|
|
stale: false,
|
|
variants: [],
|
|
createdAt: '2022-05-31T13:32:20.547Z',
|
|
lastSeenAt: null,
|
|
impressionData: true,
|
|
},
|
|
} as const;
|
|
export const eventSchema = {
|
|
$id: '#/components/schemas/eventSchema',
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
required: ['id', 'createdAt', 'type', 'createdBy'],
|
|
description: 'An event describing something happening in the system',
|
|
properties: {
|
|
id: {
|
|
type: 'integer',
|
|
minimum: 1,
|
|
description: 'The ID of the event. An increasing natural number.',
|
|
},
|
|
createdAt: {
|
|
type: 'string',
|
|
format: 'date-time',
|
|
description:
|
|
'The time the event happened as a RFC 3339-conformant timestamp.',
|
|
example: '2023-07-05T12:56:00.000Z',
|
|
},
|
|
type: {
|
|
type: 'string',
|
|
description:
|
|
'What [type](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#event-type-description) of event this is',
|
|
enum: IEventTypes,
|
|
example: 'feature-created',
|
|
},
|
|
createdBy: {
|
|
type: 'string',
|
|
description: 'Which user created this event',
|
|
example: 'johndoe',
|
|
},
|
|
environment: {
|
|
type: 'string',
|
|
description:
|
|
'The feature toggle environment the event relates to, if applicable.',
|
|
nullable: true,
|
|
example: 'development',
|
|
},
|
|
project: {
|
|
type: 'string',
|
|
nullable: true,
|
|
description: 'The project the event relates to, if applicable.',
|
|
example: 'default',
|
|
},
|
|
featureName: {
|
|
type: 'string',
|
|
nullable: true,
|
|
description:
|
|
'The name of the feature toggle the event relates to, if applicable.',
|
|
example: 'my.first.feature',
|
|
},
|
|
data: eventDataSchema,
|
|
preData: {
|
|
...eventDataSchema,
|
|
description:
|
|
"Data relating to the previous state of the event's subject.",
|
|
},
|
|
tags: {
|
|
type: 'array',
|
|
items: {
|
|
$ref: tagSchema.$id,
|
|
},
|
|
nullable: true,
|
|
description: 'Any tags related to the event, if applicable.',
|
|
},
|
|
},
|
|
components: {
|
|
schemas: {
|
|
tagSchema,
|
|
variantSchema,
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
export type EventSchema = FromSchema<typeof eventSchema>;
|