versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2026-03-13 05:49:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(api): 🏷️ Finish OpenAPI documentation refactor

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-02-14 17:49:34 +01:00
parent 1856176de5
commit 6a810529bc
No known key found for this signature in database
12 changed files with 428 additions and 379 deletions
Download patch file Download diff file Expand all files Collapse all files

42
classes/schemas/filters.ts
View file

@ -1,4 +1,5 @@
import { z } from "@hono/zod-openapi";
import { zBoolean } from "~/packages/config-manager/config.type.ts";
import { Id } from "./common.ts";
export const FilterStatus = z
@ -42,7 +43,7 @@ export const FilterKeyword = z
url: "https://docs.joinmastodon.org/entities/FilterKeyword/#keyword",
},
}),
whole_word: z.boolean().openapi({
whole_word: zBoolean.openapi({
description:
"Should the filter consider word boundaries? See implementation guidelines for filters.",
example: false,
@ -68,13 +69,18 @@ export const Filter = z
url: "https://docs.joinmastodon.org/entities/Filter/#id",
},
}),
title: z.string().openapi({
description: "A title given by the user to name the filter.",
example: "Test filter",
externalDocs: {
url: "https://docs.joinmastodon.org/entities/Filter/#title",
},
}),
title: z
.string()
.trim()
.min(1)
.max(255)
.openapi({
description: "A title given by the user to name the filter.",
example: "Test filter",
externalDocs: {
url: "https://docs.joinmastodon.org/entities/Filter/#title",
},
}),
context: z
.array(
z.enum([
@ -85,6 +91,7 @@ export const Filter = z
"account",
]),
)
.default([])
.openapi({
description:
"The contexts in which the filter should be applied.",
@ -103,14 +110,17 @@ export const Filter = z
url: "https://docs.joinmastodon.org/entities/Filter/#expires_at",
},
}),
filter_action: z.enum(["warn", "hide"]).openapi({
description:
"The action to be taken when a status matches this filter.",
example: "warn",
externalDocs: {
url: "https://docs.joinmastodon.org/entities/Filter/#filter_action",
},
}),
filter_action: z
.enum(["warn", "hide"])
.default("warn")
.openapi({
description:
"The action to be taken when a status matches this filter.",
example: "warn",
externalDocs: {
url: "https://docs.joinmastodon.org/entities/Filter/#filter_action",
},
}),
keywords: z.array(FilterKeyword).openapi({
description: "The keywords grouped under this filter.",
externalDocs: {