Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

openapi: remove all the extra data info #4277

Merged
merged 3 commits into from
Jul 19, 2023
Merged

openapi: remove all the extra data info #4277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34994de
openapi: remove all the extra data info
thomasheartman Jul 19, 2023
86551f2
openapi: allow additional props in example for this object
thomasheartman Jul 19, 2023
f5d3f63
openapi: allow keyword 'x-enforcer-exception-skip-codes'
thomasheartman Jul 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 2 additions & 64 deletions src/lib/openapi/spec/event-schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,70 +5,9 @@ import { variantSchema } from './variant-schema';

const eventDataSchema = {
type: 'object',
nullable: true,
'x-enforcer-exception-skip-codes': 'WSCH006', // allow additional properties in example (openapi enforcer)
additionalProperties: true,
properties: {
name: {
type: 'string',
description:
'Name of the feature toggle/strategy/environment that this event relates to',
example: 'my.first.toggle',
nullable: true,
},
description: {
type: 'string',
description: 'The description of the object this event relates to',
example: 'Toggle description',
nullable: true,
},
type: {
type: 'string',
description:
'If this event relates to a feature toggle, the type of feature toggle.',
example: 'release',
nullable: true,
},
project: {
type: 'string',
description: 'The project this event relates to',
example: 'default',
nullable: true,
},
stale: {
description: 'Is the feature toggle this event relates to stale',
type: 'boolean',
example: true,
nullable: true,
},
variants: {
description: 'Variants configured for this toggle',
type: 'array',
items: {
$ref: '#/components/schemas/variantSchema',
},
nullable: true,
},
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',
nullable: true,
},
lastSeenAt: {
type: 'string',
format: 'date-time',
description: 'The time the feature was last seen',
example: '2023-07-05T12:56:00.000Z',
nullable: true,
},
impressionData: {
description:
'Should [impression events](https://docs.getunleash.io/reference/impression-data) activate for this feature toggle',
type: 'boolean',
example: false,
},
},
description:
'Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.',
example: {
Expand Down Expand Up @@ -139,7 +78,6 @@ export const eventSchema = {
...eventDataSchema,
description:
"Data relating to the previous state of the event's subject.",
nullable: true,
},
tags: {
type: 'array',
Expand Down
2 changes: 1 addition & 1 deletion src/lib/openapi/validate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const ajv = new Ajv({
),
// example was superseded by examples in openapi 3.1, but we're still on 3.0, so
// let's add it back in!
keywords: ['example'],
keywords: ['example', 'x-enforcer-exception-skip-codes'],
formats: {
'date-time': true,
uri: true,
Expand Down