{ "openapi": "3.1.0", "x-powered-by": "strapi", "x-strapi-version": "5.60.0", "info": { "title": "my-app", "description": "API documentation for my-app v0.1.0", "version": "0.1.0" }, "servers": [ { "url": "", "description": "Default server" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "JWT Bearer token for authentication" } }, "schemas": { "PluginUploadFileDocument": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "alternativeText": { "description": "A text field", "type": "string" }, "caption": { "description": "A text field", "type": "string" }, "focalPoint": { "description": "A JSON field" }, "width": { "description": "An integer field", "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "height": { "description": "An integer field", "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "formats": { "description": "A JSON field" }, "hash": { "description": "A string field", "type": "string" }, "ext": { "description": "A string field", "type": "string" }, "mime": { "description": "A string field", "type": "string" }, "size": { "description": "A decimal field", "type": "number" }, "url": { "description": "A text field", "type": "string" }, "previewUrl": { "description": "A text field", "type": "string" }, "provider": { "description": "A string field", "type": "string" }, "provider_metadata": { "description": "A JSON field" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.238Z", "description": "A datetime field", "type": "string" }, "related": {} }, "required": [ "documentId", "id", "name", "hash", "mime", "size", "url", "provider", "publishedAt", "related" ], "additionalProperties": false }, "ApiCategoryCategoryDocument": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID 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": { "default": "2026-10-30T12:45:25.239Z", "description": "A datetime field", "type": "string" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "ApiArticleArticleDocument": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.239Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "author": { "description": "A relational field", "$ref": "#/components/schemas/ApiAuthorAuthorDocument" }, "category": { "description": "A relational field", "$ref": "#/components/schemas/ApiCategoryCategoryDocument" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "ApiAuthorAuthorDocument": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.238Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "SharedSeoEntry": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "metaTitle": { "description": "A string field", "type": "string" }, "metaDescription": { "description": "A text field", "type": "string" }, "shareImage": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" } }, "required": [ "metaTitle", "metaDescription" ], "additionalProperties": false } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/about": { "get": { "operationId": "about/get/about", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.234Z", "description": "A datetime field", "type": "string" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "about" ] }, "put": { "operationId": "about/put/about", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.235Z", "description": "A datetime field", "type": "string" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "about" ], "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" }, "publishedAt": { "default": "2026-10-30T12:45:25.412Z", "description": "A datetime field", "type": "string" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } }, "delete": { "operationId": "about/delete/about", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.235Z", "description": "A datetime field", "type": "string" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "about" ] } }, "/articles": { "get": { "operationId": "article/get/articles", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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[withCount]", "in": "query", "required": false, "schema": { "description": "Include total count in response", "type": "boolean" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[page]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Page number (1-based)" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[pageSize]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Number of entries per page" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[start]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Number of entries to skip" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[limit]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Maximum number of entries to return" }, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, { "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, { "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } } } ], "description": "Sort the result" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "status", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "draft", "published" ], "description": "Fetch documents based on their status. Default to \"published\" if not specified." }, "x-strapi-serialize": "querystring" }, { "name": "publicationFilter", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "never-published", "has-published-version", "modified", "unmodified", "never-published-document", "has-published-version-document", "published-without-draft", "published-with-draft" ], "description": "Derived publication cohort: pair-scoped (per documentId+locale), document-scoped variants (-document), or published-slice diagnostics (published-without-draft / published-with-draft)" }, "x-strapi-serialize": "querystring" }, { "name": "hasPublishedVersion", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ], "description": "[Deprecated: prefer publicationFilter] Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.236Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "author": { "description": "A relational field", "$ref": "#/components/schemas/ApiAuthorAuthorDocument" }, "category": { "description": "A relational field", "$ref": "#/components/schemas/ApiCategoryCategoryDocument" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "pagination": { "anyOf": [ { "type": "object", "properties": { "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "start", "limit" ], "additionalProperties": false } ] } }, "required": [ "pagination" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "article" ] }, "post": { "operationId": "article/post/articles", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "status", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "draft", "published" ], "description": "Fetch documents based on their status. Default to \"published\" if not specified." }, "x-strapi-serialize": "querystring" }, { "name": "publicationFilter", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "never-published", "has-published-version", "modified", "unmodified", "never-published-document", "has-published-version-document", "published-without-draft", "published-with-draft" ], "description": "Derived publication cohort: pair-scoped (per documentId+locale), document-scoped variants (-document), or published-slice diagnostics (published-without-draft / published-with-draft)" }, "x-strapi-serialize": "querystring" }, { "name": "hasPublishedVersion", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ], "description": "[Deprecated: prefer publicationFilter] Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.241Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "author": { "description": "A relational field", "$ref": "#/components/schemas/ApiAuthorAuthorDocument" }, "category": { "description": "A relational field", "$ref": "#/components/schemas/ApiCategoryCategoryDocument" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "article" ], "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" }, "slug": { "description": "A UID field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.425Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field" }, "author": { "description": "A relational field", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "category": { "description": "A relational field", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "publishedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "/articles/{id}": { "get": { "operationId": "article/get/articles_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, { "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, { "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } } } ], "description": "Sort the result" }, "x-strapi-serialize": "querystring" }, { "name": "status", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "draft", "published" ], "description": "Fetch documents based on their status. Default to \"published\" if not specified." }, "x-strapi-serialize": "querystring" }, { "name": "publicationFilter", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "never-published", "has-published-version", "modified", "unmodified", "never-published-document", "has-published-version-document", "published-without-draft", "published-with-draft" ], "description": "Derived publication cohort: pair-scoped (per documentId+locale), document-scoped variants (-document), or published-slice diagnostics (published-without-draft / published-with-draft)" }, "x-strapi-serialize": "querystring" }, { "name": "hasPublishedVersion", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ], "description": "[Deprecated: prefer publicationFilter] Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.240Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "author": { "description": "A relational field", "$ref": "#/components/schemas/ApiAuthorAuthorDocument" }, "category": { "description": "A relational field", "$ref": "#/components/schemas/ApiCategoryCategoryDocument" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "article" ] }, "put": { "operationId": "article/put/articles_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "status", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "draft", "published" ], "description": "Fetch documents based on their status. Default to \"published\" if not specified." }, "x-strapi-serialize": "querystring" }, { "name": "publicationFilter", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "never-published", "has-published-version", "modified", "unmodified", "never-published-document", "has-published-version-document", "published-without-draft", "published-with-draft" ], "description": "Derived publication cohort: pair-scoped (per documentId+locale), document-scoped variants (-document), or published-slice diagnostics (published-without-draft / published-with-draft)" }, "x-strapi-serialize": "querystring" }, { "name": "hasPublishedVersion", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ], "description": "[Deprecated: prefer publicationFilter] Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.241Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "author": { "description": "A relational field", "$ref": "#/components/schemas/ApiAuthorAuthorDocument" }, "category": { "description": "A relational field", "$ref": "#/components/schemas/ApiCategoryCategoryDocument" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "article" ], "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" }, "slug": { "description": "A UID field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.437Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field" }, "author": { "description": "A relational field", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "category": { "description": "A relational field", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } }, "delete": { "operationId": "article/delete/articles_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cover", "author", "category", "blocks" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "title", "description", "slug", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "x-strapi-serialize": "querystring" }, { "name": "status", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "draft", "published" ], "description": "Fetch documents based on their status. Default to \"published\" if not specified." }, "x-strapi-serialize": "querystring" }, { "name": "publicationFilter", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "never-published", "has-published-version", "modified", "unmodified", "never-published-document", "has-published-version-document", "published-without-draft", "published-with-draft" ], "description": "Derived publication cohort: pair-scoped (per documentId+locale), document-scoped variants (-document), or published-slice diagnostics (published-without-draft / published-with-draft)" }, "x-strapi-serialize": "querystring" }, { "name": "hasPublishedVersion", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ], "description": "[Deprecated: prefer publicationFilter] Filter documents by whether they have a published version. Use with status=draft to find documents that have never been published" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": { "description": "A string field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.242Z", "description": "A datetime field", "type": "string" }, "cover": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "author": { "description": "A relational field", "$ref": "#/components/schemas/ApiAuthorAuthorDocument" }, "category": { "description": "A relational field", "$ref": "#/components/schemas/ApiCategoryCategoryDocument" }, "blocks": { "description": "A dynamic zone field", "type": "array", "items": {} } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "article" ] } }, "/authors": { "get": { "operationId": "author/get/authors", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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[withCount]", "in": "query", "required": false, "schema": { "description": "Include total count in response", "type": "boolean" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[page]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Page number (1-based)" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[pageSize]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Number of entries per page" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[start]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Number of entries to skip" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[limit]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Maximum number of entries to return" }, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, { "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } } } ], "description": "Sort the result" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "avatar", "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "avatar", "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.245Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "pagination": { "anyOf": [ { "type": "object", "properties": { "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "start", "limit" ], "additionalProperties": false } ] } }, "required": [ "pagination" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "author" ] }, "post": { "operationId": "author/post/authors", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "avatar", "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "avatar", "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.246Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "author" ], "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.448Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field" }, "articles": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "publishedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "/authors/{id}": { "get": { "operationId": "author/get/authors_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "avatar", "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "avatar", "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, { "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } } } ], "description": "Sort the result" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.245Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "author" ] }, "put": { "operationId": "author/put/authors_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "avatar", "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "avatar", "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.246Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "author" ], "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.454Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field" }, "articles": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } }, "delete": { "operationId": "author/delete/authors_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "avatar", "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "avatar", "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "email", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "email": { "description": "A string field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.247Z", "description": "A datetime field", "type": "string" }, "avatar": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "author" ] } }, "/categories": { "get": { "operationId": "category/get/categories", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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[withCount]", "in": "query", "required": false, "schema": { "description": "Include total count in response", "type": "boolean" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[page]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Page number (1-based)" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[pageSize]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Number of entries per page" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[start]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Number of entries to skip" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[limit]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Maximum number of entries to return" }, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, { "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] } }, { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } } } ], "description": "Sort the result" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID 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": { "default": "2026-10-30T12:45:25.247Z", "description": "A datetime field", "type": "string" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "pagination": { "anyOf": [ { "type": "object", "properties": { "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "start", "limit" ], "additionalProperties": false } ] } }, "required": [ "pagination" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "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", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "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": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID 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": { "default": "2026-10-30T12:45:25.248Z", "description": "A datetime field", "type": "string" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "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": { "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.462Z", "description": "A datetime field", "type": "string" }, "articles": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "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", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "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": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, { "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] } }, { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } } } ], "description": "Sort the result" }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID 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": { "default": "2026-10-30T12:45:25.248Z", "description": "A datetime field", "type": "string" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "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", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "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": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID 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": { "default": "2026-10-30T12:45:25.248Z", "description": "A datetime field", "type": "string" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "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": { "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID field", "type": "string" }, "description": { "description": "A text field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.467Z", "description": "A datetime field", "type": "string" }, "articles": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "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", "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "name", "slug", "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": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "articles" ] }, { "type": "array", "items": { "type": "string", "enum": [ "articles" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "name", "slug", "description", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "name": { "description": "A string field", "type": "string" }, "slug": { "description": "A UID 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": { "default": "2026-10-30T12:45:25.249Z", "description": "A datetime field", "type": "string" }, "articles": { "description": "A relational field", "type": "array", "items": { "$ref": "#/components/schemas/ApiArticleArticleDocument" } } }, "required": [ "documentId", "id", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "category" ] } }, "/global": { "get": { "operationId": "global/get/global", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "siteName", "siteDescription", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "favicon", "defaultSeo" ] }, { "type": "array", "items": { "type": "string", "enum": [ "favicon", "defaultSeo" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string", "enum": [ "siteName", "siteDescription", "createdAt", "updatedAt", "publishedAt" ] }, "additionalProperties": {}, "description": "Filters to apply to the query" }, "style": "deepObject", "explode": true, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "siteName": { "description": "A string field", "type": "string" }, "siteDescription": { "description": "A text field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.249Z", "description": "A datetime field", "type": "string" }, "favicon": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "defaultSeo": { "description": "A component field", "$ref": "#/components/schemas/SharedSeoEntry" } }, "required": [ "documentId", "id", "siteName", "siteDescription", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "global" ] }, "put": { "operationId": "global/put/global", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "siteName", "siteDescription", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "favicon", "defaultSeo" ] }, { "type": "array", "items": { "type": "string", "enum": [ "favicon", "defaultSeo" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "siteName": { "description": "A string field", "type": "string" }, "siteDescription": { "description": "A text field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.250Z", "description": "A datetime field", "type": "string" }, "favicon": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "defaultSeo": { "description": "A component field", "$ref": "#/components/schemas/SharedSeoEntry" } }, "required": [ "documentId", "id", "siteName", "siteDescription", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "global" ], "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "siteName": { "description": "A string field", "type": "string" }, "siteDescription": { "description": "A text field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.474Z", "description": "A datetime field", "type": "string" }, "favicon": { "description": "A media field" }, "defaultSeo": { "description": "A component field" } }, "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } }, "delete": { "operationId": "global/delete/global", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "readOnly": true, "description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones", "type": "array", "items": { "type": "string", "enum": [ "siteName", "siteDescription", "createdAt", "updatedAt", "publishedAt" ] } }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "readOnly": true, "description": "Populate all the first level relations, components, files, and dynamic zones for the entry", "type": "string", "const": "*" }, { "readOnly": true, "description": "Populate a single relation, component, file, or dynamic zone", "type": "string", "enum": [ "favicon", "defaultSeo" ] }, { "type": "array", "items": { "type": "string", "enum": [ "favicon", "defaultSeo" ] }, "description": "Populate a selection of multiple relations, components, files, or dynamic zones" } ] }, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The document ID, represented by a UUID" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "siteName": { "description": "A string field", "type": "string" }, "siteDescription": { "description": "A text field", "type": "string" }, "createdAt": { "description": "A datetime field", "type": "string" }, "updatedAt": { "description": "A datetime field", "type": "string" }, "publishedAt": { "default": "2026-10-30T12:45:25.250Z", "description": "A datetime field", "type": "string" }, "favicon": { "description": "A media field", "$ref": "#/components/schemas/PluginUploadFileDocument" }, "defaultSeo": { "description": "A component field", "$ref": "#/components/schemas/SharedSeoEntry" } }, "required": [ "documentId", "id", "siteName", "siteDescription", "publishedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error" } }, "tags": [ "global" ] } }, "/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", "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string" } ] }, "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Select specific fields to return in the response" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } ], "description": "Specify which relations to populate in the response" }, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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" ] } } } ], "description": "Sort the results by specified fields" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[withCount]", "in": "query", "required": false, "schema": { "description": "Include total count in response", "type": "boolean" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[page]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Page number (1-based)" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[pageSize]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Number of entries per page" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[start]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Number of entries to skip" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[limit]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Maximum number of entries to return" }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Apply filters to the query" }, "style": "deepObject", "explode": true, "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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/page": { "get": { "operationId": "upload/get/upload_files_page", "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Select specific fields to return in the response" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } ], "description": "Specify which relations to populate in the response" }, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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" ] } } } ], "description": "Sort the results by specified fields" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[withCount]", "in": "query", "required": false, "schema": { "description": "Include total count in response", "type": "boolean" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[page]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Page number (1-based)" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[pageSize]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Number of entries per page" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[start]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Number of entries to skip" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[limit]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Maximum number of entries to return" }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Apply filters to the query" }, "style": "deepObject", "explode": true, "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": { "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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 } }, "meta": { "type": "object", "properties": { "pagination": { "anyOf": [ { "type": "object", "properties": { "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "start", "limit" ], "additionalProperties": false } ] } }, "required": [ "pagination" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "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", "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string" } ] } }, { "name": "fields", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Select specific fields to return in the response" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } ], "description": "Specify which relations to populate in the response" }, "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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", "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string" } ] } } ], "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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" ] } }, "/auth/sessions": { "get": { "operationId": "users-permissions/get/auth_sessions", "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/sessions/{sessionId}": { "delete": { "operationId": "users-permissions/delete/auth_sessions_by_sessionId", "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", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Apply filters to the query" }, "style": "deepObject", "explode": true, "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", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Select specific fields to return in the response" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } ], "description": "Specify which relations to populate in the response" }, "x-strapi-serialize": "querystring" }, { "name": "sort", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "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" ] } } } ], "description": "Sort the results by specified fields" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[withCount]", "in": "query", "required": false, "schema": { "description": "Include total count in response", "type": "boolean" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[page]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Page number (1-based)" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[pageSize]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Number of entries per page" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[start]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Number of entries to skip" }, "x-strapi-serialize": "querystring" }, { "name": "pagination[limit]", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Maximum number of entries to return" }, "x-strapi-serialize": "querystring" }, { "name": "filters", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Apply filters to the query" }, "style": "deepObject", "explode": true, "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": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "object", "properties": { "connect": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "documentId": { "type": "string" } }, "additionalProperties": false } }, "disconnect": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "documentId": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } ] } }, "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", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Select specific fields to return in the response" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } ], "description": "Specify which relations to populate in the response" }, "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", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Select specific fields to return in the response" }, "x-strapi-serialize": "querystring" }, { "name": "populate", "in": "query", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } ], "description": "Specify which relations to populate in the response" }, "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": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "object", "properties": { "connect": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "documentId": { "type": "string" } }, "additionalProperties": false } }, "disconnect": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "documentId": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } ] } }, "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" ] } } } }