1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-06 00:07:44 +01:00
unleash.unleash/src/lib/openapi/spec/patch-schema.ts
Thomas Heartman 4ab8accf5c
OpenAPI: remaining schema updates (#4354)
This fixes the last few exceptions to our meta schema validation
2023-07-28 07:25:34 +00:00

38 lines
1.1 KiB
TypeScript

import { FromSchema } from 'json-schema-to-ts';
export const patchSchema = {
$id: '#/components/schemas/patchSchema',
type: 'object',
required: ['path', 'op'],
description:
'A [JSON patch](https://www.rfc-editor.org/rfc/rfc6902) operation description',
properties: {
path: {
type: 'string',
description: 'The path to the property to operate on',
example: '/type',
},
op: {
type: 'string',
enum: ['add', 'remove', 'replace', 'copy', 'move'],
description: 'The kind of operation to perform',
example: 'replace',
},
from: {
type: 'string',
description:
'The target to move or copy from, if performing one of those operations',
example: '/type',
},
value: {
description:
'The value to add or replace, if performing one of those operations',
example: 'kill-switch',
nullable: true,
},
},
components: {},
} as const;
export type PatchSchema = FromSchema<typeof patchSchema>;