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/create-invited-user-schema.ts
Thomas Heartman 12209ae21c
OpenAPI: clean up remaining schemas, part 1 (#4351)
Part of linear task 1-1167. Fixes the first slew of schemas missing
descriptions/examples, etc.
2023-07-28 08:45:56 +02:00

37 lines
1.0 KiB
TypeScript

import { FromSchema } from 'json-schema-to-ts';
export const createInvitedUserSchema = {
$id: '#/components/schemas/createInvitedUserSchema',
type: 'object',
additionalProperties: false,
required: ['email', 'name', 'password'],
description: 'Data used to create a user that has been invited to Unleash.',
properties: {
username: {
type: 'string',
description: "The user's username. Must be unique if provided.",
example: 'Hunter',
},
email: {
type: 'string',
description: "The invited user's email address",
example: 'hunter@example.com',
},
name: {
type: 'string',
description: "The user's name",
example: 'Hunter Burgan',
},
password: {
type: 'string',
description: "The user's password",
example: 'hunter2',
},
},
components: {},
} as const;
export type CreateInvitedUserSchema = FromSchema<
typeof createInvitedUserSchema
>;