Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
// Generated by `pnpm openapi:contracts`. Do not edit directly.
import type { ZodOpenApiOperationObject } from 'zod-openapi';
import { defineOperation } from '@/openapi/operation';
const operation1 = defineOperation({
method: 'get',
path: '/api/boards',
audience: 'public',
auth: 'bearer',
operation: {
operationId: 'getBoards',
summary: 'Get boards',
tags: ['Boards'],
parameters: [
{
name: 'page',
in: 'query',
required: false,
schema: {
type: 'integer',
minimum: 1,
},
},
{
name: 'pageSize',
in: 'query',
required: false,
schema: {
type: 'integer',
minimum: 1,
},
},
{
name: 'maxResults',
in: 'query',
required: false,
schema: {
type: 'integer',
minimum: 1,
},
},
{
name: 'search',
in: 'query',
required: false,
schema: {
type: 'string',
},
},
{
name: 'orderBy',
in: 'query',
required: false,
schema: {
type: 'string',
},
},
{
name: 'sortDescending',
in: 'query',
required: false,
schema: {
type: 'string',
enum: ['true', 'false'],
},
},
],
responses: {
'200': {
description: 'The operation completed successfully.',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
data: {
type: 'array',
items: {
type: 'object',
properties: {
id: {
type: 'string',
},
userId: {
type: 'string',
},
createdAt: {
type: 'string',
format: 'date-time',
},
updatedAt: {
type: 'string',
format: 'date-time',
},
name: {
type: 'string',
},
teamId: {
type: 'string',
},
type: {
type: 'string',
},
description: {
type: 'string',
},
parameters: {
anyOf: [
{
type: 'string',
},
{
type: 'number',
},
{
const: false,
},
{
const: true,
},
{
type: 'object',
properties: {},
additionalProperties: {
anyOf: [
{
type: 'string',
},
{
type: 'number',
},
{
const: false,
},
{
const: true,
},
{},
{
type: 'object',
properties: {
length: {
type: 'number',
},
},
required: ['length'],
},
],
},
},
{
type: 'object',
properties: {
length: {
type: 'number',
},
},
required: ['length'],
},
],
},
},
required: [
'id',
'userId',
'createdAt',
'updatedAt',
'name',
'teamId',
'type',
'description',
'parameters',
],
},
},
count: {
type: 'number',
},
page: {
type: 'number',
},
pageSize: {
type: 'number',
},
orderBy: {
type: 'string',
},
sortDescending: {
type: 'boolean',
},
search: {
type: 'string',
},
isCapped: {
type: 'boolean',
},
},
required: ['data', 'count', 'page', 'pageSize'],
},
},
},
},
'400': {
description: 'Bad request.',
content: {
'application/json': {
example: {
error: {
message: 'Bad request.',
code: 'bad-request',
status: 400,
},
},
schema: {
$ref: '#/components/schemas/ApiError',
},
},
},
},
'401': {
description: 'Unauthorized.',
content: {
'application/json': {
example: {
error: {
message: 'Unauthorized.',
code: 'unauthorized',
status: 401,
},
},
schema: {
$ref: '#/components/schemas/ApiError',
},
},
},
},
},
} as ZodOpenApiOperationObject,
});
const operation2 = defineOperation({
method: 'post',
path: '/api/boards',
audience: 'public',
auth: 'bearer-or-share',
operation: {
operationId: 'createBoard',
summary: 'Create or update boards',
tags: ['Boards'],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
type: {
anyOf: [
{
type: 'string',
enum: [],
},
{
const: 'open',
},
],
},
name: {
type: 'string',
maxLength: 100,
},
description: {
type: 'string',
maxLength: 500,
},
userId: {
anyOf: [
{
type: 'string',
format: 'uuid',
},
{
type: 'null',
},
],
},
teamId: {
anyOf: [
{
type: 'string',
format: 'uuid',
},
{
type: 'null',
},
],
},
parameters: {
type: 'object',
properties: {
websiteId: {
type: 'string',
format: 'uuid',
},
pixelId: {
type: 'string',
format: 'uuid',
},
linkId: {
type: 'string',
format: 'uuid',
},
},
},
},
required: ['type', 'name'],
},
},
},
},
responses: {
'200': {
description: 'The operation completed successfully.',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
id: {
type: 'string',
},
userId: {
type: 'string',
},
createdAt: {
type: 'string',
format: 'date-time',
},
updatedAt: {
type: 'string',
format: 'date-time',
},
name: {
type: 'string',
},
teamId: {
type: 'string',
},
type: {
type: 'string',
},
description: {
type: 'string',
},
parameters: {
anyOf: [
{
type: 'string',
},
{
type: 'number',
},
{
const: false,
},
{
const: true,
},
{
type: 'object',
properties: {},
additionalProperties: {
anyOf: [
{
type: 'string',
},
{
type: 'number',
},
{
const: false,
},
{
const: true,
},
{},
{
type: 'object',
properties: {
length: {
type: 'number',
},
},
required: ['length'],
},
],
},
},
{
type: 'object',
properties: {
length: {
type: 'number',
},
},
required: ['length'],
},
],
},
},
required: [
'id',
'userId',
'createdAt',
'updatedAt',
'name',
'teamId',
'type',
'description',
'parameters',
],
},
},
},
},
'400': {
description: 'Bad request.',
content: {
'application/json': {
example: {
error: {
message: 'Bad request.',
code: 'bad-request',
status: 400,
},
},
schema: {
$ref: '#/components/schemas/ApiError',
},
},
},
},
'401': {
description: 'Unauthorized.',
content: {
'application/json': {
example: {
error: {
message: 'Unauthorized.',
code: 'unauthorized',
status: 401,
},
},
schema: {
$ref: '#/components/schemas/ApiError',
},
},
},
},
},
} as ZodOpenApiOperationObject,
});
export const operations = [operation1, operation2] as const;