versia-pub/api
2
0
Fork 0
mirror of https://github.com/versia-pub/api.git synced 2026-03-13 04:09:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(client): 📝 Add JSDoc to more endpoints

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-06-06 18:42:55 -10:00
parent 2d923aae4d
commit 1ca2a03f3b
No known key found for this signature in database
2 changed files with 281 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

93
client/types/instance.ts
View file

@ -1,35 +1,78 @@
import type { Account } from "./account";
import type { Stats } from "./stats";
import type { URLs } from "./urls";
export type Instance = {
uri: string;
domain: string;
title: string;
description: string;
email: string;
version: string;
thumbnail: string | null;
urls: URLs | null;
stats: Stats;
languages: Array<string>;
registrations: boolean;
approval_required: boolean;
invites_enabled?: boolean;
configuration: {
statuses: {
max_characters: number;
max_media_attachments?: number;
characters_reserved_per_url?: number;
};
polls?: {
max_options: number;
max_characters_per_option: number;
min_expiration: number;
max_expiration: number;
lysand_version: string;
source_url: string;
description: string;
usage: {
users: {
active_month: number;
};
};
contact_account?: Account;
rules?: Array<InstanceRule>;
thumbnail: {
url: string | null;
};
banner: {
url: string | null;
};
languages: string[];
configuration: {
urls: {
streaming: string | null;
status: string | null;
};
accounts: {
max_featured_tags: number;
};
statuses: {
max_characters: number;
max_media_attachments: number;
characters_reserved_per_url: number;
};
media_attachments: {
supported_mime_types: string[];
image_size_limit: number;
image_matrix_limit: number;
video_size_limit: number;
video_frame_rate_limit: number;
video_matrix_limit: number;
};
polls: {
max_characters_per_option: number;
max_expiration: number;
max_options: number;
min_expiration: number;
};
translation: {
enabled: boolean;
};
};
registrations: {
enabled: boolean;
approval_required: boolean;
message: string | null;
url: string | null;
};
contact: {
email: string | null;
account: Account | null;
};
rules: {
id: string;
text: string;
hint: string;
}[];
sso: {
forced: boolean;
providers: {
name: string;
icon: string;
id: string;
}[];
};
};
export type InstanceRule = {