Files
softclick-landing/src/api/paths.ts
Zotov Ivan Yuryevich 2bb1c896c0 feat: add api client
2026-04-05 15:05:17 +03:00

5401 lines
130 KiB
TypeScript

/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
'/categories': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['category/get/categories']
put?: never
post: operations['category/post/categories']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/categories/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['category/get/categories_by_id']
put: operations['category/put/categories_by_id']
post?: never
delete: operations['category/delete/categories_by_id']
options?: never
head?: never
patch?: never
trace?: never
}
'/home-page': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['home-page/get/home_page']
put: operations['home-page/put/home_page']
post?: never
delete: operations['home-page/delete/home_page']
options?: never
head?: never
patch?: never
trace?: never
}
'/site-config': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['site-config/get/site_config']
put: operations['site-config/put/site_config']
post?: never
delete: operations['site-config/delete/site_config']
options?: never
head?: never
patch?: never
trace?: never
}
'/vendors': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['vendor/get/vendors']
put?: never
post: operations['vendor/post/vendors']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/vendors/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['vendor/get/vendors_by_id']
put: operations['vendor/put/vendors_by_id']
post?: never
delete: operations['vendor/delete/vendors_by_id']
options?: never
head?: never
patch?: never
trace?: never
}
'/content-type-builder/content-types': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['content-type-builder/get/content_type_builder_content_types']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/content-type-builder/content-types/{uid}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['content-type-builder/get/content_type_builder_content_types_by_uid']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/content-type-builder/components': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['content-type-builder/get/content_type_builder_components']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/content-type-builder/components/{uid}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['content-type-builder/get/content_type_builder_components_by_uid']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/email': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['email/post/email']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/upload': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['upload/post/upload']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/upload/files': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['upload/get/upload_files']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/upload/files/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['upload/get/upload_files_by_id']
put?: never
post?: never
delete: operations['upload/delete/upload_files_by_id']
options?: never
head?: never
patch?: never
trace?: never
}
'/i18n/locales': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['i18n/get/i18n_locales']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/connect/(.*)': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/connect_____']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/local': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_local']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/local/register': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_local_register']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/{provider}/callback': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/auth_by_provider_callback']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/forgot-password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_forgot_password']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/reset-password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_reset_password']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/email-confirmation': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/auth_email_confirmation']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/send-email-confirmation': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_send_email_confirmation']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/change-password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_change_password']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/refresh': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_refresh']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/auth/logout': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post: operations['users-permissions/post/auth_logout']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/users/count': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users_count']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/users': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users']
put?: never
post: operations['users-permissions/post/users']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/users/me': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users_me']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/users/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users_by_id']
put: operations['users-permissions/put/users_by_id']
post?: never
delete: operations['users-permissions/delete/users_by_id']
options?: never
head?: never
patch?: never
trace?: never
}
'/users-permissions/roles/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users_permissions_roles_by_id']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/users-permissions/roles': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users_permissions_roles']
put?: never
post: operations['users-permissions/post/users_permissions_roles']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/users-permissions/roles/{role}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put: operations['users-permissions/put/users_permissions_roles_by_role']
post?: never
delete: operations['users-permissions/delete/users_permissions_roles_by_role']
options?: never
head?: never
patch?: never
trace?: never
}
'/users-permissions/permissions': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get: operations['users-permissions/get/users_permissions_permissions']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
}
export type webhooks = Record<string, never>
export interface components {
schemas: {
SharedProductEntry: {
/** @description A string field */
title: string
}
ApiCategoryCategoryDocument: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description An integer field
* @default 0
*/
sortOrder: number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.027Z
*/
publishedAt: string
/** @description A relational field */
vendors?: components['schemas']['ApiVendorVendorDocument'][]
}
ApiVendorVendorDocument: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.025Z
*/
publishedAt: string
/** @description A component field */
products?: components['schemas']['SharedProductEntry'][]
/** @description A relational field */
categories?: components['schemas']['ApiCategoryCategoryDocument'][]
}
}
responses: never
parameters: never
requestBodies: never
headers: never
pathItems: never
}
export type $defs = Record<string, never>
export interface operations {
'category/get/categories': {
parameters: {
query?: {
fields?: (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
filters?: {
[key: string]: unknown
}
_q?: string
pagination?: {
/** @description Include total count in response */
withCount?: boolean
} & (
| {
/** @description Page number (1-based) */
page: number
/** @description Number of entries per page */
pageSize: number
}
| {
/** @description Number of entries to skip */
start: number
/** @description Maximum number of entries to return */
limit: number
}
)
sort?:
| (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)
| (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
| {
[key: string]: 'asc' | 'desc'
}
| {
[key: string]: 'asc' | 'desc'
}[]
populate?: '*' | 'vendors' | 'vendors'[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description An integer field
* @default 0
*/
sortOrder: number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.023Z
*/
publishedAt: string
/** @description A relational field */
vendors?: components['schemas']['ApiVendorVendorDocument'][]
}[]
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'category/post/categories': {
parameters: {
query?: {
fields?: (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
populate?: '*' | 'vendors' | 'vendors'[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
data: {
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description A float field
* @default 0
*/
sortOrder: number
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.030Z
*/
publishedAt: string
/** @description A relational field */
vendors?: string[]
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description An integer field
* @default 0
*/
sortOrder: number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.031Z
*/
publishedAt: string
/** @description A relational field */
vendors?: components['schemas']['ApiVendorVendorDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'category/get/categories_by_id': {
parameters: {
query?: {
fields?: (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
populate?: '*' | 'vendors' | 'vendors'[]
filters?: {
[key: string]: unknown
}
sort?:
| (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)
| (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
| {
[key: string]: 'asc' | 'desc'
}
| {
[key: string]: 'asc' | 'desc'
}[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description An integer field
* @default 0
*/
sortOrder: number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.029Z
*/
publishedAt: string
/** @description A relational field */
vendors?: components['schemas']['ApiVendorVendorDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'category/put/categories_by_id': {
parameters: {
query?: {
fields?: (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
populate?: '*' | 'vendors' | 'vendors'[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: {
content: {
'application/json': {
data: {
/** @description A UID field */
slug?: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group?: 'service' | 'solution'
/**
* @description A float field
* @default 0
*/
sortOrder?: number
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.032Z
*/
publishedAt?: string
/** @description A relational field */
vendors?: string[]
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description An integer field
* @default 0
*/
sortOrder: number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.033Z
*/
publishedAt: string
/** @description A relational field */
vendors?: components['schemas']['ApiVendorVendorDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'category/delete/categories_by_id': {
parameters: {
query?: {
fields?: (
| 'slug'
| 'title'
| 'description'
| 'comment'
| 'group'
| 'sortOrder'
| 'createdAt'
| 'updatedAt'
| 'publishedAt'
)[]
populate?: '*' | 'vendors' | 'vendors'[]
filters?: {
[key: string]: unknown
}
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A string field */
comment?: string
/**
* @description An enum field
* @enum {string}
*/
group: 'service' | 'solution'
/**
* @description An integer field
* @default 0
*/
sortOrder: number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.034Z
*/
publishedAt: string
/** @description A relational field */
vendors?: components['schemas']['ApiVendorVendorDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'home-page/get/home_page': {
parameters: {
query?: {
fields?: ('createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | 'sections' | 'sections'[]
filters?: {
[key: string]: unknown
}
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.036Z
*/
publishedAt: string
/** @description A dynamic zone field */
sections?: unknown[]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'home-page/put/home_page': {
parameters: {
query?: {
fields?: ('createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | 'sections' | 'sections'[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
data: {
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.036Z
*/
publishedAt?: string
/** @description A dynamic zone field */
sections?: unknown[]
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.038Z
*/
publishedAt: string
/** @description A dynamic zone field */
sections?: unknown[]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'home-page/delete/home_page': {
parameters: {
query?: {
fields?: ('createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | 'sections' | 'sections'[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.039Z
*/
publishedAt: string
/** @description A dynamic zone field */
sections?: unknown[]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'site-config/get/site_config': {
parameters: {
query?: {
fields?: ('title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | never | never[]
filters?: {
[key: string]: unknown
}
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A string field */
title: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.040Z
*/
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'site-config/put/site_config': {
parameters: {
query?: {
fields?: ('title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | never | never[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
data: {
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.040Z
*/
publishedAt?: string
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A string field */
title: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.041Z
*/
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'site-config/delete/site_config': {
parameters: {
query?: {
fields?: ('title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | never | never[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A string field */
title: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.041Z
*/
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'vendor/get/vendors': {
parameters: {
query?: {
fields?: ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
filters?: {
[key: string]: unknown
}
_q?: string
pagination?: {
/** @description Include total count in response */
withCount?: boolean
} & (
| {
/** @description Page number (1-based) */
page: number
/** @description Number of entries per page */
pageSize: number
}
| {
/** @description Number of entries to skip */
start: number
/** @description Maximum number of entries to return */
limit: number
}
)
sort?:
| ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')
| ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
| {
[key: string]: 'asc' | 'desc'
}
| {
[key: string]: 'asc' | 'desc'
}[]
populate?: '*' | ('products' | 'categories') | ('products' | 'categories')[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.043Z
*/
publishedAt: string
/** @description A component field */
products?: components['schemas']['SharedProductEntry'][]
/** @description A relational field */
categories?: components['schemas']['ApiCategoryCategoryDocument'][]
}[]
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'vendor/post/vendors': {
parameters: {
query?: {
fields?: ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | ('products' | 'categories') | ('products' | 'categories')[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
data: {
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.045Z
*/
publishedAt: string
/** @description A component field */
products?: unknown[]
/** @description A relational field */
categories?: string[]
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.045Z
*/
publishedAt: string
/** @description A component field */
products?: components['schemas']['SharedProductEntry'][]
/** @description A relational field */
categories?: components['schemas']['ApiCategoryCategoryDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'vendor/get/vendors_by_id': {
parameters: {
query?: {
fields?: ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | ('products' | 'categories') | ('products' | 'categories')[]
filters?: {
[key: string]: unknown
}
sort?:
| ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')
| ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
| {
[key: string]: 'asc' | 'desc'
}
| {
[key: string]: 'asc' | 'desc'
}[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.044Z
*/
publishedAt: string
/** @description A component field */
products?: components['schemas']['SharedProductEntry'][]
/** @description A relational field */
categories?: components['schemas']['ApiCategoryCategoryDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'vendor/put/vendors_by_id': {
parameters: {
query?: {
fields?: ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | ('products' | 'categories') | ('products' | 'categories')[]
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: {
content: {
'application/json': {
data: {
/** @description A UID field */
slug?: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.048Z
*/
publishedAt?: string
/** @description A component field */
products?: unknown[]
/** @description A relational field */
categories?: string[]
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.048Z
*/
publishedAt: string
/** @description A component field */
products?: components['schemas']['SharedProductEntry'][]
/** @description A relational field */
categories?: components['schemas']['ApiCategoryCategoryDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'vendor/delete/vendors_by_id': {
parameters: {
query?: {
fields?: ('slug' | 'title' | 'description' | 'createdAt' | 'updatedAt' | 'publishedAt')[]
populate?: '*' | ('products' | 'categories') | ('products' | 'categories')[]
filters?: {
[key: string]: unknown
}
status?: 'draft' | 'published'
hasPublishedVersion?: boolean | ('true' | 'false')
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
/**
* Format: uuid
* @description The document ID, represented by a UUID
*/
documentId: string
id: string | number
/** @description A UID field */
slug: string
/** @description A string field */
title?: string
/** @description A text field */
description?: string
/** @description A datetime field */
createdAt?: string
/** @description A datetime field */
updatedAt?: string
/**
* @description A datetime field
* @default 2026-04-05T08:39:04.049Z
*/
publishedAt: string
/** @description A component field */
products?: components['schemas']['SharedProductEntry'][]
/** @description A relational field */
categories?: components['schemas']['ApiCategoryCategoryDocument'][]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'content-type-builder/get/content_type_builder_content_types': {
parameters: {
query: {
kind: 'collectionType' | 'singleType'
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
uid: string
plugin?: string
apiID: string
schema: {
displayName: string
singularName: string
pluralName: string
description: string
draftAndPublish: boolean
/** @enum {string} */
kind: 'collectionType' | 'singleType'
collectionName?: string
attributes: {
[key: string]:
| {
/** @constant */
type: 'media'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
multiple: boolean
required?: boolean
allowedTypes?: string[]
}
| {
/** @constant */
type: 'relation'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
relation: string
target: string
targetAttribute: string | null
autoPopulate?: boolean
mappedBy?: string
inversedBy?: string
}
| {
/** @constant */
type: 'component'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
component: string
repeatable: boolean
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'dynamiczone'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
components: string[]
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'uid'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
targetField?: string
}
| {
type: string
required?: boolean
unique?: boolean
default?: unknown
min?: number | string
max?: number | string
minLength?: number
maxLength?: number
enum?: string[]
regex?: string
private?: boolean
configurable?: boolean
pluginOptions?: {
[key: string]: unknown
}
}
}
visible: boolean
restrictRelationsTo: string[] | null
pluginOptions?: {
[key: string]: unknown
}
options?: {
[key: string]: unknown
}
reviewWorkflows?: boolean
populateCreatorFields?: boolean
comment?: string
version?: string
}
}[]
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'content-type-builder/get/content_type_builder_content_types_by_uid': {
parameters: {
query?: never
header?: never
path: {
uid: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
uid: string
plugin?: string
apiID: string
schema: {
displayName: string
singularName: string
pluralName: string
description: string
draftAndPublish: boolean
/** @enum {string} */
kind: 'collectionType' | 'singleType'
collectionName?: string
attributes: {
[key: string]:
| {
/** @constant */
type: 'media'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
multiple: boolean
required?: boolean
allowedTypes?: string[]
}
| {
/** @constant */
type: 'relation'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
relation: string
target: string
targetAttribute: string | null
autoPopulate?: boolean
mappedBy?: string
inversedBy?: string
}
| {
/** @constant */
type: 'component'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
component: string
repeatable: boolean
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'dynamiczone'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
components: string[]
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'uid'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
targetField?: string
}
| {
type: string
required?: boolean
unique?: boolean
default?: unknown
min?: number | string
max?: number | string
minLength?: number
maxLength?: number
enum?: string[]
regex?: string
private?: boolean
configurable?: boolean
pluginOptions?: {
[key: string]: unknown
}
}
}
visible: boolean
restrictRelationsTo: string[] | null
pluginOptions?: {
[key: string]: unknown
}
options?: {
[key: string]: unknown
}
reviewWorkflows?: boolean
populateCreatorFields?: boolean
comment?: string
version?: string
}
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'content-type-builder/get/content_type_builder_components': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
uid: string
category: string
apiId: string
schema: {
displayName: string
description: string
icon?: string
connection?: string
collectionName?: string
attributes: {
[key: string]:
| {
/** @constant */
type: 'media'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
multiple: boolean
required?: boolean
allowedTypes?: string[]
}
| {
/** @constant */
type: 'relation'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
relation: string
target: string
targetAttribute: string | null
autoPopulate?: boolean
mappedBy?: string
inversedBy?: string
}
| {
/** @constant */
type: 'component'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
component: string
repeatable: boolean
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'dynamiczone'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
components: string[]
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'uid'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
targetField?: string
}
| {
type: string
required?: boolean
unique?: boolean
default?: unknown
min?: number | string
max?: number | string
minLength?: number
maxLength?: number
enum?: string[]
regex?: string
private?: boolean
configurable?: boolean
pluginOptions?: {
[key: string]: unknown
}
}
}
pluginOptions?: {
[key: string]: unknown
}
}
}[]
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'content-type-builder/get/content_type_builder_components_by_uid': {
parameters: {
query?: never
header?: never
path: {
uid: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
data: {
uid: string
category: string
apiId: string
schema: {
displayName: string
description: string
icon?: string
connection?: string
collectionName?: string
attributes: {
[key: string]:
| {
/** @constant */
type: 'media'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
multiple: boolean
required?: boolean
allowedTypes?: string[]
}
| {
/** @constant */
type: 'relation'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
relation: string
target: string
targetAttribute: string | null
autoPopulate?: boolean
mappedBy?: string
inversedBy?: string
}
| {
/** @constant */
type: 'component'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
component: string
repeatable: boolean
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'dynamiczone'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
components: string[]
required?: boolean
min?: number
max?: number
}
| {
/** @constant */
type: 'uid'
/** @constant */
configurable?: false
private?: boolean
pluginOptions?: {
[key: string]: unknown
}
targetField?: string
}
| {
type: string
required?: boolean
unique?: boolean
default?: unknown
min?: number | string
max?: number | string
minLength?: number
maxLength?: number
enum?: string[]
regex?: string
private?: boolean
configurable?: boolean
pluginOptions?: {
[key: string]: unknown
}
}
}
pluginOptions?: {
[key: string]: unknown
}
}
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'email/post/email': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
from?: string
to: string
cc?: string
bcc?: string
replyTo?: string
subject: string
text: string
html?: string
} & {
[key: string]: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': Record<string, never>
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'upload/post/upload': {
parameters: {
query?: {
id?: number
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json':
| {
id: number
/** Format: uuid */
documentId: string
name: string
alternativeText?: string | null
caption?: string | null
width?: number
height?: number
formats?: {
[key: string]: unknown
}
hash: string
ext?: string
mime: string
size: number
url: string
previewUrl?: string | null
folder?: number
folderPath: string
provider: string
provider_metadata?: {
[key: string]: unknown
} | null
createdAt: string
updatedAt: string
createdBy?: number
updatedBy?: number
}
| {
id: number
/** Format: uuid */
documentId: string
name: string
alternativeText?: string | null
caption?: string | null
width?: number
height?: number
formats?: {
[key: string]: unknown
}
hash: string
ext?: string
mime: string
size: number
url: string
previewUrl?: string | null
folder?: number
folderPath: string
provider: string
provider_metadata?: {
[key: string]: unknown
} | null
createdAt: string
updatedAt: string
createdBy?: number
updatedBy?: number
}[]
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'upload/get/upload_files': {
parameters: {
query?: {
fields?: string | string[]
populate?:
| '*'
| string
| string[]
| {
[key: string]: unknown
}
sort?:
| string
| string[]
| {
[key: string]: 'asc' | 'desc'
}
| {
[key: string]: 'asc' | 'desc'
}[]
pagination?: {
/** @description Include total count in response */
withCount?: boolean
} & (
| {
/** @description Page number (1-based) */
page: number
/** @description Number of entries per page */
pageSize: number
}
| {
/** @description Number of entries to skip */
start: number
/** @description Maximum number of entries to return */
limit: number
}
)
filters?: {
[key: string]: unknown
}
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
/** Format: uuid */
documentId: string
name: string
alternativeText?: string | null
caption?: string | null
width?: number
height?: number
formats?: {
[key: string]: unknown
}
hash: string
ext?: string
mime: string
size: number
url: string
previewUrl?: string | null
folder?: number
folderPath: string
provider: string
provider_metadata?: {
[key: string]: unknown
} | null
createdAt: string
updatedAt: string
createdBy?: number
updatedBy?: number
}[]
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'upload/get/upload_files_by_id': {
parameters: {
query?: {
fields?: string | string[]
populate?:
| '*'
| string
| string[]
| {
[key: string]: unknown
}
}
header?: never
path: {
id: number
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
/** Format: uuid */
documentId: string
name: string
alternativeText?: string | null
caption?: string | null
width?: number
height?: number
formats?: {
[key: string]: unknown
}
hash: string
ext?: string
mime: string
size: number
url: string
previewUrl?: string | null
folder?: number
folderPath: string
provider: string
provider_metadata?: {
[key: string]: unknown
} | null
createdAt: string
updatedAt: string
createdBy?: number
updatedBy?: number
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'upload/delete/upload_files_by_id': {
parameters: {
query?: never
header?: never
path: {
id: number
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
/** Format: uuid */
documentId: string
name: string
alternativeText?: string | null
caption?: string | null
width?: number
height?: number
formats?: {
[key: string]: unknown
}
hash: string
ext?: string
mime: string
size: number
url: string
previewUrl?: string | null
folder?: number
folderPath: string
provider: string
provider_metadata?: {
[key: string]: unknown
} | null
createdAt: string
updatedAt: string
createdBy?: number
updatedBy?: number
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'i18n/get/i18n_locales': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
/** Format: uuid */
documentId: string
name: string
code: string
createdAt: string
updatedAt: string
publishedAt: string | null
isDefault: boolean
}[]
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/connect_____': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_local': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
identifier: string
password: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
jwt: string
refreshToken?: string
user: {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_local_register': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
username: string
/** Format: email */
email: string
password: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json':
| {
jwt: string
refreshToken?: string
user: {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
| {
user: {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/auth_by_provider_callback': {
parameters: {
query?: never
header?: never
path: {
provider: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
jwt: string
refreshToken?: string
user: {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_forgot_password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
/** Format: email */
email: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
ok: boolean
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_reset_password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
code: string
password: string
passwordConfirmation: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
jwt: string
refreshToken?: string
user: {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/auth_email_confirmation': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_send_email_confirmation': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
/** Format: email */
email: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
email: string
sent: boolean
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_change_password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
currentPassword: string
password: string
passwordConfirmation: string
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
jwt: string
refreshToken?: string
user: {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_refresh': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/auth_logout': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users_count': {
parameters: {
query?: {
filters?: {
[key: string]: unknown
}
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': number
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users': {
parameters: {
query?: {
fields?: string | string[]
populate?:
| '*'
| string
| string[]
| {
[key: string]: unknown
}
sort?:
| string
| string[]
| {
[key: string]: 'asc' | 'desc'
}
| {
[key: string]: 'asc' | 'desc'
}[]
pagination?: {
/** @description Include total count in response */
withCount?: boolean
} & (
| {
/** @description Page number (1-based) */
page: number
/** @description Number of entries per page */
pageSize: number
}
| {
/** @description Number of entries to skip */
start: number
/** @description Maximum number of entries to return */
limit: number
}
)
filters?: {
[key: string]: unknown
}
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}[]
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/users': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
username: string
/** Format: email */
email: string
password: string
role?: number
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users_me': {
parameters: {
query?: {
fields?: string | string[]
populate?:
| '*'
| string
| string[]
| {
[key: string]: unknown
}
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users_by_id': {
parameters: {
query?: {
fields?: string | string[]
populate?:
| '*'
| string
| string[]
| {
[key: string]: unknown
}
}
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/put/users_by_id': {
parameters: {
query?: never
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: {
content: {
'application/json': {
username?: string
/** Format: email */
email?: string
password?: string
role?: number
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/delete/users_by_id': {
parameters: {
query?: never
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
id: number
documentId: string
username: string
email: string
provider: string
confirmed: boolean
blocked: boolean
role?:
| number
| {
id: number
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
}
createdAt: string
updatedAt: string
publishedAt: string
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users_permissions_roles_by_id': {
parameters: {
query?: never
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
role: {
id: number
documentId: string
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
publishedAt: string
nb_users?: number
permissions?: {
[key: string]: {
controllers: {
[key: string]: {
[key: string]: {
enabled: boolean
policy: string
}
}
}
}
}
users?: unknown[]
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users_permissions_roles': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
roles: {
id: number
documentId: string
name: string
description: string | null
type: string
createdAt: string
updatedAt: string
publishedAt: string
nb_users?: number
permissions?: {
[key: string]: {
controllers: {
[key: string]: {
[key: string]: {
enabled: boolean
policy: string
}
}
}
}
}
users?: unknown[]
}[]
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/post/users_permissions_roles': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: {
content: {
'application/json': {
name: string
description?: string
type: string
permissions?: {
[key: string]: unknown
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
ok: boolean
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/put/users_permissions_roles_by_role': {
parameters: {
query?: never
header?: never
path: {
role: string
}
cookie?: never
}
requestBody?: {
content: {
'application/json': {
name?: string
description?: string
type?: string
permissions?: {
[key: string]: unknown
}
}
}
}
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
ok: boolean
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/delete/users_permissions_roles_by_role': {
parameters: {
query?: never
header?: never
path: {
role: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
ok: boolean
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'users-permissions/get/users_permissions_permissions': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': {
permissions: {
[key: string]: {
controllers: {
[key: string]: {
[key: string]: {
enabled: boolean
policy: string
}
}
}
}
}
}
}
}
/** @description Bad request */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
}