{
"openapi": "3.0.0",
"info": {
"description": "## Getting started\n\nThis API Documentation reflects the endpoints defined in your [Flotiq](https://flotiq.com) account.\nThe documentation is generated using an OpenAPI schema describing the API, which can be obtained in several flavors:\n\n- [OAS 3.0/3.1](https://api.flotiq.com/api/v1/open-api-schema.json?auth_token=REPLACE_KEY_VALUE)\n - without hydration, will not expand relations between content types (this is the default version which provides maximum compatibility with downstream systems)\n - with hydration, pass [hydrate=1](https://api.flotiq.com/api/v1/open-api-schema.json?auth_token=REPLACE_KEY_VALUE&hydrate=1) - use this for a better type support in exported OpenAPI schemas\n - without system endpoints, pass [user_only=1](https://api.flotiq.com/api/v1/open-api-schema.json?auth_token=REPLACE_KEY_VALUE&hydrate=1&user_only=1) - use this to only include your endpoints, without system ones\n - for version 3.1, pass [version=3.1](https://api.flotiq.com/api/v1/open-api-schema.json?auth_token=REPLACE_KEY_VALUE&version=3.1)\n- [OAS 2.0](https://api.flotiq.com/api/v1/open-api-schema.json?auth_token=REPLACE_KEY_VALUE&version=2) - provided for compatibility with several older systems\n\nCheck Flotiq documentation for more information about [Flotiq OpenAPI capabilities](https://flotiq.com/docs/API/open-api-schema/), instructions how to generate code and other useful tips.\n\n### Access to data\n\nThere are several methods that you can use to access your data:\n * Live API docs - available via Try it out button available next to each endpoint \n * Copying example code on the right side of each endpoint\n * By downloading the SDKs available in multiple languages.\n * By downloading the Postman collection and importing it into Postman.\n\n\n Each of these methods is described in length in the [user documentation](https://flotiq.com/docs/).\n\n ### Authorization\n\n In order to make use of the provided documentation, example code, SDKs and so on - you will need to pull out your API key. We recommend that you start with the ReadOnly API Key which will allow you to make all the `GET` requests but will error-out when you try to modify content. Please remember to replace the key for `POST`, `PUT` and `DELETE` calls.\n\n It's also possible to use scoped API keys - you can create those in the API keys section of the Flotiq user interface. This will allow you to create a key that only authorizes access to a specific content type (or a set of content types, if you choose so). Read more about how to use and create API keys in the [API keys documentation](https://flotiq.com/docs/API/).\n\n ## Object access\n\n Once you define a Content Type it will become available in your Content API as a set of endpoints that will allow you to work with objects:\n\n * create\n * list\n * update\n * delete\n * batch create\n * retrieve single object.\n\n### Hydration\n\n When you build Content Types that have relation to others your objects will optionally support hydration of related entities. The endpoints that support object retrieval accept a `hydrate` parameter, which can be used to easily fetch hydrated objects. Since this breaks the standard REST concepts - it's not enabled by default, but it's a very handy feature that allows to reduce the amount of HTTP requests sent over the wire and we strongly recommend to use it.",
"title": "Flotiq User API",
"version": "2.0.1",
"contact": {
"name": "Flotiq Developers",
"email": "hello@flotiq.com",
"url": "https://flotiq.com"
},
"x-logo": {
"url": "https://editor.flotiq.com/images/fq-logo.svg",
"altText": "Flotiq User API"
}
},
"x-tagGroups":[
{
"name": "User API",
"tags": [
"Content: About",
"Content: Contact",
"Content: Contact form",
"Content: Media (internal)",
"Content: Project",
"Content: Tag (internal)",
"Search API", "Media"
]
}
],
"servers": [
{
"url": "https://api.flotiq.com",
"description": "Flotiq Live"
}
],
"security": [
{
"HeaderApiKeyAuth": []
}
],
"components": {
"securitySchemes": {
"HeaderApiKeyAuth": {
"description": "Personal Auth token generated for user in Headless CMS application",
"type": "apiKey",
"in": "header",
"name": "X-AUTH-TOKEN"
}
},
"schemas": {
"AbstractContentTypeSchemaDefinition": {
"type": "object",
"properties": {
"id": {"type":"string","description":"Unique ID of the object","pattern":"^[a-zA-Z0-9-_.,:=!?#$%&(\\`\\\u2019\\{\\}\" ]*$"},
"internal": {"type":"object","description":"Immutable object containing system information, it will be automatically generated on object creation and regenerated on updates.","additionalProperties":false,"required":["createdAt","updatedAt","deletedAt","contentType"],"properties":{"contentType":{"type":"string","description":"Name of Content Type Definition of object"},"createdAt":{"type":"string","description":"Date and time of creation of Content Object, in ISO 8601 date format"},"updatedAt":{"type":"string","description":"Date and time of last update of Content Object, in ISO 8601 date format"},"deletedAt":{"type":"string","description":"Date and time of deletion of Content Object, in ISO 8601 date format"},"workflowState":{"type":"string","description":"Information about object's current state in workflow"},"status":{"type":"string","description":"Information about object's current status. Available states: draft, public, modified"},"objectTitle":{"type":"string","description":"Object title"},"latestVersion":{"type":"number","description":"Latest version of the Content Object"},"workflowPublicVersion":{"type":"number","description":"number of latest published version of Content Object"},"workflowPublishedAt":{"type":"string","description":"publication date of latest publish version of Content Object"},"publishedAt":{"type":"string","description":"Publication date"},"scheduledAtTimeZone":{"type":"string","description":"string with tz timezone name (np. Europe\/Warsaw)"},"publicVersion":{"type":"number","description":"number of latest published version of Content Object"}}}
},
"required": [
"id"
]
},
"AbstractContentTypeSchemaDefinitionWithoutInternal": {
"type": "object",
"properties": {
"id": {"type":"string","description":"Unique ID of the object","pattern":"^[a-zA-Z0-9-_.,:=!?#$%&(\\`\\\u2019\\{\\}\" ]*$"}
},
"required": [
"id"
]
},
"DataSource": {"type":"object","description":"Represents link between data stored internally inside CMS or external","additionalProperties":false,"properties":{"dataUrl":{"type":"string"},"type":{"type":"string","enum":["internal","external"],"default":"internal"}},"required":["dataUrl","type"]},
"SystemListProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"total_count",
"count",
"total_pages",
"current_page"
],
"properties": {
"total_count": {
"type": "number",
"example": 1
},
"count": {
"type": "number",
"example": 1
},
"total_pages": {
"type": "number",
"example": 1
},
"current_page": {
"type": "number",
"example": 1
}
}
},
"BatchResponseError": {
"type": "object",
"additionalProperties": false,
"properties": {
"batch_total_count": {
"type": "number"
},
"batch_success_count": {
"type": "number"
},
"batch_error_count": {
"type": "number"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"errors": {
"type": "object",
"properties": {
"name": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {"batch_total_count":2,"batch_success_count":0,"batch_error_count":2,"errors":[{"id":"test-1","errors":{"name":["The property name is required"]}},{"id":"test-2","errors":{"name":["The property name is required"]}}]}
},
"BatchResponseSuccess": {
"type": "object",
"additionalProperties": false,
"properties": {
"batch_total_count": {
"type": "number"
},
"batch_success_count": {
"type": "number"
},
"batch_error_count": {
"type": "number"
},
"errors": {
"type": "array",
"items": {
"type": "object"
}
}
},
"example": {"batch_total_count":2,"batch_success_count":2,"batch_error_count":0,"errors":[]}
},
"404Response": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"message": {
"type": "string"
}
},
"example": {"code":404,"massage":"Not found"}
},
"401Response": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"message": {
"type": "string"
}
},
"example": {"code":401,"massage":"Unauthorized"}
},
"403Response": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"data": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"code":403,"massage":"Access denied or quota limit exceeded"}
}
,
"aboutWithoutInternal":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinitionWithoutInternal"},{"type":"object","properties":{"name":{"type":"string","description":""},"team":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"position":{"type":"string"}}},"description":""},"story":{"type":"string","description":""},"journey":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}}},"description":""},"team_title":{"type":"string","description":""},"description":{"type":"string","description":""},"story_image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"description":""},"story_title":{"type":"string","description":""},"mission_item":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"description":""},"journey_title":{"type":"string","description":""},"mission_title":{"type":"string","description":""},"__translations":{"type":"array","items":{"type":"object","required":["__language"],"properties":{"name":{"type":"string"},"team":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"position":{"type":"string"}}}},"story":{"type":"string"},"journey":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}}}},"__language":{"type":"string","default":"en","minLength":1},"team_title":{"type":"string"},"description":{"type":"string"},"story_image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"story_title":{"type":"string"},"mission_item":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"journey_title":{"type":"string"},"mission_title":{"type":"string"},"team_description":{"type":"string"},"mission_description":{"type":"string"}}},"description":""},"team_description":{"type":"string","description":""},"mission_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"about-1","name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}},
"about":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","description":""},"team":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"}},"position":{"type":"string"}}},"description":""},"story":{"type":"string","description":""},"journey":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}}},"description":""},"team_title":{"type":"string","description":""},"description":{"type":"string","description":""},"story_image":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"},"description":""},"story_title":{"type":"string","description":""},"mission_item":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"description":""},"journey_title":{"type":"string","description":""},"mission_title":{"type":"string","description":""},"__translations":{"type":"array","items":{"type":"object","required":["__language"],"properties":{"name":{"type":"string"},"team":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"}},"position":{"type":"string"}}}},"story":{"type":"string"},"journey":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}}}},"__language":{"type":"string","default":"en","minLength":1},"team_title":{"type":"string"},"description":{"type":"string"},"story_image":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"}},"story_title":{"type":"string"},"mission_item":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"journey_title":{"type":"string"},"mission_title":{"type":"string"},"team_description":{"type":"string"},"mission_description":{"type":"string"}}},"description":""},"team_description":{"type":"string","description":""},"mission_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"about-1","internal":{"contentType":"about","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}},
"aboutWithoutRequired":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","description":""},"team":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"position":{"type":"string"}}},"description":""},"story":{"type":"string","description":""},"journey":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}}},"description":""},"team_title":{"type":"string","description":""},"description":{"type":"string","description":""},"story_image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"description":""},"story_title":{"type":"string","description":""},"mission_item":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"description":""},"journey_title":{"type":"string","description":""},"mission_title":{"type":"string","description":""},"__translations":{"type":"array","items":{"type":"object","required":["__language"],"properties":{"name":{"type":"string"},"team":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"position":{"type":"string"}}}},"story":{"type":"string"},"journey":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}}}},"__language":{"type":"string","default":"en","minLength":1},"team_title":{"type":"string"},"description":{"type":"string"},"story_image":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"story_title":{"type":"string"},"mission_item":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"journey_title":{"type":"string"},"mission_title":{"type":"string"},"team_description":{"type":"string"},"mission_description":{"type":"string"}}},"description":""},"team_description":{"type":"string","description":""},"mission_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"about-1","internal":{"contentType":"about","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}},
"aboutList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/about"
}
}
}
}
]
},
"aboutVersionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"$ref": "#/components/schemas/versionsList"
}
]
}
,
"contactWithoutInternal":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinitionWithoutInternal"},{"type":"object","properties":{"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$","description":""},"phone":{"type":"string","description":""},"address":{"type":"string","description":""},"description":{"type":"string","description":""},"contact_title":{"type":"string","description":""},"__translations":{"type":"array","items":{"type":"object","required":["__language"],"properties":{"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$"},"phone":{"type":"string"},"address":{"type":"string"},"__language":{"type":"string","default":"en","minLength":1},"description":{"type":"string"},"contact_title":{"type":"string"},"business_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}}},"get_in_touch_title":{"type":"string"},"business_hours_title":{"type":"string"},"send_a_message_title":{"type":"string"},"get_in_touch_description":{"type":"string"},"send_a_message_description":{"type":"string"}}},"description":""},"business_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}},"description":""},"get_in_touch_title":{"type":"string","description":""},"business_hours_title":{"type":"string","description":""},"send_a_message_title":{"type":"string","description":""},"get_in_touch_description":{"type":"string","description":""},"send_a_message_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"contact-1","email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}},
"contact":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$","description":""},"phone":{"type":"string","description":""},"address":{"type":"string","description":""},"description":{"type":"string","description":""},"contact_title":{"type":"string","description":""},"__translations":{"type":"array","items":{"type":"object","required":["__language"],"properties":{"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$"},"phone":{"type":"string"},"address":{"type":"string"},"__language":{"type":"string","default":"en","minLength":1},"description":{"type":"string"},"contact_title":{"type":"string"},"business_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}}},"get_in_touch_title":{"type":"string"},"business_hours_title":{"type":"string"},"send_a_message_title":{"type":"string"},"get_in_touch_description":{"type":"string"},"send_a_message_description":{"type":"string"}}},"description":""},"business_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}},"description":""},"get_in_touch_title":{"type":"string","description":""},"business_hours_title":{"type":"string","description":""},"send_a_message_title":{"type":"string","description":""},"get_in_touch_description":{"type":"string","description":""},"send_a_message_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"contact-1","internal":{"contentType":"contact","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}},
"contactWithoutRequired":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$","description":""},"phone":{"type":"string","description":""},"address":{"type":"string","description":""},"description":{"type":"string","description":""},"contact_title":{"type":"string","description":""},"__translations":{"type":"array","items":{"type":"object","required":["__language"],"properties":{"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$"},"phone":{"type":"string"},"address":{"type":"string"},"__language":{"type":"string","default":"en","minLength":1},"description":{"type":"string"},"contact_title":{"type":"string"},"business_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}}},"get_in_touch_title":{"type":"string"},"business_hours_title":{"type":"string"},"send_a_message_title":{"type":"string"},"get_in_touch_description":{"type":"string"},"send_a_message_description":{"type":"string"}}},"description":""},"business_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}},"description":""},"get_in_touch_title":{"type":"string","description":""},"business_hours_title":{"type":"string","description":""},"send_a_message_title":{"type":"string","description":""},"get_in_touch_description":{"type":"string","description":""},"send_a_message_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"contact-1","internal":{"contentType":"contact","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}},
"contactList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact"
}
}
}
}
]
},
"contactVersionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"$ref": "#/components/schemas/versionsList"
}
]
}
,
"contact_formWithoutInternal":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinitionWithoutInternal"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""},"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$","minLength":1,"description":""},"question":{"type":"string","description":""}}}],"required":["name","email"],"additionalProperties":false,"example":{"id":"contact_form-1","name":"name","email":"email","question":"question"}},
"contact_form":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""},"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$","minLength":1,"description":""},"question":{"type":"string","description":""}}}],"required":["name","email"],"additionalProperties":false,"example":{"id":"contact_form-1","internal":{"contentType":"contact_form","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name","email":"email","question":"question"}},
"contact_formWithoutRequired":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""},"email":{"type":"string","pattern":"^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.+-]+?\\.[a-zA-Z]{2,}$","minLength":1,"description":""},"question":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"contact_form-1","internal":{"contentType":"contact_form","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name","email":"email","question":"question"}},
"contact_formList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact_form"
}
}
}
}
]
},
"contact_formVersionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"$ref": "#/components/schemas/versionsList"
}
]
}
,
"_mediaWithoutInternal":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinitionWithoutInternal"},{"type":"object","properties":{"alt":{"type":"string"},"url":{"type":"string","minLength":1},"size":{"type":"number"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0,"description":""},"type":{"type":"string","minLength":1},"title":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"source":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"mimeType":{"type":"string","minLength":1},"variants":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[_a-zA-Z0-9]+$","minLength":1},"trim":{"type":"object","required":["top","left"],"properties":{"top":{"type":"number","maximum":9999999,"minimum":0},"left":{"type":"number","maximum":9999999,"minimum":0},"right":{"type":"number","maximum":9999999,"minimum":0},"width":{"type":"number","maximum":9999999,"minimum":1},"bottom":{"type":"number","maximum":9999999,"minimum":0},"height":{"type":"number","maximum":9999999,"minimum":1}}}}},"minItems":0,"description":""},"extension":{"type":"string","minLength":1},"externalId":{"type":"string"}}}],"required":["fileName","mimeType","size","url","source","extension","type"],"additionalProperties":false,"example":{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925}},
"_media":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"alt":{"type":"string"},"url":{"type":"string","minLength":1},"size":{"type":"number"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/_tag"},"minItems":0,"description":""},"type":{"type":"string","minLength":1},"title":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"source":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"mimeType":{"type":"string","minLength":1},"variants":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[_a-zA-Z0-9]+$","minLength":1},"trim":{"type":"object","required":["top","left"],"properties":{"top":{"type":"number","maximum":9999999,"minimum":0},"left":{"type":"number","maximum":9999999,"minimum":0},"right":{"type":"number","maximum":9999999,"minimum":0},"width":{"type":"number","maximum":9999999,"minimum":1},"bottom":{"type":"number","maximum":9999999,"minimum":0},"height":{"type":"number","maximum":9999999,"minimum":1}}}}},"minItems":0,"description":""},"extension":{"type":"string","minLength":1},"externalId":{"type":"string"}}}],"required":["fileName","mimeType","size","url","source","extension","type"],"additionalProperties":false,"example":{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925,"internal":{"contentType":"_media","createdAt":"2025-02-06T10:24:27+00:00","updatedAt":"2025-02-06T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"example_image.png","latestVersion":1}}},
"_mediaWithoutRequired":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"alt":{"type":"string"},"url":{"type":"string","minLength":1},"size":{"type":"number"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0,"description":""},"type":{"type":"string","minLength":1},"title":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"source":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"mimeType":{"type":"string","minLength":1},"variants":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[_a-zA-Z0-9]+$","minLength":1},"trim":{"type":"object","required":["top","left"],"properties":{"top":{"type":"number","maximum":9999999,"minimum":0},"left":{"type":"number","maximum":9999999,"minimum":0},"right":{"type":"number","maximum":9999999,"minimum":0},"width":{"type":"number","maximum":9999999,"minimum":1},"bottom":{"type":"number","maximum":9999999,"minimum":0},"height":{"type":"number","maximum":9999999,"minimum":1}}}}},"minItems":0,"description":""},"extension":{"type":"string","minLength":1},"externalId":{"type":"string"}}}],"additionalProperties":false,"example":{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925,"internal":{"contentType":"_media","createdAt":"2025-02-06T10:24:27+00:00","updatedAt":"2025-02-06T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"example_image.png","latestVersion":1}}},
"_mediaList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_media"
}
}
}
}
]
},
"_mediaVersionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"$ref": "#/components/schemas/versionsList"
}
]
}
,
"projectWithoutInternal":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinitionWithoutInternal"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""},"slug":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":1,"description":""},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"description":""},"gallery":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0,"description":""},"description":{"type":"string","description":""},"headerImage":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0,"description":""},"__translations":{"type":"array","items":{"type":"object","required":["name","slug","__language"],"properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":1},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"gallery":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0},"__language":{"type":"string","default":"en","minLength":1},"description":{"type":"string"},"headerImage":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0},"short_description":{"type":"string"}}},"description":""},"short_description":{"type":"string","description":""}}}],"required":["name","slug"],"additionalProperties":false,"example":{"id":"project-1","name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}},
"project":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""},"slug":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":1,"description":""},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/_tag"},"description":""},"gallery":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"},"minItems":0,"description":""},"description":{"type":"string","description":""},"headerImage":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"},"minItems":0,"description":""},"__translations":{"type":"array","items":{"type":"object","required":["name","slug","__language"],"properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":1},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/_tag"}},"gallery":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"},"minItems":0},"__language":{"type":"string","default":"en","minLength":1},"description":{"type":"string"},"headerImage":{"type":"array","items":{"$ref":"#\/components\/schemas\/_media"},"minItems":0},"short_description":{"type":"string"}}},"description":""},"short_description":{"type":"string","description":""}}}],"required":["name","slug"],"additionalProperties":false,"example":{"id":"project-1","internal":{"contentType":"project","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}},
"projectWithoutRequired":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""},"slug":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":1,"description":""},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"description":""},"gallery":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0,"description":""},"description":{"type":"string","description":""},"headerImage":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0,"description":""},"__translations":{"type":"array","items":{"type":"object","required":["name","slug","__language"],"properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":1},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"}},"gallery":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0},"__language":{"type":"string","default":"en","minLength":1},"description":{"type":"string"},"headerImage":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSource"},"minItems":0},"short_description":{"type":"string"}}},"description":""},"short_description":{"type":"string","description":""}}}],"additionalProperties":false,"example":{"id":"project-1","internal":{"contentType":"project","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}},
"projectList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/project"
}
}
}
}
]
},
"projectVersionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"$ref": "#/components/schemas/versionsList"
}
]
}
,
"_tagWithoutInternal":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinitionWithoutInternal"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""}}}],"required":["name"],"additionalProperties":false,"example":{"id":"_tag-1","name":"name"}},
"_tag":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""}}}],"required":["name"],"additionalProperties":false,"example":{"id":"_tag-1","internal":{"contentType":"_tag","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name"}},
"_tagWithoutRequired":
{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":""}}}],"additionalProperties":false,"example":{"id":"_tag-1","internal":{"contentType":"_tag","createdAt":"2025-06-05T10:24:27+00:00","updatedAt":"2025-06-05T10:24:27+00:00","deletedAt":"","workflowState":"saved","objectTitle":"","latestVersion":1},"name":"name"}},
"_tagList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_tag"
}
}
}
}
]
},
"_tagVersionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"$ref": "#/components/schemas/versionsList"
}
]
}
,
"versionItem": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"deletedAt": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"current": {
"type": "boolean"
},
"version": {
"type": "number"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"resetPasswordAt": {
"type": "string"
},
"deletedAt": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"editor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"resetPasswordAt": {
"type": "string"
},
"deletedAt": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}
}
}
],
"required": [
"name"
],
"additionalProperties": false
,
"example": {"internal":{"contentType":"post","createdAt":"2021-10-07T13:20:17+00:00","updatedAt":"2021-10-07T13:20:17+00:00","deletedAt":""},"owner":{"username":"John","email":"john@example.com","firstName":"John","lastName":"Smith","roles":["ROLE_HEADLESS_ADMIN"],"language":"en","enabled":true,"resetPasswordAt":"2021-10-06T10:02:28.000000+0000","deletedAt":null,"createdAt":"2021-10-06T10:02:27.000000+0000","updatedAt":"2021-10-07T11:02:33.000000+0000"},"editor":{"username":"John","email":"john@example.com","firstName":"John","lastName":"Smith","roles":["ROLE_HEADLESS_ADMIN"],"language":"en","enabled":true,"resetPasswordAt":"2021-10-06T10:02:28.000000+0000","deletedAt":null,"createdAt":"2021-10-06T10:02:27.000000+0000","updatedAt":"2021-10-07T11:02:33.000000+0000"}}
},
"versionsList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemListProperties"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/versionItem"
}
}
}
}
]
}
}
}
,
"paths": {
"/api/v1/content/about": {
"get": {
"operationId": "About_list",
"summary": "List About objects",
"description": "List objects of About type.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0,
"example": 0
}
},
{
"in": "query",
"name": "filters",
"required": false,
"description": "List filters",
"schema": {
"type": "string",
"default": "{}",
"example": "{\"slug\":{\"type\":\"contains\",\"filter\":\"test\"},\"title\":{\"type\":\"contains\",\"filter\":\"test\"}}"
}
},
{
"in": "query",
"name": "ids[]",
"required": false,
"description": "Ids of objects to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/aboutList"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema":{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"filters":["Malformed filters json - Syntax error"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"post": {
"operationId": "About_create",
"summary": "Create a About object",
"description": "Allows you to create object of About type.
",
"tags": [
"Content\u003A\u0020About"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/aboutWithoutInternal"
},
"example": {"id":"about-1","name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/about"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
}
,
"/api/v1/content/about/{id}": {
"get": {
"operationId": "About_get",
"summary": "Get About object by Id",
"description": "Returns all information about About object.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "about-1"
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0
} }
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/about"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"put": {
"operationId": "About_update",
"summary": "Update existing About object",
"description": "Allows update of the About object, it has to have all fields, as this operation overwrites the object. All properties not included in the payload will be lost.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "about-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/aboutWithoutInternal"
},
"example": {"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/about"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"patch": {
"operationId": "About_patch",
"summary": "Update selected fields of About object",
"description": "Allows update of the About object, but it is unnecessary to specify all the object's properties. Properties not included in the payload will be completed with data from the database.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "about-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/aboutWithoutRequired"
},
"example": {"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/about"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"delete": {
"operationId": "About_delete",
"summary": "Delete a About object",
"description": "Removes About object.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "about-1"
}
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["This content object is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
}
,
"/api/v1/content/about/batch": {
"post": {
"operationId": "About_batchCreate",
"summary": "Create a batch of about objects",
"description": "Allows you to create or create and update up to 100 objects of About type.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "query",
"name": "updateExisting",
"required": false,
"description": "Overwrite existing objects",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aboutWithoutInternal"
}
},
"example": [
{"id":"about-1","name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"},
{"id":"about-2","name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
,
"patch": {
"operationId": "About_batchPatch",
"summary": "Update selected fields of a batch of objects",
"description": "Allows you to update up to 100 objects of About type.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aboutWithoutInternal"
}
},
"example": [
{"id":"about-1","name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"},
{"id":"about-2","name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","__translations":[{"name":"name","team":[{"name":"name","image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"position":"position"}],"story":"story","journey":[{"year":0,"title":"title","description":"description"}],"__language":"__language","team_title":"team_title","description":"description","story_image":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"story_title":"story_title","mission_item":[{"title":"title","description":"description"}],"journey_title":"journey_title","mission_title":"mission_title","team_description":"team_description","mission_description":"mission_description"}],"team_description":"team_description","mission_description":"mission_description"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
}
,
"/api/v1/content/about/batch-delete": {
"post": {
"operationId": "About_batchDelete",
"summary": "Delete a batch of About objects",
"description": "Allows you to delete up to 100 objects of About type.
Request body accepts an array of content object IDs that are to be deleted.
",
"tags": [
"Content\u003A\u0020About"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"about-1",
"about-2"
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedCount": {
"type": "number"
}
},
"example": {"deletedCount":2}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["Content object: \"about-1\" doesn't exist","Content object: \"about-2\" is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/about/{id}/version": {
"get": {
"operationId": "About_listVersion",
"summary": "List all versions of a About object",
"description": "List objects versions of About type.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "about-1"
},
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/aboutVersionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/about/{id}/version/{versionId}": {
"get": {
"operationId": "About_getVersions",
"summary": "Get a specific version of About object",
"description": "Return version of About object.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "about-1"
},
{
"in": "path",
"name": "versionId",
"required": true,
"description": "ContentObject version identifier",
"schema": {
"type": "string"
}
,
"example": "version-1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/about"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/about/removed": {
"get": {
"operationId": "About_getRemoved",
"summary": "Get removed object identifiers",
"description": "Get ids of removed About objects.
",
"tags": [
"Content\u003A\u0020About"
],
"parameters": [
{
"in": "query",
"name": "deletedAfter",
"required": false,
"description": "Date from which ids of removed objects should be returned",
"schema": {
"type": "string"
},
"example": "2020-01-01 12:00:00"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": ["about-1"]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedAfter" : {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"deletedAfter":["Wrong date format"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact": {
"get": {
"operationId": "Contact_list",
"summary": "List Contact objects",
"description": "List objects of Contact type.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0,
"example": 0
}
},
{
"in": "query",
"name": "filters",
"required": false,
"description": "List filters",
"schema": {
"type": "string",
"default": "{}",
"example": "{\"slug\":{\"type\":\"contains\",\"filter\":\"test\"},\"title\":{\"type\":\"contains\",\"filter\":\"test\"}}"
}
},
{
"in": "query",
"name": "ids[]",
"required": false,
"description": "Ids of objects to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contactList"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema":{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"filters":["Malformed filters json - Syntax error"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"post": {
"operationId": "Contact_create",
"summary": "Create a Contact object",
"description": "Allows you to create object of Contact type.
",
"tags": [
"Content\u003A\u0020Contact"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contactWithoutInternal"
},
"example": {"id":"contact-1","email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
}
,
"/api/v1/content/contact/{id}": {
"get": {
"operationId": "Contact_get",
"summary": "Get Contact object by Id",
"description": "Returns all information about Contact object.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact-1"
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0
} }
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"put": {
"operationId": "Contact_update",
"summary": "Update existing Contact object",
"description": "Allows update of the Contact object, it has to have all fields, as this operation overwrites the object. All properties not included in the payload will be lost.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contactWithoutInternal"
},
"example": {"email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"patch": {
"operationId": "Contact_patch",
"summary": "Update selected fields of Contact object",
"description": "Allows update of the Contact object, but it is unnecessary to specify all the object's properties. Properties not included in the payload will be completed with data from the database.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contactWithoutRequired"
},
"example": {"email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"delete": {
"operationId": "Contact_delete",
"summary": "Delete a Contact object",
"description": "Removes Contact object.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact-1"
}
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["This content object is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact/batch": {
"post": {
"operationId": "Contact_batchCreate",
"summary": "Create a batch of contact objects",
"description": "Allows you to create or create and update up to 100 objects of Contact type.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "query",
"name": "updateExisting",
"required": false,
"description": "Overwrite existing objects",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contactWithoutInternal"
}
},
"example": [
{"id":"contact-1","email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"},
{"id":"contact-2","email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
,
"patch": {
"operationId": "Contact_batchPatch",
"summary": "Update selected fields of a batch of objects",
"description": "Allows you to update up to 100 objects of Contact type.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contactWithoutInternal"
}
},
"example": [
{"id":"contact-1","email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"},
{"id":"contact-2","email":"email","phone":"phone","address":"address","description":"description","contact_title":"contact_title","__translations":[{"email":"email","phone":"phone","address":"address","__language":"__language","description":"description","contact_title":"contact_title","business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}],"business_hours":[{"day":"day","hours":"hours"}],"get_in_touch_title":"get_in_touch_title","business_hours_title":"business_hours_title","send_a_message_title":"send_a_message_title","get_in_touch_description":"get_in_touch_description","send_a_message_description":"send_a_message_description"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact/batch-delete": {
"post": {
"operationId": "Contact_batchDelete",
"summary": "Delete a batch of Contact objects",
"description": "Allows you to delete up to 100 objects of Contact type.
Request body accepts an array of content object IDs that are to be deleted.
",
"tags": [
"Content\u003A\u0020Contact"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"contact-1",
"contact-2"
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedCount": {
"type": "number"
}
},
"example": {"deletedCount":2}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["Content object: \"contact-1\" doesn't exist","Content object: \"contact-2\" is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact/{id}/version": {
"get": {
"operationId": "Contact_listVersion",
"summary": "List all versions of a Contact object",
"description": "List objects versions of Contact type.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact-1"
},
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contactVersionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/contact/{id}/version/{versionId}": {
"get": {
"operationId": "Contact_getVersions",
"summary": "Get a specific version of Contact object",
"description": "Return version of Contact object.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact-1"
},
{
"in": "path",
"name": "versionId",
"required": true,
"description": "ContentObject version identifier",
"schema": {
"type": "string"
}
,
"example": "version-1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/contact/removed": {
"get": {
"operationId": "Contact_getRemoved",
"summary": "Get removed object identifiers",
"description": "Get ids of removed Contact objects.
",
"tags": [
"Content\u003A\u0020Contact"
],
"parameters": [
{
"in": "query",
"name": "deletedAfter",
"required": false,
"description": "Date from which ids of removed objects should be returned",
"schema": {
"type": "string"
},
"example": "2020-01-01 12:00:00"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": ["contact-1"]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedAfter" : {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"deletedAfter":["Wrong date format"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact_form": {
"get": {
"operationId": "ContactForm_list",
"summary": "List Contact_form objects",
"description": "List objects of Contact\u0020form type.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0,
"example": 0
}
},
{
"in": "query",
"name": "filters",
"required": false,
"description": "List filters",
"schema": {
"type": "string",
"default": "{}",
"example": "{\"slug\":{\"type\":\"contains\",\"filter\":\"test\"},\"title\":{\"type\":\"contains\",\"filter\":\"test\"}}"
}
},
{
"in": "query",
"name": "ids[]",
"required": false,
"description": "Ids of objects to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_formList"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema":{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"filters":["Malformed filters json - Syntax error"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"post": {
"operationId": "ContactForm_create",
"summary": "Create a Contact_form object",
"description": "Allows you to create object of Contact\u0020form type.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_formWithoutInternal"
},
"example": {"id":"contact_form-1","name":"name","email":"email","question":"question"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_form"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"],"email":["The property email is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
}
,
"/api/v1/content/contact_form/{id}": {
"get": {
"operationId": "ContactForm_get",
"summary": "Get Contact_form object by Id",
"description": "Returns all information about Contact\u0020form object.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact_form-1"
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0
} }
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_form"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"put": {
"operationId": "ContactForm_update",
"summary": "Update existing Contact_form object",
"description": "Allows update of the Contact\u0020form object, it has to have all fields, as this operation overwrites the object. All properties not included in the payload will be lost.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact_form-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_formWithoutInternal"
},
"example": {"name":"name","email":"email","question":"question"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_form"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"],"email":["The property email is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"patch": {
"operationId": "ContactForm_patch",
"summary": "Update selected fields of Contact_form object",
"description": "Allows update of the Contact\u0020form object, but it is unnecessary to specify all the object's properties. Properties not included in the payload will be completed with data from the database.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact_form-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_formWithoutRequired"
},
"example": {"name":"name","email":"email","question":"question"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_form"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"],"email":["The property email is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"delete": {
"operationId": "ContactForm_delete",
"summary": "Delete a Contact_form object",
"description": "Removes Contact\u0020form object.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact_form-1"
}
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["This content object is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact_form/batch": {
"post": {
"operationId": "ContactForm_batchCreate",
"summary": "Create a batch of contact_form objects",
"description": "Allows you to create or create and update up to 100 objects of Contact\u0020form type.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "query",
"name": "updateExisting",
"required": false,
"description": "Overwrite existing objects",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact_formWithoutInternal"
}
},
"example": [
{"id":"contact_form-1","name":"name","email":"email","question":"question"},
{"id":"contact_form-2","name":"name","email":"email","question":"question"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
,
"patch": {
"operationId": "ContactForm_batchPatch",
"summary": "Update selected fields of a batch of objects",
"description": "Allows you to update up to 100 objects of Contact\u0020form type.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact_formWithoutInternal"
}
},
"example": [
{"id":"contact_form-1","name":"name","email":"email","question":"question"},
{"id":"contact_form-2","name":"name","email":"email","question":"question"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact_form/batch-delete": {
"post": {
"operationId": "ContactForm_batchDelete",
"summary": "Delete a batch of Contact_form objects",
"description": "Allows you to delete up to 100 objects of Contact\u0020form type.
Request body accepts an array of content object IDs that are to be deleted.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"contact_form-1",
"contact_form-2"
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedCount": {
"type": "number"
}
},
"example": {"deletedCount":2}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["Content object: \"contact_form-1\" doesn't exist","Content object: \"contact_form-2\" is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/contact_form/{id}/version": {
"get": {
"operationId": "ContactForm_listVersion",
"summary": "List all versions of a Contact_form object",
"description": "List objects versions of Contact\u0020form type.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact_form-1"
},
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_formVersionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/contact_form/{id}/version/{versionId}": {
"get": {
"operationId": "ContactForm_getVersions",
"summary": "Get a specific version of Contact_form object",
"description": "Return version of Contact\u0020form object.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "contact_form-1"
},
{
"in": "path",
"name": "versionId",
"required": true,
"description": "ContentObject version identifier",
"schema": {
"type": "string"
}
,
"example": "version-1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_form"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/contact_form/removed": {
"get": {
"operationId": "ContactForm_getRemoved",
"summary": "Get removed object identifiers",
"description": "Get ids of removed Contact\u0020form objects.
",
"tags": [
"Content\u003A\u0020Contact\u0020form"
],
"parameters": [
{
"in": "query",
"name": "deletedAfter",
"required": false,
"description": "Date from which ids of removed objects should be returned",
"schema": {
"type": "string"
},
"example": "2020-01-01 12:00:00"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": ["contact_form-1"]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedAfter" : {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"deletedAfter":["Wrong date format"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_media": {
"get": {
"operationId": "Media_list",
"summary": "List _media objects",
"description": "List objects of Media\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0,
"example": 0
}
},
{
"in": "query",
"name": "filters",
"required": false,
"description": "List filters",
"schema": {
"type": "string",
"default": "{}",
"example": "{\"slug\":{\"type\":\"contains\",\"filter\":\"test\"},\"title\":{\"type\":\"contains\",\"filter\":\"test\"}}"
}
},
{
"in": "query",
"name": "ids[]",
"required": false,
"description": "Ids of objects to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_mediaList"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema":{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"filters":["Malformed filters json - Syntax error"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"post": {
"operationId": "Media_create",
"summary": "Create a _media object",
"description": "Allows you to create object of Media\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_mediaWithoutInternal"
},
"example": {"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_media"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"fileName":{"type":"array","items":{"type":"string"}},"mimeType":{"type":"array","items":{"type":"string"}},"size":{"type":"array","items":{"type":"string"}},"url":{"type":"array","items":{"type":"string"}},"source":{"type":"array","items":{"type":"string"}},"extension":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}},"width":{"type":"array","items":{"type":"string"}},"height":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"fileName":["The property fileName is required","Must be at least 1 characters long"],"mimeType":["The property mimeType is required","Must be at least 1 characters long"],"size":["The property size is required","String value found, but a number is required"],"url":["The property url is required","Must be at least 1 characters long"],"source":["The property source is required","Must be at least 1 characters long","The value does not match possible options"],"extension":["The property extension is required","Must be at least 1 characters long"],"type":["The property type is required","Must be at least 1 characters long","The value does not match possible options"],"width":["String value found, but a number is required"],"height":["String value found, but a number is required"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
}
,
"/api/v1/content/_media/{id}": {
"get": {
"operationId": "Media_get",
"summary": "Get _media object by Id",
"description": "Returns all information about Media\u0020\u0028internal\u0029 object.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_media-1"
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0
} }
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_media"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"put": {
"operationId": "Media_update",
"summary": "Update existing _media object",
"description": "Allows update of the Media\u0020\u0028internal\u0029 object, it has to have all fields, as this operation overwrites the object. All properties not included in the payload will be lost.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_media-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_mediaWithoutInternal"
},
"example": {"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_media"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"fileName":{"type":"array","items":{"type":"string"}},"mimeType":{"type":"array","items":{"type":"string"}},"size":{"type":"array","items":{"type":"string"}},"url":{"type":"array","items":{"type":"string"}},"source":{"type":"array","items":{"type":"string"}},"extension":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}},"width":{"type":"array","items":{"type":"string"}},"height":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"fileName":["The property fileName is required","Must be at least 1 characters long"],"mimeType":["The property mimeType is required","Must be at least 1 characters long"],"size":["The property size is required","String value found, but a number is required"],"url":["The property url is required","Must be at least 1 characters long"],"source":["The property source is required","Must be at least 1 characters long","The value does not match possible options"],"extension":["The property extension is required","Must be at least 1 characters long"],"type":["The property type is required","Must be at least 1 characters long","The value does not match possible options"],"width":["String value found, but a number is required"],"height":["String value found, but a number is required"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"patch": {
"operationId": "Media_patch",
"summary": "Update selected fields of _media object",
"description": "Allows update of the Media\u0020\u0028internal\u0029 object, but it is unnecessary to specify all the object's properties. Properties not included in the payload will be completed with data from the database.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_media-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_mediaWithoutRequired"
},
"example": {"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_media"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"fileName":{"type":"array","items":{"type":"string"}},"mimeType":{"type":"array","items":{"type":"string"}},"size":{"type":"array","items":{"type":"string"}},"url":{"type":"array","items":{"type":"string"}},"source":{"type":"array","items":{"type":"string"}},"extension":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}},"width":{"type":"array","items":{"type":"string"}},"height":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"fileName":["The property fileName is required","Must be at least 1 characters long"],"mimeType":["The property mimeType is required","Must be at least 1 characters long"],"size":["The property size is required","String value found, but a number is required"],"url":["The property url is required","Must be at least 1 characters long"],"source":["The property source is required","Must be at least 1 characters long","The value does not match possible options"],"extension":["The property extension is required","Must be at least 1 characters long"],"type":["The property type is required","Must be at least 1 characters long","The value does not match possible options"],"width":["String value found, but a number is required"],"height":["String value found, but a number is required"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"delete": {
"operationId": "Media_delete",
"summary": "Delete a _media object",
"description": "Removes Media\u0020\u0028internal\u0029 object.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_media-1"
}
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["This content object is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_media/batch": {
"post": {
"operationId": "Media_batchCreate",
"summary": "Create a batch of _media objects",
"description": "Allows you to create or create and update up to 100 objects of Media\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "query",
"name": "updateExisting",
"required": false,
"description": "Overwrite existing objects",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_mediaWithoutInternal"
}
},
"example": [
{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925},
{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
,
"patch": {
"operationId": "Media_batchPatch",
"summary": "Update selected fields of a batch of objects",
"description": "Allows you to update up to 100 objects of Media\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_mediaWithoutInternal"
}
},
"example": [
{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925},
{"id":"_media-698d20aa-193a-47b3-be4d-550c1aab47e7","extension":"png","fileName":"example_image.png","mimeType":"image\/png","size":87258,"type":"image","source":"disk","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-641775","type":"internal"}],"variants":[{"name":"square","trim":{"top":10,"right":10,"bottom":10,"left":10,"width":10,"height":10}}],"externalId":"","url":"\/image\/0x0\/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png","height":517,"width":925}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_media/batch-delete": {
"post": {
"operationId": "Media_batchDelete",
"summary": "Delete a batch of _media objects",
"description": "Allows you to delete up to 100 objects of Media\u0020\u0028internal\u0029 type.
Request body accepts an array of content object IDs that are to be deleted.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"_media-1",
"_media-2"
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedCount": {
"type": "number"
}
},
"example": {"deletedCount":2}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["Content object: \"_media-1\" doesn't exist","Content object: \"_media-2\" is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_media/{id}/version": {
"get": {
"operationId": "Media_listVersion",
"summary": "List all versions of a _media object",
"description": "List objects versions of Media\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_media-1"
},
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_mediaVersionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/_media/{id}/version/{versionId}": {
"get": {
"operationId": "Media_getVersions",
"summary": "Get a specific version of _media object",
"description": "Return version of Media\u0020\u0028internal\u0029 object.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_media-1"
},
{
"in": "path",
"name": "versionId",
"required": true,
"description": "ContentObject version identifier",
"schema": {
"type": "string"
}
,
"example": "version-1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_media"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/_media/removed": {
"get": {
"operationId": "Media_getRemoved",
"summary": "Get removed object identifiers",
"description": "Get ids of removed Media\u0020\u0028internal\u0029 objects.
",
"tags": [
"Content\u003A\u0020Media\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "query",
"name": "deletedAfter",
"required": false,
"description": "Date from which ids of removed objects should be returned",
"schema": {
"type": "string"
},
"example": "2020-01-01 12:00:00"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": ["_media-1"]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedAfter" : {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"deletedAfter":["Wrong date format"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/project": {
"get": {
"operationId": "Project_list",
"summary": "List Project objects",
"description": "List objects of Project type.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0,
"example": 0
}
},
{
"in": "query",
"name": "filters",
"required": false,
"description": "List filters",
"schema": {
"type": "string",
"default": "{}",
"example": "{\"slug\":{\"type\":\"contains\",\"filter\":\"test\"},\"title\":{\"type\":\"contains\",\"filter\":\"test\"}}"
}
},
{
"in": "query",
"name": "ids[]",
"required": false,
"description": "Ids of objects to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectList"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema":{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"filters":["Malformed filters json - Syntax error"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"post": {
"operationId": "Project_create",
"summary": "Create a Project object",
"description": "Allows you to create object of Project type.
",
"tags": [
"Content\u003A\u0020Project"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectWithoutInternal"
},
"example": {"id":"project-1","name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/project"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"slug":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"],"slug":["The property slug is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
}
,
"/api/v1/content/project/{id}": {
"get": {
"operationId": "Project_get",
"summary": "Get Project object by Id",
"description": "Returns all information about Project object.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "project-1"
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0
} }
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/project"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"put": {
"operationId": "Project_update",
"summary": "Update existing Project object",
"description": "Allows update of the Project object, it has to have all fields, as this operation overwrites the object. All properties not included in the payload will be lost.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "project-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectWithoutInternal"
},
"example": {"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/project"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"slug":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"],"slug":["The property slug is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"patch": {
"operationId": "Project_patch",
"summary": "Update selected fields of Project object",
"description": "Allows update of the Project object, but it is unnecessary to specify all the object's properties. Properties not included in the payload will be completed with data from the database.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "project-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectWithoutRequired"
},
"example": {"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/project"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"slug":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"],"slug":["The property slug is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"delete": {
"operationId": "Project_delete",
"summary": "Delete a Project object",
"description": "Removes Project object.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "project-1"
}
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["This content object is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
}
,
"/api/v1/content/project/batch": {
"post": {
"operationId": "Project_batchCreate",
"summary": "Create a batch of project objects",
"description": "Allows you to create or create and update up to 100 objects of Project type.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "query",
"name": "updateExisting",
"required": false,
"description": "Overwrite existing objects",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/projectWithoutInternal"
}
},
"example": [
{"id":"project-1","name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"},
{"id":"project-2","name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
,
"patch": {
"operationId": "Project_batchPatch",
"summary": "Update selected fields of a batch of objects",
"description": "Allows you to update up to 100 objects of Project type.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/projectWithoutInternal"
}
},
"example": [
{"id":"project-1","name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"},
{"id":"project-2","name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__translations":[{"name":"name","slug":"slug","tags":[{"dataUrl":"\/api\/v1\/content\/_tag\/_tag-1","type":"internal"}],"gallery":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"__language":"__language","description":"description","headerImage":[{"dataUrl":"\/api\/v1\/content\/_media\/_media-1","type":"internal"}],"short_description":"short_description"}],"short_description":"short_description"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
}
,
"/api/v1/content/project/batch-delete": {
"post": {
"operationId": "Project_batchDelete",
"summary": "Delete a batch of Project objects",
"description": "Allows you to delete up to 100 objects of Project type.
Request body accepts an array of content object IDs that are to be deleted.
",
"tags": [
"Content\u003A\u0020Project"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"project-1",
"project-2"
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedCount": {
"type": "number"
}
},
"example": {"deletedCount":2}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["Content object: \"project-1\" doesn't exist","Content object: \"project-2\" is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/project/{id}/version": {
"get": {
"operationId": "Project_listVersion",
"summary": "List all versions of a Project object",
"description": "List objects versions of Project type.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "project-1"
},
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectVersionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/project/{id}/version/{versionId}": {
"get": {
"operationId": "Project_getVersions",
"summary": "Get a specific version of Project object",
"description": "Return version of Project object.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "project-1"
},
{
"in": "path",
"name": "versionId",
"required": true,
"description": "ContentObject version identifier",
"schema": {
"type": "string"
}
,
"example": "version-1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/project"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/project/removed": {
"get": {
"operationId": "Project_getRemoved",
"summary": "Get removed object identifiers",
"description": "Get ids of removed Project objects.
",
"tags": [
"Content\u003A\u0020Project"
],
"parameters": [
{
"in": "query",
"name": "deletedAfter",
"required": false,
"description": "Date from which ids of removed objects should be returned",
"schema": {
"type": "string"
},
"example": "2020-01-01 12:00:00"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": ["project-1"]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedAfter" : {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"deletedAfter":["Wrong date format"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_tag": {
"get": {
"operationId": "Tag_list",
"summary": "List _tag objects",
"description": "List objects of Tag\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0,
"example": 0
}
},
{
"in": "query",
"name": "filters",
"required": false,
"description": "List filters",
"schema": {
"type": "string",
"default": "{}",
"example": "{\"slug\":{\"type\":\"contains\",\"filter\":\"test\"},\"title\":{\"type\":\"contains\",\"filter\":\"test\"}}"
}
},
{
"in": "query",
"name": "ids[]",
"required": false,
"description": "Ids of objects to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tagList"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema":{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"filters":["Malformed filters json - Syntax error"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"post": {
"operationId": "Tag_create",
"summary": "Create a _tag object",
"description": "Allows you to create object of Tag\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tagWithoutInternal"
},
"example": {"id":"_tag-1","name":"name"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tag"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
}
,
"/api/v1/content/_tag/{id}": {
"get": {
"operationId": "Tag_get",
"summary": "Get _tag object by Id",
"description": "Returns all information about Tag\u0020\u0028internal\u0029 object.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_tag-1"
},
{
"in": "query",
"name": "hydrate",
"required": false,
"description": "Should hydrate relations of object, for now only one level of hydration is possible",
"schema": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0
} }
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tag"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
,
"put": {
"operationId": "Tag_update",
"summary": "Update existing _tag object",
"description": "Allows update of the Tag\u0020\u0028internal\u0029 object, it has to have all fields, as this operation overwrites the object. All properties not included in the payload will be lost.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_tag-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tagWithoutInternal"
},
"example": {"name":"name"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tag"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"patch": {
"operationId": "Tag_patch",
"summary": "Update selected fields of _tag object",
"description": "Allows update of the Tag\u0020\u0028internal\u0029 object, but it is unnecessary to specify all the object's properties. Properties not included in the payload will be completed with data from the database.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_tag-1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tagWithoutRequired"
},
"example": {"name":"name"}
}
}
},
"responses":
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tag"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"name":{"type":"array","items":{"type":"string"}},"id":{"type":"array","items":{"type":"string"}}},
"example":
{"id":["This value is already used"],"name":["The property name is required","Must be at least 1 characters long"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
} }
,
"delete": {
"operationId": "Tag_delete",
"summary": "Delete a _tag object",
"description": "Removes Tag\u0020\u0028internal\u0029 object.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_tag-1"
}
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["This content object is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_tag/batch": {
"post": {
"operationId": "Tag_batchCreate",
"summary": "Create a batch of _tag objects",
"description": "Allows you to create or create and update up to 100 objects of Tag\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "query",
"name": "updateExisting",
"required": false,
"description": "Overwrite existing objects",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_tagWithoutInternal"
}
},
"example": [
{"id":"_tag-1","name":"name"},
{"id":"_tag-2","name":"name"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
,
"patch": {
"operationId": "Tag_batchPatch",
"summary": "Update selected fields of a batch of objects",
"description": "Allows you to update up to 100 objects of Tag\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_tagWithoutInternal"
}
},
"example": [
{"id":"_tag-1","name":"name"},
{"id":"_tag-2","name":"name"}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseSuccess"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"403": {
"description": "Access denied or quota limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/403Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_tag/batch-delete": {
"post": {
"operationId": "Tag_batchDelete",
"summary": "Delete a batch of _tag objects",
"description": "Allows you to delete up to 100 objects of Tag\u0020\u0028internal\u0029 type.
Request body accepts an array of content object IDs that are to be deleted.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"_tag-1",
"_tag-2"
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedCount": {
"type": "number"
}
},
"example": {"deletedCount":2}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"errors":["Content object: \"_tag-1\" doesn't exist","Content object: \"_tag-2\" is used in another content object."]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
,
"/api/v1/content/_tag/{id}/version": {
"get": {
"operationId": "Tag_listVersion",
"summary": "List all versions of a _tag object",
"description": "List objects versions of Tag\u0020\u0028internal\u0029 type.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_tag-1"
},
{
"in": "query",
"name": "page",
"required": false,
"description": "Listing page number, 1-based",
"schema": {
"type": "number",
"default": 1,
"minimum": 1,
"example": 1
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Page limit",
"schema": {
"type": "number",
"default": 20,
"minimum": 1,
"example": 20
}
},
{
"in": "query",
"name": "order_by",
"required": false,
"description": "Order by field",
"schema": {
"type": "string",
"default": "internal.createdAt",
"example": "internal.createdAt"
}
},
{
"in": "query",
"name": "order_direction",
"required": false,
"description": "Order direction",
"schema": {
"type": "string",
"default": "asc",
"example": "asc"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tagVersionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/_tag/{id}/version/{versionId}": {
"get": {
"operationId": "Tag_getVersions",
"summary": "Get a specific version of _tag object",
"description": "Return version of Tag\u0020\u0028internal\u0029 object.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "ContentObject identifier",
"schema": {
"type": "string"
},
"example": "_tag-1"
},
{
"in": "path",
"name": "versionId",
"required": true,
"description": "ContentObject version identifier",
"schema": {
"type": "string"
}
,
"example": "version-1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_tag"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Response"
}
}
}
} }
}
}
,
"/api/v1/content/_tag/removed": {
"get": {
"operationId": "Tag_getRemoved",
"summary": "Get removed object identifiers",
"description": "Get ids of removed Tag\u0020\u0028internal\u0029 objects.
",
"tags": [
"Content\u003A\u0020Tag\u0020\u0028internal\u0029"
],
"parameters": [
{
"in": "query",
"name": "deletedAfter",
"required": false,
"description": "Date from which ids of removed objects should be returned",
"schema": {
"type": "string"
},
"example": "2020-01-01 12:00:00"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": ["_tag-1"]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deletedAfter" : {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {"deletedAfter":["Wrong date format"]}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Response"
}
}
}
}
}
}
}
}
}