1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-11-01 19:07:38 +01:00
unleash.unleash/src/lib/openapi/spec/feedback-response-schema.ts
Thomas Heartman 8f5bda6b8a
openapi: document operations for admin ui feedback (#4226)
This PR updates the endpoint documentation and schemas related to Admin
UI feedback.
2023-07-13 13:27:52 +02:00

37 lines
1.1 KiB
TypeScript

import { FromSchema } from 'json-schema-to-ts';
export const feedbackResponseSchema = {
$id: '#/components/schemas/feedbackResponseSchema',
additionalProperties: false,
type: 'object',
description: 'User feedback information about a particular feedback item.',
properties: {
userId: {
description: 'The ID of the user that gave the feedback.',
type: 'integer',
example: 2,
},
neverShow: {
description:
'`true` if the user has asked never to see this feedback questionnaire again.',
type: 'boolean',
example: false,
},
given: {
description: 'When this feedback was given',
type: 'string',
format: 'date-time',
nullable: true,
example: '2023-07-06T08:29:21.282Z',
},
feedbackId: {
description: 'The name of the feedback session',
type: 'string',
example: 'pnps',
},
},
components: {},
} as const;
export type FeedbackResponseSchema = FromSchema<typeof feedbackResponseSchema>;