admin/softclick-cms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2ed71cfa309eb84962486232de72b827fc2cbdd7
softclick-cms/public/swagger-spec.json
Zotov Ivan Yuryevich 2ed71cfa30 add content, add swagger
2026-04-05 15:06:27 +03:00

10437 lines
363 KiB
JSON
Raw Blame History

{
"openapi": "3.1.0",
"x-powered-by": "strapi",
"x-strapi-version": "5.41.1",
"info": {
"title": "cms",
"description": "API documentation for cms v0.1.0",
"version": "0.1.0"
},
"paths": {
"/categories": {
"get": {
"operationId": "category/get/categories",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"vendors"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"vendors"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "An integer field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.023Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVendorVendorDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"category"
]
},
"post": {
"operationId": "category/post/categories",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"vendors"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"vendors"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "An integer field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.031Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVendorVendorDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"category"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "A float field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.030Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/categories/{id}": {
"get": {
"operationId": "category/get/categories_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"vendors"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"vendors"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "An integer field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.029Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVendorVendorDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"category"
]
},
"put": {
"operationId": "category/put/categories_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"vendors"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"vendors"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "An integer field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.033Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVendorVendorDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"category"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "A float field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.032Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "category/delete/categories_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"vendors"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"vendors"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"comment",
"group",
"sortOrder",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "An integer field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.034Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVendorVendorDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"category"
]
}
},
"/home-page": {
"get": {
"operationId": "home-page/get/home_page",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"sections"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"sections"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.036Z",
"type": "string"
},
"sections": {
"description": "A dynamic zone field",
"type": "array",
"items": {}
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"home-page"
]
},
"put": {
"operationId": "home-page/put/home_page",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"sections"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"sections"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.038Z",
"type": "string"
},
"sections": {
"description": "A dynamic zone field",
"type": "array",
"items": {}
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"home-page"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.036Z",
"type": "string"
},
"sections": {
"description": "A dynamic zone field",
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "home-page/delete/home_page",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"sections"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"sections"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.039Z",
"type": "string"
},
"sections": {
"description": "A dynamic zone field",
"type": "array",
"items": {}
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"home-page"
]
}
},
"/site-config": {
"get": {
"operationId": "site-config/get/site_config",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.040Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"site-config"
]
},
"put": {
"operationId": "site-config/put/site_config",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.041Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"site-config"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.040Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "site-config/delete/site_config",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.041Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"site-config"
]
}
},
"/vendors": {
"get": {
"operationId": "vendor/get/vendors",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"categories"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"categories"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.043Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedProductEntry"
}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCategoryCategoryDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"vendor"
]
},
"post": {
"operationId": "vendor/post/vendors",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"categories"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"categories"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.045Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedProductEntry"
}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCategoryCategoryDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"vendor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.045Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"slug",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/vendors/{id}": {
"get": {
"operationId": "vendor/get/vendors_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"categories"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"categories"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.044Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedProductEntry"
}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCategoryCategoryDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"vendor"
]
},
"put": {
"operationId": "vendor/put/vendors_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"categories"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"categories"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.048Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedProductEntry"
}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCategoryCategoryDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"vendor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.048Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "vendor/delete/vendors_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"categories"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"categories"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"slug",
"title",
"description",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "hasPublishedVersion",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"true",
"false"
]
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.049Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedProductEntry"
}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCategoryCategoryDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"vendor"
]
}
},
"/content-type-builder/content-types": {
"get": {
"operationId": "content-type-builder/get/content_type_builder_content_types",
"parameters": [
{
"name": "kind",
"in": "query",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"enum": [
"collectionType",
"singleType"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"plugin": {
"type": "string"
},
"apiID": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"singularName": {
"type": "string"
},
"pluralName": {
"type": "string"
},
"description": {
"type": "string"
},
"draftAndPublish": {
"type": "boolean"
},
"kind": {
"type": "string",
"enum": [
"collectionType",
"singleType"
]
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"visible": {
"type": "boolean"
},
"restrictRelationsTo": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"options": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reviewWorkflows": {
"type": "boolean"
},
"populateCreatorFields": {
"type": "boolean"
},
"comment": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"displayName",
"singularName",
"pluralName",
"description",
"draftAndPublish",
"kind",
"attributes",
"visible",
"restrictRelationsTo"
],
"additionalProperties": false
}
},
"required": [
"uid",
"apiID",
"schema"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/content-type-builder/content-types/{uid}": {
"get": {
"operationId": "content-type-builder/get/content_type_builder_content_types_by_uid",
"parameters": [
{
"name": "uid",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"plugin": {
"type": "string"
},
"apiID": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"singularName": {
"type": "string"
},
"pluralName": {
"type": "string"
},
"description": {
"type": "string"
},
"draftAndPublish": {
"type": "boolean"
},
"kind": {
"type": "string",
"enum": [
"collectionType",
"singleType"
]
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"visible": {
"type": "boolean"
},
"restrictRelationsTo": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"options": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reviewWorkflows": {
"type": "boolean"
},
"populateCreatorFields": {
"type": "boolean"
},
"comment": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"displayName",
"singularName",
"pluralName",
"description",
"draftAndPublish",
"kind",
"attributes",
"visible",
"restrictRelationsTo"
],
"additionalProperties": false
}
},
"required": [
"uid",
"apiID",
"schema"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/content-type-builder/components": {
"get": {
"operationId": "content-type-builder/get/content_type_builder_components",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
},
"category": {
"type": "string"
},
"apiId": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"connection": {
"type": "string"
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"displayName",
"description",
"attributes"
],
"additionalProperties": false
}
},
"required": [
"uid",
"category",
"apiId",
"schema"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/content-type-builder/components/{uid}": {
"get": {
"operationId": "content-type-builder/get/content_type_builder_components_by_uid",
"parameters": [
{
"name": "uid",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
},
"category": {
"type": "string"
},
"apiId": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"connection": {
"type": "string"
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"displayName",
"description",
"attributes"
],
"additionalProperties": false
}
},
"required": [
"uid",
"category",
"apiId",
"schema"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/email": {
"post": {
"operationId": "email/post/email",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"email"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"cc": {
"type": "string"
},
"bcc": {
"type": "string"
},
"replyTo": {
"type": "string"
},
"subject": {
"type": "string"
},
"text": {
"type": "string"
},
"html": {
"type": "string"
}
},
"required": [
"to",
"subject",
"text"
],
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
},
"/upload": {
"post": {
"operationId": "upload/post/upload",
"parameters": [
{
"name": "id",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
}
},
"/upload/files": {
"get": {
"operationId": "upload/get/upload_files",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the results by specified fields",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Apply filters to the query",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
}
},
"/upload/files/{id}": {
"get": {
"operationId": "upload/get/upload_files_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
},
"delete": {
"operationId": "upload/delete/upload_files_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
}
},
"/i18n/locales": {
"get": {
"operationId": "i18n/get/i18n_locales",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"code": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"id",
"documentId",
"name",
"code",
"createdAt",
"updatedAt",
"publishedAt",
"isDefault"
],
"additionalProperties": false
}
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"i18n"
]
}
},
"/connect/(.*)": {
"get": {
"operationId": "users-permissions/get/connect_____",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/local": {
"post": {
"operationId": "users-permissions/post/auth_local",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"jwt": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"jwt",
"user"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"identifier",
"password"
],
"additionalProperties": false
}
}
}
}
}
},
"/auth/local/register": {
"post": {
"operationId": "users-permissions/post/auth_local_register",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"jwt": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"jwt",
"user"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"user"
],
"additionalProperties": false
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string"
}
},
"required": [
"username",
"email",
"password"
],
"additionalProperties": false
}
}
}
}
}
},
"/auth/{provider}/callback": {
"get": {
"operationId": "users-permissions/get/auth_by_provider_callback",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"jwt": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"jwt",
"user"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/forgot-password": {
"post": {
"operationId": "users-permissions/post/auth_forgot_password",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"required": [
"email"
],
"additionalProperties": false
}
}
}
}
}
},
"/auth/reset-password": {
"post": {
"operationId": "users-permissions/post/auth_reset_password",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"jwt": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"jwt",
"user"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"code": {
"type": "string"
},
"password": {
"type": "string"
},
"passwordConfirmation": {
"type": "string"
}
},
"required": [
"code",
"password",
"passwordConfirmation"
],
"additionalProperties": false
}
}
}
}
}
},
"/auth/email-confirmation": {
"get": {
"operationId": "users-permissions/get/auth_email_confirmation",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/send-email-confirmation": {
"post": {
"operationId": "users-permissions/post/auth_send_email_confirmation",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"email": {
"type": "string"
},
"sent": {
"type": "boolean"
}
},
"required": [
"email",
"sent"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"required": [
"email"
],
"additionalProperties": false
}
}
}
}
}
},
"/auth/change-password": {
"post": {
"operationId": "users-permissions/post/auth_change_password",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"jwt": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"jwt",
"user"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"currentPassword": {
"type": "string"
},
"password": {
"type": "string"
},
"passwordConfirmation": {
"type": "string"
}
},
"required": [
"currentPassword",
"password",
"passwordConfirmation"
],
"additionalProperties": false
}
}
}
}
}
},
"/auth/refresh": {
"post": {
"operationId": "users-permissions/post/auth_refresh",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/logout": {
"post": {
"operationId": "users-permissions/post/auth_logout",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users/count": {
"get": {
"operationId": "users-permissions/get/users_count",
"parameters": [
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Apply filters to the query",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "number"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users": {
"get": {
"operationId": "users-permissions/get/users",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the results by specified fields",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Apply filters to the query",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"post": {
"operationId": "users-permissions/post/users",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string"
},
"role": {
"type": "number"
}
},
"required": [
"username",
"email",
"password"
],
"additionalProperties": false
}
}
}
}
}
},
"/users/me": {
"get": {
"operationId": "users-permissions/get/users_me",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users/{id}": {
"get": {
"operationId": "users-permissions/get/users_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"put": {
"operationId": "users-permissions/put/users_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string"
},
"role": {
"type": "number"
}
},
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "users-permissions/delete/users_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"type",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
}
},
"required": [
"id",
"documentId",
"username",
"email",
"provider",
"confirmed",
"blocked",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users-permissions/roles/{id}": {
"get": {
"operationId": "users-permissions/get/users_permissions_roles_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
},
"nb_users": {
"type": "number"
},
"permissions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"controllers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"policy": {
"type": "string"
}
},
"required": [
"enabled",
"policy"
],
"additionalProperties": false
}
}
}
},
"required": [
"controllers"
],
"additionalProperties": false
}
},
"users": {
"type": "array",
"items": {}
}
},
"required": [
"id",
"documentId",
"name",
"description",
"type",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"role"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users-permissions/roles": {
"get": {
"operationId": "users-permissions/get/users_permissions_roles",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"documentId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"type": "string"
},
"nb_users": {
"type": "number"
},
"permissions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"controllers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"policy": {
"type": "string"
}
},
"required": [
"enabled",
"policy"
],
"additionalProperties": false
}
}
}
},
"required": [
"controllers"
],
"additionalProperties": false
}
},
"users": {
"type": "array",
"items": {}
}
},
"required": [
"id",
"documentId",
"name",
"description",
"type",
"createdAt",
"updatedAt",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"roles"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"post": {
"operationId": "users-permissions/post/users_permissions_roles",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"permissions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"name",
"type"
],
"additionalProperties": false
}
}
}
}
}
},
"/users-permissions/roles/{role}": {
"put": {
"operationId": "users-permissions/put/users_permissions_roles_by_role",
"parameters": [
{
"name": "role",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"permissions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "users-permissions/delete/users_permissions_roles_by_role",
"parameters": [
{
"name": "role",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users-permissions/permissions": {
"get": {
"operationId": "users-permissions/get/users_permissions_permissions",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"permissions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"controllers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"policy": {
"type": "string"
}
},
"required": [
"enabled",
"policy"
],
"additionalProperties": false
}
}
}
},
"required": [
"controllers"
],
"additionalProperties": false
}
}
},
"required": [
"permissions"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
}
},
"components": {
"schemas": {
"SharedProductEntry": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
}
},
"required": [
"title"
],
"additionalProperties": false,
"id": "SharedProductEntry"
},
"ApiCategoryCategoryDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"comment": {
"description": "A string field",
"type": "string"
},
"group": {
"description": "An enum field",
"type": "string",
"enum": [
"service",
"solution"
]
},
"sortOrder": {
"description": "An integer field",
"default": 0,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.027Z",
"type": "string"
},
"vendors": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVendorVendorDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"group",
"sortOrder",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiCategoryCategoryDocument"
},
"ApiVendorVendorDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"slug": {
"description": "A UID field",
"type": "string"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2026-04-05T08:39:04.025Z",
"type": "string"
},
"products": {
"description": "A component field",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedProductEntry"
}
},
"categories": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCategoryCategoryDocument"
}
}
},
"required": [
"documentId",
"id",
"slug",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiVendorVendorDocument"
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink