mirror of
https://github.com/utopia-os/utopia-ui.git
synced 2025-12-12 23:36:00 +00:00
a599eddca6
* add optional request password button to login page * fix linting * fix linting * added field to backend config
25063 lines
693 KiB
JSON
25063 lines
693 KiB
JSON
{
|
|
"openapi": "3.0.1",
|
|
"info": {
|
|
"title": "Dynamic API Specification",
|
|
"description": "This is a dynamically generated API specification for all endpoints existing on the current project.",
|
|
"version": "11.7.2"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "http://localhost",
|
|
"description": "Your current Directus instance."
|
|
}
|
|
],
|
|
"paths": {
|
|
"/assets/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Assets"
|
|
],
|
|
"operationId": "getAsset",
|
|
"summary": "Get an Asset",
|
|
"description": "Image typed files can be dynamically resized and transformed to fit any need.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "The id of the file.",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"description": "The key of the asset size configured in settings.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "transforms",
|
|
"in": "query",
|
|
"description": "A JSON array of image transformations",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "download",
|
|
"in": "query",
|
|
"description": "Download the asset to your computer",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/login": {
|
|
"post": {
|
|
"summary": "Retrieve a Temporary Access Token",
|
|
"description": "Retrieve a Temporary Access Token",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "login",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"email",
|
|
"password"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"type": "string",
|
|
"example": "admin@example.com",
|
|
"description": "Email address of the user you're retrieving the access token for."
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"description": "Password of the user.",
|
|
"format": "password",
|
|
"example": "password"
|
|
},
|
|
"mode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"json",
|
|
"cookie",
|
|
"session"
|
|
],
|
|
"default": "json",
|
|
"description": "Whether to retrieve the refresh token in the JSON response, or in a httpOnly cookie."
|
|
},
|
|
"otp": {
|
|
"type": "string",
|
|
"description": "The user's one-time-password (if MFA is enabled)."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful authentification",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string",
|
|
"example": "eyJhbGciOiJI..."
|
|
},
|
|
"expires": {
|
|
"type": "integer",
|
|
"example": 900
|
|
},
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"example": "yuOJkjdPXMd..."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/refresh": {
|
|
"post": {
|
|
"summary": "Refresh Token",
|
|
"description": "Refresh a Temporary Access Token.",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "refresh",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"example": "eyJ0eXAiOiJKV...",
|
|
"description": "JWT access token you want to refresh. This token can't be expired."
|
|
},
|
|
"mode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"json",
|
|
"cookie",
|
|
"session"
|
|
],
|
|
"default": "json",
|
|
"description": "Whether to submit and retrieve the refresh token in the JSON response, or in a httpOnly cookie."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string",
|
|
"example": "eyJhbGciOiJI..."
|
|
},
|
|
"expires": {
|
|
"type": "integer",
|
|
"example": 900
|
|
},
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"example": "Gy-caJMpmGTA..."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/logout": {
|
|
"post": {
|
|
"summary": "Log Out",
|
|
"description": "Log Out",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "logout",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"example": "eyJ0eXAiOiJKV...",
|
|
"description": "The refresh token to invalidate. If you have the refresh token in a cookie through /auth/login, you don't have to submit it here."
|
|
},
|
|
"mode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"json",
|
|
"cookie",
|
|
"session"
|
|
],
|
|
"description": "Whether the refresh token is submitted in the JSON response, or in a httpOnly cookie."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request successful"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/password/request": {
|
|
"post": {
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "passwordRequest",
|
|
"summary": "Request a Password Reset",
|
|
"description": "Request a reset password email to be send.",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"type": "string",
|
|
"example": "admin@example.com",
|
|
"description": "Email address of the user you're requesting a reset for."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/password/reset": {
|
|
"post": {
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "passwordReset",
|
|
"summary": "Reset a Password",
|
|
"description": "The request a password reset endpoint sends an email with a link to the admin app which in turn uses this endpoint to allow the user to reset their password.",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"token",
|
|
"password"
|
|
],
|
|
"properties": {
|
|
"token": {
|
|
"type": "string",
|
|
"example": "eyJ0eXAiOiJKV1Qi...",
|
|
"description": "One-time use JWT token that is used to verify the user."
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "password",
|
|
"format": "password",
|
|
"description": "New password for the user."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/oauth": {
|
|
"get": {
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "oauth",
|
|
"summary": "List OAuth Providers",
|
|
"description": "List configured OAuth providers.",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"public": {
|
|
"type": "boolean"
|
|
},
|
|
"data": {
|
|
"type": "array",
|
|
"example": [
|
|
"github",
|
|
"facebook"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/oauth/{provider}": {
|
|
"get": {
|
|
"summary": "Authenticated using an OAuth provider",
|
|
"description": "Start OAuth flow using the specified provider",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"operationId": "oauthProvider",
|
|
"parameters": [
|
|
{
|
|
"name": "provider",
|
|
"in": "path",
|
|
"description": "Key of the activated OAuth provider.",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "redirect",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Where to redirect on successful login.<br/>If set the authentication details are set inside cookies otherwise a JSON is returned.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"public": {
|
|
"type": "boolean"
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"token": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/schema/snapshot": {
|
|
"get": {
|
|
"summary": "Retrieve Schema Snapshot",
|
|
"description": "Retrieve the current schema. This endpoint is only available to admin users.",
|
|
"operationId": "schemaSnapshot",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Export"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Schema"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"text/yaml": {
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Schema"
|
|
]
|
|
}
|
|
},
|
|
"/schema/apply": {
|
|
"post": {
|
|
"summary": "Apply Schema Difference",
|
|
"description": "Update the instance's schema by passing the diff previously retrieved via `/schema/diff` endpoint in the JSON request body or a JSON/YAML file. This endpoint is only available to admin users.",
|
|
"operationId": "schemaApply",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Diff"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"204": {
|
|
"description": "Successful request"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Schema"
|
|
]
|
|
}
|
|
},
|
|
"/schema/diff": {
|
|
"post": {
|
|
"summary": "Retrieve Schema Difference",
|
|
"description": "Compare the current instance's schema against the schema snapshot in JSON request body or a JSON/YAML file and retrieve the difference. This endpoint is only available to admin users.",
|
|
"operationId": "schemaDiff",
|
|
"parameters": [
|
|
{
|
|
"name": "force",
|
|
"description": "Bypass version and database vendor restrictions.",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Schema"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Diff"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"204": {
|
|
"description": "No schema difference."
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Schema"
|
|
]
|
|
}
|
|
},
|
|
"/server/info": {
|
|
"get": {
|
|
"summary": "System Info",
|
|
"description": "Perform a system status check and return the options.",
|
|
"operationId": "serverInfo",
|
|
"parameters": [
|
|
{
|
|
"description": "The first time you create a project, the provided token will be saved and required for subsequent project installs. It can also be found and configured in `/config/__api.json` on your server.",
|
|
"in": "query",
|
|
"name": "super_admin_token",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Server"
|
|
]
|
|
}
|
|
},
|
|
"/server/ping": {
|
|
"get": {
|
|
"summary": "Ping",
|
|
"description": "Ping, pong. Ping.. pong.",
|
|
"operationId": "ping",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/text": {
|
|
"schema": {
|
|
"type": "string",
|
|
"pattern": "pong",
|
|
"example": "pong"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Server"
|
|
]
|
|
}
|
|
},
|
|
"/utils/hash/generate": {
|
|
"post": {
|
|
"summary": "Hash a string",
|
|
"description": "Generate a hash for a given string.",
|
|
"operationId": "hash-generate",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"string": {
|
|
"description": "String to hash.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"string"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "string",
|
|
"example": "$argon2i$v=19$m=4096,t=3,p=1$pOyIa/zmRAjCVLb2f7kOyg$DasoO6LzMM+6iKfzCDq6JbsYsZWLSm33p7i9NxL9mDc"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/utils/hash/verify": {
|
|
"post": {
|
|
"summary": "Hash a string",
|
|
"description": "Generate a hash for a given string.",
|
|
"operationId": "hash-verify",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"string": {
|
|
"description": "String to hash.",
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"description": "Hash you want to verify against.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"string",
|
|
"hash"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/utils/sort/{collection}": {
|
|
"post": {
|
|
"summary": "Sort Items",
|
|
"description": "Re-sort items in collection based on start and to value of item",
|
|
"operationId": "sort",
|
|
"parameters": [
|
|
{
|
|
"description": "Collection identifier",
|
|
"in": "path",
|
|
"name": "collection",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"item": {
|
|
"description": "Primary key of item to move",
|
|
"type": "number"
|
|
},
|
|
"to": {
|
|
"description": "Primary key of item where to move the current item to",
|
|
"type": "number"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/utils/import/{collection}": {
|
|
"post": {
|
|
"summary": "Import Items",
|
|
"description": "Import multiple records from a JSON or CSV file into a collection.",
|
|
"operationId": "import",
|
|
"parameters": [
|
|
{
|
|
"description": "Collection identifier",
|
|
"in": "path",
|
|
"name": "collection",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/utils/export/{collection}": {
|
|
"post": {
|
|
"summary": "Export Items",
|
|
"description": "Export a larger data set to a file in the File Library",
|
|
"operationId": "export",
|
|
"parameters": [
|
|
{
|
|
"description": "Collection identifier",
|
|
"in": "path",
|
|
"name": "collection",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"format": {
|
|
"description": "What file format to save the export to. One of csv, xml, json",
|
|
"type": "string",
|
|
"enum": [
|
|
"csv",
|
|
"xml",
|
|
"json"
|
|
]
|
|
},
|
|
"query": {
|
|
"$ref": "#/components/schemas/Query"
|
|
},
|
|
"file": {
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
},
|
|
"required": [
|
|
"format",
|
|
"query",
|
|
"file"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/utils/cache/clear": {
|
|
"post": {
|
|
"summary": "Clear Cache",
|
|
"description": "Resets both the data and schema cache of Directus.",
|
|
"operationId": "clear-cache",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/utils/random/string": {
|
|
"get": {
|
|
"summary": "Get a Random String",
|
|
"description": "Returns a random string of given length.",
|
|
"operationId": "random",
|
|
"parameters": [
|
|
{
|
|
"description": "Length of the random string.",
|
|
"in": "query",
|
|
"name": "length",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "string",
|
|
"example": "1>M3+4oh.S"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Utilities"
|
|
]
|
|
}
|
|
},
|
|
"/roles": {
|
|
"get": {
|
|
"summary": "List Roles",
|
|
"description": "List the roles.",
|
|
"operationId": "getRoles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Roles"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Role",
|
|
"description": "Create a new role.",
|
|
"operationId": "createRole",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the role.",
|
|
"type": "string"
|
|
},
|
|
"enforce_tfa": {
|
|
"description": "Whether or not this role enforces the use of 2FA.",
|
|
"type": "boolean"
|
|
},
|
|
"external_id": {
|
|
"description": "ID used with external services in SCIM.",
|
|
"type": "string"
|
|
},
|
|
"ip_access": {
|
|
"description": "Array of IP addresses that are allowed to connect to the API as a user of this role.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"module_listing": {
|
|
"description": "Custom override for the admin app module bar navigation.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the role.",
|
|
"type": "string",
|
|
"example": "Interns"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Roles"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Roles",
|
|
"description": "Update multiple roles at the same time.",
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"operationId": "updateRoles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the role.",
|
|
"type": "string"
|
|
},
|
|
"enforce_tfa": {
|
|
"description": "Whether or not this role enforces the use of 2FA.",
|
|
"type": "boolean"
|
|
},
|
|
"external_id": {
|
|
"description": "ID used with external services in SCIM.",
|
|
"type": "string"
|
|
},
|
|
"ip_access": {
|
|
"description": "Array of IP addresses that are allowed to connect to the API as a user of this role.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"module_listing": {
|
|
"description": "Custom override for the admin app module bar navigation.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the role.",
|
|
"type": "string",
|
|
"example": "Interns"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Roles",
|
|
"description": "Delete multiple existing roles.",
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"operationId": "deleteRoles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/roles/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Role",
|
|
"description": "Retrieve a single role by unique identifier.",
|
|
"operationId": "getRole",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Roles"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Role",
|
|
"description": "Update an existing role",
|
|
"operationId": "updateRole",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the role.",
|
|
"type": "string"
|
|
},
|
|
"enforce_tfa": {
|
|
"description": "Whether or not this role enforces the use of 2FA.",
|
|
"type": "boolean"
|
|
},
|
|
"external_id": {
|
|
"description": "ID used with external services in SCIM.",
|
|
"type": "string"
|
|
},
|
|
"ip_access": {
|
|
"description": "Array of IP addresses that are allowed to connect to the API as a user of this role.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"module_listing": {
|
|
"description": "Custom override for the admin app module bar navigation.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the role.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Roles"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Role",
|
|
"description": "Delete an existing role",
|
|
"operationId": "deleteRole",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/collections": {
|
|
"get": {
|
|
"summary": "List Collections",
|
|
"description": "Returns a list of the collections available in the project.",
|
|
"operationId": "getCollections",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Collections"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Collection",
|
|
"description": "Create a new collection in Directus.",
|
|
"operationId": "createCollection",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection",
|
|
"fields"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "Unique name of the collection.",
|
|
"example": "my_collection"
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"description": "The fields contained in this collection. See the fields reference for more information. Each individual field requires field, type, and interface to be provided.",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"icon": {
|
|
"description": "Name of a Google Material Design Icon that's assigned to this collection.",
|
|
"type": "string",
|
|
"example": "people",
|
|
"nullable": true
|
|
},
|
|
"note": {
|
|
"description": "A note describing the collection.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"display_template": {
|
|
"description": "Text representation of how items from this collection are shown across the system.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"hidden": {
|
|
"description": "Whether or not the collection is hidden from the navigation in the admin app.",
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"singleton": {
|
|
"description": "Whether or not the collection is treated as a single object.",
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"translation": {
|
|
"description": "Key value pairs of how to show this collection's name in different languages in the admin app.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"versioning": {
|
|
"description": "Whether or not Content Versioning is enabled for this collection.",
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"archive_field": {
|
|
"description": "What field holds the archive value.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"archive_app_filter": {
|
|
"description": "What value to use for \"archived\" items.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"archive_value": {
|
|
"description": "What value to use to \"unarchive\" items.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"unarchive_value": {
|
|
"description": "Whether or not to show the \"archived\" filter.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"sort_field": {
|
|
"description": "The sort field in the collection.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Collections"
|
|
]
|
|
}
|
|
},
|
|
"/collections/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Collection",
|
|
"description": "Retrieves the details of a single collection.",
|
|
"operationId": "getCollection",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique identifier of the collection.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Collections"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Collection",
|
|
"description": "Update an existing collection.",
|
|
"operationId": "updateCollection",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique identifier of the collection.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"meta": {
|
|
"description": "Metadata of the collection.",
|
|
"type": "object",
|
|
"properties": {
|
|
"icon": {
|
|
"description": "Name of a Google Material Design Icon that's assigned to this collection.",
|
|
"type": "string",
|
|
"example": "people",
|
|
"nullable": true
|
|
},
|
|
"color": {
|
|
"description": "Choose the color for the icon assigned to this collection.",
|
|
"type": "string",
|
|
"example": "#6644ff",
|
|
"nullable": true
|
|
},
|
|
"note": {
|
|
"description": "A note describing the collection.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"display_template": {
|
|
"description": "Text representation of how items from this collection are shown across the system.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"hidden": {
|
|
"description": "Whether or not the collection is hidden from the navigation in the admin app.",
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"singleton": {
|
|
"description": "Whether or not the collection is treated as a single object.",
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"translation": {
|
|
"description": "Key value pairs of how to show this collection's name in different languages in the admin app.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"versioning": {
|
|
"description": "Whether or not Content Versioning is enabled for this collection.",
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"archive_field": {
|
|
"description": "What field holds the archive value.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"archive_app_filter": {
|
|
"description": "What value to use for \"archived\" items.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"archive_value": {
|
|
"description": "What value to use to \"unarchive\" items.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"unarchive_value": {
|
|
"description": "Whether or not to show the \"archived\" filter.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"sort_field": {
|
|
"description": "The sort field in the collection.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Collections"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Collection",
|
|
"description": "Delete an existing collection. Warning: This will delete the whole collection, including the items within. Proceed with caution.",
|
|
"operationId": "deleteCollection",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Collections"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Unique identifier of the collection.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/fields": {
|
|
"get": {
|
|
"summary": "List All Fields",
|
|
"description": "Returns a list of the fields available in the project.",
|
|
"operationId": "getFields",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Fields"
|
|
]
|
|
}
|
|
},
|
|
"/fields/{collection}": {
|
|
"get": {
|
|
"summary": "List Fields in Collection",
|
|
"description": "Returns a list of the fields available in the given collection.",
|
|
"operationId": "getCollectionFields",
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier of the collection the item resides in.",
|
|
"in": "path",
|
|
"name": "collection",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Fields"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create Field in Collection",
|
|
"description": "Create a new field in a given collection.",
|
|
"operationId": "createField",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"required": [
|
|
"field",
|
|
"datatype",
|
|
"type",
|
|
"length"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"field": {
|
|
"description": "Unique name of the field. Field name is unique within the collection.",
|
|
"example": "id",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Directus specific data type. Used to cast values in the API.",
|
|
"example": "integer",
|
|
"type": "string"
|
|
},
|
|
"schema": {
|
|
"description": "The schema info.",
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the field.",
|
|
"example": "title",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "The collection of the field.",
|
|
"example": "posts",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "The type of the field.",
|
|
"example": "string",
|
|
"type": "string"
|
|
},
|
|
"default_value": {
|
|
"description": "The default value of the field.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"max_length": {
|
|
"description": "The max length of the field.",
|
|
"example": null,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"is_nullable": {
|
|
"description": "If the field is nullable.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"is_primary_key": {
|
|
"description": "If the field is primary key.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"has_auto_increment": {
|
|
"description": "If the field has auto increment.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"foreign_key_column": {
|
|
"description": "Related column from the foreign key constraint.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"foreign_key_table": {
|
|
"description": "Related table from the foreign key constraint.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"comment": {
|
|
"description": "Comment as saved in the database.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"schema": {
|
|
"description": "Database schema (pg only).",
|
|
"example": "public",
|
|
"type": "string"
|
|
},
|
|
"foreign_key_schema": {
|
|
"description": "Related schema from the foreign key constraint (pg only).",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"description": "The meta info.",
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the field in the `directus_fields` collection.",
|
|
"example": 3,
|
|
"type": "integer"
|
|
},
|
|
"collection": {
|
|
"description": "Unique name of the collection this field is in.",
|
|
"example": "posts",
|
|
"type": "string"
|
|
},
|
|
"field": {
|
|
"description": "Unique name of the field. Field name is unique within the collection.",
|
|
"example": "title",
|
|
"type": "string"
|
|
},
|
|
"special": {
|
|
"description": "Transformation flag for field",
|
|
"example": null,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"system-interface": {
|
|
"description": "What interface is used in the admin app to edit the value for this field.",
|
|
"example": "primary-key",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"options": {
|
|
"description": "Options for the interface that's used. This format is based on the individual interface.",
|
|
"example": null,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"display": {
|
|
"description": "What display is used in the admin app to display the value for this field.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"display_options": {
|
|
"description": "Options for the display that's used. This format is based on the individual display.",
|
|
"example": null,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"locked": {
|
|
"description": "If the field can be altered by the end user. Directus system fields have this value set to `true`.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
},
|
|
"readonly": {
|
|
"description": "Prevents the user from editing the value in the field.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"hidden": {
|
|
"description": "If this field should be hidden.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
},
|
|
"sort": {
|
|
"description": "Sort order of this field on the edit page of the admin app.",
|
|
"example": 1,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"width": {
|
|
"description": "Width of the field on the edit form.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true,
|
|
"enum": [
|
|
"half",
|
|
"half-left",
|
|
"half-right",
|
|
"full",
|
|
"fill",
|
|
null
|
|
]
|
|
},
|
|
"group": {
|
|
"description": "What field group this field is part of.",
|
|
"example": null,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"translation": {
|
|
"description": "Key value pair of `<language>: <translation>` that allows the user to change the displayed name of the field in the admin app.",
|
|
"example": null,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"note": {
|
|
"description": "A user provided note for the field. Will be rendered alongside the interface on the edit page.",
|
|
"example": "",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Fields"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier of the collection the item resides in.",
|
|
"in": "path",
|
|
"name": "collection",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/fields/{collection}/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Field",
|
|
"description": "Retrieves the details of a single field in a given collection.",
|
|
"operationId": "getCollectionField",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Fields"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "collection",
|
|
"in": "path",
|
|
"description": "Unique identifier of the collection the item resides in.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "Unique identifier of the field.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Field",
|
|
"description": "Update an existing field.",
|
|
"operationId": "updateField",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"field": {
|
|
"description": "Unique name of the field. Field name is unique within the collection.",
|
|
"example": "id",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Directus specific data type. Used to cast values in the API.",
|
|
"example": "integer",
|
|
"type": "string"
|
|
},
|
|
"schema": {
|
|
"description": "The schema info.",
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the field.",
|
|
"example": "title",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "The collection of the field.",
|
|
"example": "posts",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "The type of the field.",
|
|
"example": "string",
|
|
"type": "string"
|
|
},
|
|
"default_value": {
|
|
"description": "The default value of the field.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"max_length": {
|
|
"description": "The max length of the field.",
|
|
"example": null,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"is_nullable": {
|
|
"description": "If the field is nullable.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"is_primary_key": {
|
|
"description": "If the field is primary key.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"has_auto_increment": {
|
|
"description": "If the field has auto increment.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"foreign_key_column": {
|
|
"description": "Related column from the foreign key constraint.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"foreign_key_table": {
|
|
"description": "Related table from the foreign key constraint.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"comment": {
|
|
"description": "Comment as saved in the database.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"schema": {
|
|
"description": "Database schema (pg only).",
|
|
"example": "public",
|
|
"type": "string"
|
|
},
|
|
"foreign_key_schema": {
|
|
"description": "Related schema from the foreign key constraint (pg only).",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"description": "The meta info.",
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the field in the `directus_fields` collection.",
|
|
"example": 3,
|
|
"type": "integer"
|
|
},
|
|
"collection": {
|
|
"description": "Unique name of the collection this field is in.",
|
|
"example": "posts",
|
|
"type": "string"
|
|
},
|
|
"field": {
|
|
"description": "Unique name of the field. Field name is unique within the collection.",
|
|
"example": "title",
|
|
"type": "string"
|
|
},
|
|
"special": {
|
|
"description": "Transformation flag for field",
|
|
"example": null,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"system-interface": {
|
|
"description": "What interface is used in the admin app to edit the value for this field.",
|
|
"example": "primary-key",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"options": {
|
|
"description": "Options for the interface that's used. This format is based on the individual interface.",
|
|
"example": null,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"display": {
|
|
"description": "What display is used in the admin app to display the value for this field.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"display_options": {
|
|
"description": "Options for the display that's used. This format is based on the individual display.",
|
|
"example": null,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"locked": {
|
|
"description": "If the field can be altered by the end user. Directus system fields have this value set to `true`.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
},
|
|
"readonly": {
|
|
"description": "Prevents the user from editing the value in the field.",
|
|
"example": false,
|
|
"type": "boolean"
|
|
},
|
|
"hidden": {
|
|
"description": "If this field should be hidden.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
},
|
|
"sort": {
|
|
"description": "Sort order of this field on the edit page of the admin app.",
|
|
"example": 1,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"width": {
|
|
"description": "Width of the field on the edit form.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true,
|
|
"enum": [
|
|
"half",
|
|
"half-left",
|
|
"half-right",
|
|
"full",
|
|
"fill",
|
|
null
|
|
]
|
|
},
|
|
"group": {
|
|
"description": "What field group this field is part of.",
|
|
"example": null,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"translation": {
|
|
"description": "Key value pair of `<language>: <translation>` that allows the user to change the displayed name of the field in the admin app.",
|
|
"example": null,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"note": {
|
|
"description": "A user provided note for the field. Will be rendered alongside the interface on the edit page.",
|
|
"example": "",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Fields"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "collection",
|
|
"in": "path",
|
|
"description": "Unique identifier of the collection the item resides in.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "Unique identifier of the field.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Field",
|
|
"description": "Delete an existing field.",
|
|
"operationId": "deleteField",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Fields"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "collection",
|
|
"in": "path",
|
|
"description": "Unique identifier of the collection the item resides in.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "Unique identifier of the field.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/files": {
|
|
"get": {
|
|
"summary": "List Files",
|
|
"description": "List the files.",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "getFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"summary": "Create a File",
|
|
"description": "Create a new file",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "createFile",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Files",
|
|
"description": "Update multiple files at the same time.",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "updateFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Files",
|
|
"description": "Delete multiple existing files.",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "deleteFiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/files/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Files",
|
|
"description": "Retrieve a single file by unique identifier.",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "getFile",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update a File",
|
|
"description": "Update an existing file, and/or replace it's file contents.",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "updateFile",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"file"
|
|
],
|
|
"properties": {
|
|
"title": {
|
|
"description": "Title for the file. Is extracted from the filename on upload, but can be edited by the user.",
|
|
"example": "User Avatar",
|
|
"type": "string"
|
|
},
|
|
"filename_download": {
|
|
"description": "Preferred filename when file is downloaded.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Description for the file.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"folder": {
|
|
"description": "Virtual folder where this file resides in.",
|
|
"example": null,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"tags": {
|
|
"description": "Tags for the file. Is automatically populated based on Exif data for images.",
|
|
"type": "array",
|
|
"nullable": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"file": {
|
|
"description": "File contents.",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"title": {
|
|
"description": "Title for the file. Is extracted from the filename on upload, but can be edited by the user.",
|
|
"example": "User Avatar",
|
|
"type": "string"
|
|
},
|
|
"filename_download": {
|
|
"description": "Preferred filename when file is downloaded.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Description for the file.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"folder": {
|
|
"description": "Virtual folder where this file resides in.",
|
|
"example": null,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"tags": {
|
|
"description": "Tags for the file. Is automatically populated based on Exif data for images.",
|
|
"type": "array",
|
|
"nullable": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a File",
|
|
"description": "Delete an existing file.",
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"operationId": "deleteFile",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/folders": {
|
|
"get": {
|
|
"summary": "List Folders",
|
|
"description": "List the folders.",
|
|
"operationId": "getFolders",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Folders"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Folder",
|
|
"description": "Create a new folder.",
|
|
"operationId": "createFolder",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Amsterdam",
|
|
"description": "Name of the folder."
|
|
},
|
|
"parent": {
|
|
"description": "Unique identifier of the parent folder. This allows for nested folders.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Folders"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Folders",
|
|
"description": "Update multiple folders at the same time.",
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"operationId": "updateFolders",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Amsterdam",
|
|
"description": "Name of the folder."
|
|
},
|
|
"parent": {
|
|
"description": "Unique identifier of the parent folder. This allows for nested folders.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Folders",
|
|
"description": "Delete multiple existing folders.",
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"operationId": "deleteFolders",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/folders/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Folder",
|
|
"description": "Retrieve a single folder by unique identifier.",
|
|
"operationId": "getFolder",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Folders"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Folder",
|
|
"description": "Update an existing folder",
|
|
"operationId": "updateFolder",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Name of the folder. Can't be null or empty."
|
|
},
|
|
"parent": {
|
|
"type": "integer",
|
|
"example": 3,
|
|
"description": "Unique identifier of the parent folder. This allows for nested folders."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Folders"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Folder",
|
|
"description": "Delete an existing folder",
|
|
"operationId": "deleteFolder",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/activity": {
|
|
"get": {
|
|
"operationId": "getActivities",
|
|
"summary": "List Activity Actions",
|
|
"description": "Returns a list of activity actions.",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Activity"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Activity"
|
|
]
|
|
}
|
|
},
|
|
"/activity/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Activity Action",
|
|
"description": "Retrieves the details of an existing activity action. Provide the primary key of the activity action and Directus will return the corresponding information.",
|
|
"operationId": "getActivity",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Activity"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Activity"
|
|
]
|
|
}
|
|
},
|
|
"/revisions": {
|
|
"get": {
|
|
"summary": "List Revisions",
|
|
"description": "List the revisions.",
|
|
"operationId": "getRevisions",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Revisions"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Revisions"
|
|
]
|
|
}
|
|
},
|
|
"/revisions/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Revision",
|
|
"description": "Retrieve a single revision by unique identifier.",
|
|
"operationId": "getRevision",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Revisions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Revisions"
|
|
]
|
|
}
|
|
},
|
|
"/relations": {
|
|
"get": {
|
|
"summary": "List Relations",
|
|
"description": "List the relations.",
|
|
"operationId": "getRelations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Relations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Relations"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Relation",
|
|
"description": "Create a new relation.",
|
|
"operationId": "createRelation",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"collection_many": {
|
|
"description": "Collection that has the field that holds the foreign key.",
|
|
"type": "string",
|
|
"example": "articles"
|
|
},
|
|
"collection_one": {
|
|
"description": "Collection on the _one_ side of the relationship.",
|
|
"type": "string",
|
|
"example": "authors"
|
|
},
|
|
"field_many": {
|
|
"description": "Foreign key. Field that holds the primary key of the related collection.",
|
|
"type": "string",
|
|
"example": "author"
|
|
},
|
|
"field_one": {
|
|
"description": "Alias column that serves as the _one_ side of the relationship.",
|
|
"type": "string",
|
|
"example": "books"
|
|
},
|
|
"junction_field": {
|
|
"description": "Field on the junction table that holds the primary key of the related collection.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Relations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Relations"
|
|
]
|
|
}
|
|
},
|
|
"/relations/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Relation",
|
|
"description": "Retrieve a single relation by unique identifier.",
|
|
"operationId": "getRelation",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Relations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Relations"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Relation",
|
|
"description": "Update an existing relation",
|
|
"operationId": "updateRelation",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"collection_many": {
|
|
"description": "Collection that has the field that holds the foreign key.",
|
|
"type": "string"
|
|
},
|
|
"collection_one": {
|
|
"description": "Collection on the _one_ side of the relationship.",
|
|
"type": "string"
|
|
},
|
|
"field_many": {
|
|
"description": "Foreign key. Field that holds the primary key of the related collection.",
|
|
"type": "string"
|
|
},
|
|
"field_one": {
|
|
"description": "Alias column that serves as the _one_ side of the relationship.",
|
|
"type": "string",
|
|
"example": "books"
|
|
},
|
|
"junction_field": {
|
|
"description": "Field on the junction table that holds the primary key of the related collection.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Relations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Relations"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Relation",
|
|
"description": "Delete an existing relation.",
|
|
"operationId": "deleteRelation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Relations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/permissions": {
|
|
"get": {
|
|
"summary": "List Permissions",
|
|
"description": "List all permissions.",
|
|
"operationId": "getPermissions",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Permissions"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Permissions"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Permission",
|
|
"description": "Create a new permission.",
|
|
"operationId": "createPermission",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"collection": {
|
|
"description": "What collection this permission applies to.",
|
|
"type": "string",
|
|
"example": "customers"
|
|
},
|
|
"comment": {
|
|
"description": "If the user can post comments.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"create",
|
|
"update",
|
|
"full"
|
|
]
|
|
},
|
|
"create": {
|
|
"description": "If the user can create items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"full"
|
|
]
|
|
},
|
|
"delete": {
|
|
"description": "If the user can update items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"explain": {
|
|
"description": "If the user is required to leave a comment explaining what was changed.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"create",
|
|
"update",
|
|
"always"
|
|
]
|
|
},
|
|
"read": {
|
|
"description": "If the user can read items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"role": {
|
|
"description": "Unique identifier of the role this permission applies to.",
|
|
"type": "integer",
|
|
"example": 3
|
|
},
|
|
"read_field_blacklist": {
|
|
"description": "Explicitly denies read access for specific fields.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"example": [
|
|
"featured_image"
|
|
]
|
|
},
|
|
"status": {
|
|
"description": "What status this permission applies to.",
|
|
"type": "string"
|
|
},
|
|
"status_blacklist": {
|
|
"description": "Explicitly denies specific statuses to be used.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"update": {
|
|
"description": "If the user can update items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"write_field_blacklist": {
|
|
"description": "Explicitly denies write access for specific fields.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Permissions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Permissions"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Permissions",
|
|
"description": "Update multiple permissions at the same time.",
|
|
"tags": [
|
|
"Permissions"
|
|
],
|
|
"operationId": "updatePermissions",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"data": {
|
|
"properties": {
|
|
"collection": {
|
|
"description": "What collection this permission applies to.",
|
|
"type": "string",
|
|
"example": "customers"
|
|
},
|
|
"comment": {
|
|
"description": "If the user can post comments.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"create",
|
|
"update",
|
|
"full"
|
|
]
|
|
},
|
|
"create": {
|
|
"description": "If the user can create items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"full"
|
|
]
|
|
},
|
|
"delete": {
|
|
"description": "If the user can update items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"explain": {
|
|
"description": "If the user is required to leave a comment explaining what was changed.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"create",
|
|
"update",
|
|
"always"
|
|
]
|
|
},
|
|
"read": {
|
|
"description": "If the user can read items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"role": {
|
|
"description": "Unique identifier of the role this permission applies to.",
|
|
"type": "integer",
|
|
"example": 3
|
|
},
|
|
"read_field_blacklist": {
|
|
"description": "Explicitly denies read access for specific fields.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"example": [
|
|
"featured_image"
|
|
]
|
|
},
|
|
"status": {
|
|
"description": "What status this permission applies to.",
|
|
"type": "string"
|
|
},
|
|
"status_blacklist": {
|
|
"description": "Explicitly denies specific statuses to be used.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"update": {
|
|
"description": "If the user can update items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"write_field_blacklist": {
|
|
"description": "Explicitly denies write access for specific fields.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Permissions"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Permissions",
|
|
"description": "Delete multiple existing permissions.",
|
|
"tags": [
|
|
"Permissions"
|
|
],
|
|
"operationId": "deletePermissions",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/permissions/me": {
|
|
"get": {
|
|
"summary": "List My Permissions",
|
|
"description": "List the permissions that apply to the current user.",
|
|
"operationId": "getMyPermissions",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Permissions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Permissions"
|
|
]
|
|
}
|
|
},
|
|
"/permissions/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Permission",
|
|
"description": "Retrieve a single permissions object by unique identifier.",
|
|
"operationId": "getPermission",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Permissions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Permissions"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Permission",
|
|
"description": "Update an existing permission",
|
|
"operationId": "updatePermission",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"collection": {
|
|
"description": "What collection this permission applies to.",
|
|
"type": "object"
|
|
},
|
|
"comment": {
|
|
"description": "If the user can post comments. `full`.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"create",
|
|
"update"
|
|
]
|
|
},
|
|
"create": {
|
|
"description": "If the user can create items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"full"
|
|
]
|
|
},
|
|
"delete": {
|
|
"description": "If the user can update items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"explain": {
|
|
"description": "If the user is required to leave a comment explaining what was changed.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"create",
|
|
"update",
|
|
"always"
|
|
]
|
|
},
|
|
"read": {
|
|
"description": "If the user can read items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"read_field_blacklist": {
|
|
"description": "Explicitly denies read access for specific fields.",
|
|
"type": "object"
|
|
},
|
|
"role": {
|
|
"description": "Unique identifier of the role this permission applies to.",
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"description": "What status this permission applies to.",
|
|
"type": "object"
|
|
},
|
|
"status_blacklist": {
|
|
"description": "Explicitly denies specific statuses to be used.",
|
|
"type": "object"
|
|
},
|
|
"update": {
|
|
"description": "If the user can update items.",
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"mine",
|
|
"role",
|
|
"full"
|
|
]
|
|
},
|
|
"write_field_blacklist": {
|
|
"description": "Explicitly denies write access for specific fields.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Permissions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Permissions"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Permission",
|
|
"description": "Delete an existing permission",
|
|
"operationId": "deletePermission",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Permissions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users": {
|
|
"get": {
|
|
"summary": "List Users",
|
|
"description": "List the users.",
|
|
"operationId": "getUsers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a User",
|
|
"description": "Create a new user.",
|
|
"operationId": "createUser",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Users",
|
|
"description": "Update multiple users at the same time.",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"operationId": "updateUsers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Users",
|
|
"description": "Delete multiple existing users.",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"operationId": "deleteUsers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a User",
|
|
"description": "Retrieve a single user by unique identifier.",
|
|
"operationId": "getUser",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a User",
|
|
"description": "Update an existing user",
|
|
"operationId": "updateUser",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a User",
|
|
"description": "Delete an existing user",
|
|
"operationId": "deleteUser",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users/invite": {
|
|
"post": {
|
|
"summary": "Invite User(s)",
|
|
"description": "Invites one or more users to this project. It creates a user with an invited status, and then sends an email to the user with instructions on how to activate their account.",
|
|
"operationId": "invite",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"description": "Email address or array of email addresses of the to-be-invited user(s).",
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
}
|
|
},
|
|
"/users/invite/accept": {
|
|
"post": {
|
|
"summary": "Accept User Invite",
|
|
"description": "Accepts and enables an invited user using a JWT invitation token.",
|
|
"operationId": "acceptInvite",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"token": {
|
|
"type": "string",
|
|
"example": "eyJh...KmUk",
|
|
"description": "Accept invite token."
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"description": "Password of the user.",
|
|
"format": "password",
|
|
"example": "d1r3ctu5"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
}
|
|
},
|
|
"/users/me": {
|
|
"get": {
|
|
"summary": "Retrieve Current User",
|
|
"description": "Retrieve the currently authenticated user.",
|
|
"operationId": "getMe",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Current User",
|
|
"description": "Update the currently authenticated user.",
|
|
"operationId": "updateMe",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
}
|
|
},
|
|
"/users/me/track/page": {
|
|
"patch": {
|
|
"summary": "Update Last Page",
|
|
"description": "Updates the last used page field of the currently authenticated user. This is used internally to be able to open the Directus admin app from the last page you used.",
|
|
"operationId": "updateLastUsedPageMe",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"last_page": {
|
|
"description": "Path of the page you used last.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
}
|
|
},
|
|
"/users/me/tfa/enable": {
|
|
"post": {
|
|
"summary": "Enable 2FA",
|
|
"description": "Enables two-factor authentication for the currently authenticated user.",
|
|
"operationId": "meTfaEnable",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
}
|
|
},
|
|
"/users/me/tfa/disable": {
|
|
"post": {
|
|
"summary": "Disable 2FA",
|
|
"description": "Disables two-factor authentication for the currently authenticated user.",
|
|
"operationId": "meTfaDisable",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Users"
|
|
]
|
|
}
|
|
},
|
|
"/presets": {
|
|
"get": {
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "getPresets",
|
|
"summary": "List Presets",
|
|
"description": "List the presets.",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Presets"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "createPreset",
|
|
"summary": "Create a Preset",
|
|
"description": "Create a new preset.",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "What collection this collection preset is used for.",
|
|
"example": "articles"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"description": "Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.",
|
|
"example": "Highly rated articles"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"description": "The unique identifier of a role in the platform. If user is null, this will be used to apply the collection preset or bookmark for all users in the role.",
|
|
"example": null
|
|
},
|
|
"search": {
|
|
"type": "string",
|
|
"description": "What the user searched for in search/filter in the header bar."
|
|
},
|
|
"filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"example": "aHKLAakdVghzD"
|
|
},
|
|
"field": {
|
|
"type": "string",
|
|
"example": "rating"
|
|
},
|
|
"operator": {
|
|
"type": "string",
|
|
"example": "gte"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"example": 4.5
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"layout": {
|
|
"type": "string",
|
|
"description": "Name of the view type that is used."
|
|
},
|
|
"layout_query": {
|
|
"type": "string",
|
|
"description": "Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters."
|
|
},
|
|
"layout_options": {
|
|
"type": "string",
|
|
"description": "Options of the views. The properties in here are controlled by the layout."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Presets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Presets",
|
|
"description": "Update multiple presets at the same time.",
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "updatePresets",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "What collection this collection preset is used for.",
|
|
"example": "articles"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"description": "Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.",
|
|
"example": "Highly rated articles"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"description": "The unique identifier of a role in the platform. If user is null, this will be used to apply the collection preset or bookmark for all users in the role.",
|
|
"example": null
|
|
},
|
|
"search": {
|
|
"type": "string",
|
|
"description": "What the user searched for in search/filter in the header bar."
|
|
},
|
|
"filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"example": "aHKLAakdVghzD"
|
|
},
|
|
"field": {
|
|
"type": "string",
|
|
"example": "rating"
|
|
},
|
|
"operator": {
|
|
"type": "string",
|
|
"example": "gte"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"example": 4.5
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"layout": {
|
|
"type": "string",
|
|
"description": "Name of the view type that is used."
|
|
},
|
|
"layout_query": {
|
|
"type": "string",
|
|
"description": "Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters."
|
|
},
|
|
"layout_options": {
|
|
"type": "string",
|
|
"description": "Options of the views. The properties in here are controlled by the layout."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Presets"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Presets",
|
|
"description": "Delete multiple existing presets.",
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "deletePresets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/presets/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "getPreset",
|
|
"summary": "Retrieve a Preset",
|
|
"description": "Retrieve a single preset by unique identifier.",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Presets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "updatePreset",
|
|
"summary": "Update a Preset",
|
|
"description": "Update an existing preset.",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "What collection this collection preset is used for.",
|
|
"example": "articles"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"description": "Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.",
|
|
"example": "Highly rated articles"
|
|
},
|
|
"role": {
|
|
"type": "integer",
|
|
"description": "The unique identifier of a role in the platform. If user is null, this will be used to apply the collection preset or bookmark for all users in the role."
|
|
},
|
|
"search_query": {
|
|
"type": "string",
|
|
"description": "What the user searched for in search/filter in the header bar."
|
|
},
|
|
"filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"field": {
|
|
"type": "string",
|
|
"example": "rating"
|
|
},
|
|
"operator": {
|
|
"type": "string",
|
|
"example": "gte"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"example": 4.5
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"view_type": {
|
|
"type": "string",
|
|
"description": "Name of the view type that is used. Defaults to tabular."
|
|
},
|
|
"view_query": {
|
|
"type": "string",
|
|
"description": "View query that's saved per view type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters."
|
|
},
|
|
"view_options": {
|
|
"type": "string",
|
|
"description": "Options of the views. The properties in here are controlled by the layout."
|
|
},
|
|
"translation": {
|
|
"type": "object",
|
|
"description": "Key value pair of language-translation. Can be used to translate the bookmark title in multiple languages."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Presets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Presets"
|
|
],
|
|
"operationId": "deletePreset",
|
|
"summary": "Delete a Preset",
|
|
"description": "Delete an existing preset.",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Id"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/webhooks": {
|
|
"get": {
|
|
"summary": "List Webhooks",
|
|
"description": "Get all webhooks.",
|
|
"operationId": "getWebhooks",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Webhooks"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Webhooks"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Webhook",
|
|
"description": "Create a new webhook.",
|
|
"operationId": "createWebhook",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the webhook.",
|
|
"type": "string",
|
|
"example": "create articles"
|
|
},
|
|
"method": {
|
|
"description": "Method used in the webhook.",
|
|
"type": "string",
|
|
"example": "POST"
|
|
},
|
|
"url": {
|
|
"description": "The url of the webhook.",
|
|
"type": "string",
|
|
"example": null
|
|
},
|
|
"status": {
|
|
"description": "The status of the webhook.",
|
|
"type": "string",
|
|
"example": "active"
|
|
},
|
|
"data": {
|
|
"description": "If yes, send the content of what was done",
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"actions": {
|
|
"description": "The actions that triggers this webhook.",
|
|
"example": null
|
|
},
|
|
"system-collections": {
|
|
"description": "The collections that triggers this webhook.",
|
|
"example": null
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Webhooks"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Webhooks",
|
|
"description": "Update multiple webhooks at the same time.",
|
|
"tags": [
|
|
"Webhooks"
|
|
],
|
|
"operationId": "updateWebhooks",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the webhook.",
|
|
"type": "string",
|
|
"example": "create articles"
|
|
},
|
|
"method": {
|
|
"description": "Method used in the webhook.",
|
|
"type": "string",
|
|
"example": "POST"
|
|
},
|
|
"url": {
|
|
"description": "The url of the webhook.",
|
|
"type": "string",
|
|
"example": null
|
|
},
|
|
"status": {
|
|
"description": "The status of the webhook.",
|
|
"type": "string",
|
|
"example": "active"
|
|
},
|
|
"data": {
|
|
"description": "If yes, send the content of what was done",
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"actions": {
|
|
"description": "The actions that triggers this webhook.",
|
|
"example": null
|
|
},
|
|
"system-collections": {
|
|
"description": "The collections that triggers this webhook.",
|
|
"example": null
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Webhooks"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Webhooks",
|
|
"description": "Delete multiple existing webhooks.",
|
|
"tags": [
|
|
"Webhooks"
|
|
],
|
|
"operationId": "deleteWebhooks",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/webhooks/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Webhook",
|
|
"description": "Retrieve a single webhook by unique identifier.",
|
|
"operationId": "getWebhook",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Webhooks"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Webhooks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Webhook",
|
|
"description": "Update an existing webhook",
|
|
"operationId": "updateWebhook",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the webhook.",
|
|
"type": "string",
|
|
"example": "create articles"
|
|
},
|
|
"method": {
|
|
"description": "Method used in the webhook.",
|
|
"type": "string",
|
|
"example": "POST"
|
|
},
|
|
"url": {
|
|
"description": "The url of the webhook.",
|
|
"type": "string",
|
|
"example": null
|
|
},
|
|
"status": {
|
|
"description": "The status of the webhook.",
|
|
"type": "string",
|
|
"example": "active"
|
|
},
|
|
"data": {
|
|
"description": "If yes, send the content of what was done",
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"actions": {
|
|
"description": "The actions that triggers this webhook.",
|
|
"example": null
|
|
},
|
|
"system-collections": {
|
|
"description": "The collections that triggers this webhook.",
|
|
"example": null
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Webhooks"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Webhook",
|
|
"description": "Delete an existing webhook",
|
|
"operationId": "deleteWebhook",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Webhooks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/flows": {
|
|
"get": {
|
|
"summary": "List Flows",
|
|
"description": "Get all flows.",
|
|
"operationId": "getFlows",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Flows"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Flow",
|
|
"description": "Create a new flow.",
|
|
"operationId": "createFlow",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Flows"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Flows",
|
|
"description": "Update multiple flows at the same time.",
|
|
"tags": [
|
|
"Flows"
|
|
],
|
|
"operationId": "updateFlows",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
]
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Flows",
|
|
"description": "Delete multiple existing flows.",
|
|
"tags": [
|
|
"Flows"
|
|
],
|
|
"operationId": "deleteFlows",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/flows/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Flow",
|
|
"description": "Retrieve a single flow by unique identifier.",
|
|
"operationId": "getFlow",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Flows"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Flow",
|
|
"description": "Update an existing flow",
|
|
"operationId": "updateFlow",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Flows"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Flow",
|
|
"description": "Delete an existing flow",
|
|
"operationId": "deleteFlow",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Flows"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/operations": {
|
|
"get": {
|
|
"summary": "List Operations",
|
|
"description": "Get all operations.",
|
|
"operationId": "getOperations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Operations"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create an Operation",
|
|
"description": "Create a new operation.",
|
|
"operationId": "createOperation",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Operations"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Operations",
|
|
"description": "Update multiple operations at the same time.",
|
|
"tags": [
|
|
"Operations"
|
|
],
|
|
"operationId": "updateOperations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Operations",
|
|
"description": "Delete multiple existing operations.",
|
|
"tags": [
|
|
"Operations"
|
|
],
|
|
"operationId": "deleteOperations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/operations/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Operation",
|
|
"description": "Retrieve a single operation by unique identifier.",
|
|
"operationId": "getOperation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Operations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Operation",
|
|
"description": "Update an existing operation",
|
|
"operationId": "updateOperation",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Operations"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Operation",
|
|
"description": "Delete an existing operation",
|
|
"operationId": "deleteOperation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Operations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/comments": {
|
|
"get": {
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "getComments",
|
|
"summary": "List Comments",
|
|
"description": "List the comments.",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Comments"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "createComment",
|
|
"summary": "Create a Comment",
|
|
"description": "Create a new comment.",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection",
|
|
"item",
|
|
"comment"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "Which collection this collection comment is for.",
|
|
"example": "projects"
|
|
},
|
|
"item": {
|
|
"type": "string",
|
|
"example": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28"
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"example": "A new comment"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Comments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Comments",
|
|
"description": "Update multiple comments at the same time.",
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "updateComments",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "Which collection this collection comment is for.",
|
|
"example": "projects"
|
|
},
|
|
"item": {
|
|
"type": "string",
|
|
"example": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28"
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"example": "A new comment"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Comments"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Comments",
|
|
"description": "Delete multiple existing comments.",
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "deleteComments",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/comments/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "getComment",
|
|
"summary": "Retrieve a Comment",
|
|
"description": "Retrieve a single comment by unique identifier.",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Comments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "updateComment",
|
|
"summary": "Update a Comment",
|
|
"description": "Update an existing comment.",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"collection"
|
|
],
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string",
|
|
"description": "Which collection this comment is for.",
|
|
"example": "projects"
|
|
},
|
|
"item": {
|
|
"type": "string",
|
|
"example": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28"
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"example": "An updated comment"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Comments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Comments"
|
|
],
|
|
"operationId": "deleteComment",
|
|
"summary": "Delete a Comment",
|
|
"description": "Delete an existing comment.",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/versions": {
|
|
"get": {
|
|
"summary": "List Content Versions",
|
|
"description": "Get all Content Versions.",
|
|
"operationId": "getContentVersions",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create Multiple Content Versions",
|
|
"description": "Create multiple new Content Versions.",
|
|
"operationId": "createContentVersion",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Content Versions",
|
|
"description": "Update multiple Content Versions at the same time.",
|
|
"operationId": "updateContentVersions",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
]
|
|
},
|
|
"keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Content Versions",
|
|
"description": "Delete multiple existing Content Versions.",
|
|
"operationId": "deleteContentVersions",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
}
|
|
},
|
|
"/versions/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve a Content Version",
|
|
"description": "Retrieve a single Content Version by unique identifier.",
|
|
"operationId": "getContentVersion",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Content Version",
|
|
"description": "Update an existing Content Version.",
|
|
"operationId": "updateContentVersion",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Content Version",
|
|
"description": "Delete an existing Content Version.",
|
|
"operationId": "deleteContentVersion",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/versions/{id}/save": {
|
|
"post": {
|
|
"summary": "Save to a Content Version",
|
|
"description": "Save item changes to an existing Content Version.",
|
|
"operationId": "saveContentVersion",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
}
|
|
},
|
|
"/versions/{id}/compare": {
|
|
"get": {
|
|
"summary": "Compare a Content Version",
|
|
"description": "Compare an existing Content Version with the main version of the item.",
|
|
"operationId": "compareContentVersion",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
}
|
|
},
|
|
"/versions/{id}/promote": {
|
|
"post": {
|
|
"summary": "Promote a Content Version",
|
|
"description": "Pass the current hash of the main version of the item (obtained from the `compare` endpoint) along with an optional array of field names of which the values are to be promoted (by default, all fields are selected).",
|
|
"operationId": "promoteContentVersion",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/UUId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"mainHash": {
|
|
"description": "Hash of the main version of the item to be promoted.",
|
|
"type": "string"
|
|
},
|
|
"fields": {
|
|
"description": "Optional array of field names of which the values are to be promoted.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Versions"
|
|
]
|
|
}
|
|
},
|
|
"/settings": {
|
|
"get": {
|
|
"summary": "Retrieve Settings",
|
|
"description": "List the settings.",
|
|
"operationId": "getSettings",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Settings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Settings"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update Settings",
|
|
"description": "Update the settings",
|
|
"operationId": "updateSetting",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Settings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Settings"
|
|
]
|
|
}
|
|
},
|
|
"/extensions": {
|
|
"get": {
|
|
"summary": "List Extensions",
|
|
"description": "List the installed extensions and their configuration in the project.",
|
|
"operationId": "listExtensions",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Extensions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Extensions"
|
|
]
|
|
}
|
|
},
|
|
"/extensions/{name}": {
|
|
"patch": {
|
|
"summary": "Update an Extension",
|
|
"description": "Update an existing extension.",
|
|
"operationId": "updateExtensions",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"meta": {
|
|
"type": "object",
|
|
"description": "Directus metadata for the extension. Where the configuration for the extension in the current project is stored.",
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Whether or not the extension is enabled.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Extensions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Extensions"
|
|
]
|
|
}
|
|
},
|
|
"/extensions/{bundle}/{name}": {
|
|
"patch": {
|
|
"summary": "Update an Extension",
|
|
"description": "Update an existing extension.",
|
|
"operationId": "updateExtensionBundle",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "bundle",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"meta": {
|
|
"type": "object",
|
|
"description": "Directus metadata for the extension. Where the configuration for the extension in the current project is stored.",
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Whether or not the extension is enabled.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/components/schemas/Extensions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Extensions"
|
|
]
|
|
}
|
|
},
|
|
"/items/directus_sync_id_map": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new directus_sync_id_map item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "createItemsDirectusSyncIDMap",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the directus_sync_id_map items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "readItemsDirectusSyncIDMap",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple directus_sync_id_map items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "updateItemsDirectusSyncIDMap",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing directus_sync_id_map items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "deleteItemsDirectusSyncIDMap",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/directus_sync_id_map/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single directus_sync_id_map item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "readSingleItemsDirectusSyncIDMap",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing directus_sync_id_map item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "updateSingleItemsDirectusSyncIDMap",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsDirectusSyncIDMap"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing directus_sync_id_map item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsDirectusSyncIDMap"
|
|
],
|
|
"operationId": "deleteSingleItemsDirectusSyncIDMap",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/relations": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new relations item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "createItemsRelations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the relations items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "readItemsRelations",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple relations items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "updateItemsRelations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing relations items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "deleteItemsRelations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/relations/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single relations item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "readSingleItemsRelations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing relations item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "updateSingleItemsRelations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing relations item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsRelations"
|
|
],
|
|
"operationId": "deleteSingleItemsRelations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/oceannomads_profiles": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new oceannomads_profiles item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "createItemsOceannomadsProfiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the oceannomads_profiles items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "readItemsOceannomadsProfiles",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple oceannomads_profiles items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "updateItemsOceannomadsProfiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing oceannomads_profiles items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "deleteItemsOceannomadsProfiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/oceannomads_profiles/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single oceannomads_profiles item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "readSingleItemsOceannomadsProfiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing oceannomads_profiles item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "updateSingleItemsOceannomadsProfiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsOceannomadsProfiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing oceannomads_profiles item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsOceannomadsProfiles"
|
|
],
|
|
"operationId": "deleteSingleItemsOceannomadsProfiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/maps": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new maps item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "createItemsMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the maps items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "readItemsMaps",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple maps items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "updateItemsMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing maps items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "deleteItemsMaps",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/maps/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single maps item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "readSingleItemsMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing maps item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "updateSingleItemsMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing maps item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMaps"
|
|
],
|
|
"operationId": "deleteSingleItemsMaps",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/attestations": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new attestations item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "createItemsAttestations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the attestations items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "readItemsAttestations",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple attestations items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "updateItemsAttestations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing attestations items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "deleteItemsAttestations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/attestations/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single attestations item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "readSingleItemsAttestations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing attestations item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "updateSingleItemsAttestations",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing attestations item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestations"
|
|
],
|
|
"operationId": "deleteSingleItemsAttestations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/attestations_directus_users": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new attestations_directus_users item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "createItemsAttestationsDirectusUsers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the attestations_directus_users items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "readItemsAttestationsDirectusUsers",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple attestations_directus_users items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "updateItemsAttestationsDirectusUsers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing attestations_directus_users items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "deleteItemsAttestationsDirectusUsers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/attestations_directus_users/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single attestations_directus_users item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "readSingleItemsAttestationsDirectusUsers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing attestations_directus_users item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "updateSingleItemsAttestationsDirectusUsers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing attestations_directus_users item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsAttestationsDirectusUsers"
|
|
],
|
|
"operationId": "deleteSingleItemsAttestationsDirectusUsers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/contactInfos": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new contactInfos item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "createItemsContactInfos",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the contactInfos items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "readItemsContactInfos",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple contactInfos items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "updateItemsContactInfos",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing contactInfos items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "deleteItemsContactInfos",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/contactInfos/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single contactInfos item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "readSingleItemsContactInfos",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing contactInfos item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "updateSingleItemsContactInfos",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing contactInfos item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsContactInfos"
|
|
],
|
|
"operationId": "deleteSingleItemsContactInfos",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/crowdfundings": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new crowdfundings item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "createItemsCrowdfundings",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the crowdfundings items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "readItemsCrowdfundings",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple crowdfundings items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "updateItemsCrowdfundings",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing crowdfundings items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "deleteItemsCrowdfundings",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/crowdfundings/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single crowdfundings item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "readSingleItemsCrowdfundings",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing crowdfundings item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "updateSingleItemsCrowdfundings",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing crowdfundings item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsCrowdfundings"
|
|
],
|
|
"operationId": "deleteSingleItemsCrowdfundings",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/features": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new features item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "createItemsFeatures",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the features items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "readItemsFeatures",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple features items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "updateItemsFeatures",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing features items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "deleteItemsFeatures",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/features/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single features item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "readSingleItemsFeatures",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing features item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "updateSingleItemsFeatures",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsFeatures"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing features item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsFeatures"
|
|
],
|
|
"operationId": "deleteSingleItemsFeatures",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/gallery": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new gallery item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "createItemsGallery",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the gallery items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "readItemsGallery",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple gallery items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "updateItemsGallery",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing gallery items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "deleteItemsGallery",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/gallery/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single gallery item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "readSingleItemsGallery",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing gallery item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "updateSingleItemsGallery",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing gallery item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGallery"
|
|
],
|
|
"operationId": "deleteSingleItemsGallery",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/groupSubheaders": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new groupSubheaders item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "createItemsGroupSubheaders",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the groupSubheaders items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "readItemsGroupSubheaders",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple groupSubheaders items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "updateItemsGroupSubheaders",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing groupSubheaders items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "deleteItemsGroupSubheaders",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/groupSubheaders/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single groupSubheaders item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "readSingleItemsGroupSubheaders",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing groupSubheaders item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "updateSingleItemsGroupSubheaders",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing groupSubheaders item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheaders"
|
|
],
|
|
"operationId": "deleteSingleItemsGroupSubheaders",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/groupSubheaders_groupTypes": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new groupSubheaders_groupTypes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "createItemsGroupSubheadersGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the groupSubheaders_groupTypes items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "readItemsGroupSubheadersGroupTypes",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple groupSubheaders_groupTypes items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "updateItemsGroupSubheadersGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing groupSubheaders_groupTypes items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "deleteItemsGroupSubheadersGroupTypes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/groupSubheaders_groupTypes/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single groupSubheaders_groupTypes item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "readSingleItemsGroupSubheadersGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing groupSubheaders_groupTypes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "updateSingleItemsGroupSubheadersGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing groupSubheaders_groupTypes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupSubheadersGroupTypes"
|
|
],
|
|
"operationId": "deleteSingleItemsGroupSubheadersGroupTypes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/groupTypes": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new groupTypes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "createItemsGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the groupTypes items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "readItemsGroupTypes",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple groupTypes items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "updateItemsGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing groupTypes items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "deleteItemsGroupTypes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/groupTypes/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single groupTypes item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "readSingleItemsGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing groupTypes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "updateSingleItemsGroupTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing groupTypes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsGroupTypes"
|
|
],
|
|
"operationId": "deleteSingleItemsGroupTypes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/marker_icons": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new marker_icons item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "createItemsMarkerIcons",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the marker_icons items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "readItemsMarkerIcons",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple marker_icons items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "updateItemsMarkerIcons",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing marker_icons items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "deleteItemsMarkerIcons",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/marker_icons/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single marker_icons item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "readSingleItemsMarkerIcons",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing marker_icons item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "updateSingleItemsMarkerIcons",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing marker_icons item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsMarkerIcons"
|
|
],
|
|
"operationId": "deleteSingleItemsMarkerIcons",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/inviteLinks": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new inviteLinks item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "createItemsInviteLinks",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the inviteLinks items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "readItemsInviteLinks",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple inviteLinks items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "updateItemsInviteLinks",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing inviteLinks items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "deleteItemsInviteLinks",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/inviteLinks/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single inviteLinks item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "readSingleItemsInviteLinks",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing inviteLinks item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "updateSingleItemsInviteLinks",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing inviteLinks item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsInviteLinks"
|
|
],
|
|
"operationId": "deleteSingleItemsInviteLinks",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/items": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new items item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "createItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the items items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "readItemsItems",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple items items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "updateItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing items items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "deleteItemsItems",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/items/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single items item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "readSingleItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing items item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "updateSingleItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing items item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItems"
|
|
],
|
|
"operationId": "deleteSingleItemsItems",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/itemSecrets": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new itemSecrets item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "createItemsItemSecrets",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the itemSecrets items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "readItemsItemSecrets",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple itemSecrets items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "updateItemsItemSecrets",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing itemSecrets items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "deleteItemsItemSecrets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/itemSecrets/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single itemSecrets item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "readSingleItemsItemSecrets",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing itemSecrets item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "updateSingleItemsItemSecrets",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing itemSecrets item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemSecrets"
|
|
],
|
|
"operationId": "deleteSingleItemsItemSecrets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/layers": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new layers item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "createItemsLayers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the layers items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "readItemsLayers",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple layers items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "updateItemsLayers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing layers items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "deleteItemsLayers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/layers/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single layers item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "readSingleItemsLayers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing layers item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "updateSingleItemsLayers",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing layers item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayers"
|
|
],
|
|
"operationId": "deleteSingleItemsLayers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/items_files": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new items_files item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "createItemsItemsFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the items_files items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "readItemsItemsFiles",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple items_files items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "updateItemsItemsFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing items_files items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "deleteItemsItemsFiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/items_files/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single items_files item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "readSingleItemsItemsFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing items_files item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "updateSingleItemsItemsFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing items_files item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsFiles"
|
|
],
|
|
"operationId": "deleteSingleItemsItemsFiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/items_items": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new items_items item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "createItemsItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the items_items items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "readItemsItemsItems",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple items_items items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "updateItemsItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing items_items items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "deleteItemsItemsItems",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/items_items/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single items_items item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "readSingleItemsItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing items_items item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "updateSingleItemsItemsItems",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing items_items item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsItems"
|
|
],
|
|
"operationId": "deleteSingleItemsItemsItems",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/items_tags": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new items_tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "createItemsItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the items_tags items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "readItemsItemsTags",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple items_tags items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "updateItemsItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing items_tags items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "deleteItemsItemsTags",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/items_tags/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single items_tags item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "readSingleItemsItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing items_tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "updateSingleItemsItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing items_tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags"
|
|
],
|
|
"operationId": "deleteSingleItemsItemsTags",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/tags": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "createItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the tags items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "readItemsTags",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple tags items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "updateItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing tags items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "deleteItemsTags",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/tags/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single tags item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "readSingleItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "updateSingleItemsTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTags"
|
|
],
|
|
"operationId": "deleteSingleItemsTags",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/items_tags_1": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new items_tags_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "createItemsItemsTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the items_tags_1 items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "readItemsItemsTags1",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple items_tags_1 items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "updateItemsItemsTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing items_tags_1 items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "deleteItemsItemsTags1",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/items_tags_1/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single items_tags_1 item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "readSingleItemsItemsTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing items_tags_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "updateSingleItemsItemsTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing items_tags_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsItemsTags1"
|
|
],
|
|
"operationId": "deleteSingleItemsItemsTags1",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/junction_directus_users_tags": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new junction_directus_users_tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "createItemsJunctionDirectusUsersTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the junction_directus_users_tags items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "readItemsJunctionDirectusUsersTags",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple junction_directus_users_tags items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "updateItemsJunctionDirectusUsersTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing junction_directus_users_tags items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "deleteItemsJunctionDirectusUsersTags",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/junction_directus_users_tags/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single junction_directus_users_tags item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "readSingleItemsJunctionDirectusUsersTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing junction_directus_users_tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "updateSingleItemsJunctionDirectusUsersTags",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing junction_directus_users_tags item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags"
|
|
],
|
|
"operationId": "deleteSingleItemsJunctionDirectusUsersTags",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/junction_directus_users_tags_1": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new junction_directus_users_tags_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "createItemsJunctionDirectusUsersTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the junction_directus_users_tags_1 items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "readItemsJunctionDirectusUsersTags1",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple junction_directus_users_tags_1 items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "updateItemsJunctionDirectusUsersTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing junction_directus_users_tags_1 items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "deleteItemsJunctionDirectusUsersTags1",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/junction_directus_users_tags_1/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single junction_directus_users_tags_1 item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "readSingleItemsJunctionDirectusUsersTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing junction_directus_users_tags_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "updateSingleItemsJunctionDirectusUsersTags1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsJunctionDirectusUsersTags1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing junction_directus_users_tags_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsJunctionDirectusUsersTags1"
|
|
],
|
|
"operationId": "deleteSingleItemsJunctionDirectusUsersTags1",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/types": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new types item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "createItemsTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the types items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "readItemsTypes",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple types items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "updateItemsTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing types items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "deleteItemsTypes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/types/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single types item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "readSingleItemsTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing types item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "updateSingleItemsTypes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing types item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypes"
|
|
],
|
|
"operationId": "deleteSingleItemsTypes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/layers_directus_users_1": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new layers_directus_users_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "createItemsLayersDirectusUsers1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the layers_directus_users_1 items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "readItemsLayersDirectusUsers1",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple layers_directus_users_1 items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "updateItemsLayersDirectusUsers1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing layers_directus_users_1 items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "deleteItemsLayersDirectusUsers1",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/layers_directus_users_1/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single layers_directus_users_1 item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "readSingleItemsLayersDirectusUsers1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing layers_directus_users_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "updateSingleItemsLayersDirectusUsers1",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing layers_directus_users_1 item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersDirectusUsers1"
|
|
],
|
|
"operationId": "deleteSingleItemsLayersDirectusUsers1",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/layers_files": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new layers_files item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "createItemsLayersFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the layers_files items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "readItemsLayersFiles",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple layers_files items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "updateItemsLayersFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing layers_files items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "deleteItemsLayersFiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/layers_files/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single layers_files item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "readSingleItemsLayersFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing layers_files item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "updateSingleItemsLayersFiles",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersFiles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing layers_files item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersFiles"
|
|
],
|
|
"operationId": "deleteSingleItemsLayersFiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/layers_maps": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new layers_maps item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "createItemsLayersMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the layers_maps items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "readItemsLayersMaps",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple layers_maps items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "updateItemsLayersMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing layers_maps items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "deleteItemsLayersMaps",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/layers_maps/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single layers_maps item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "readSingleItemsLayersMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing layers_maps item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "updateSingleItemsLayersMaps",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing layers_maps item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsLayersMaps"
|
|
],
|
|
"operationId": "deleteSingleItemsLayersMaps",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/Themes": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new Themes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "createItemsThemes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the Themes items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "readItemsThemes",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple Themes items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "updateItemsThemes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing Themes items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "deleteItemsThemes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/Themes/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single Themes item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "readSingleItemsThemes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing Themes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "updateSingleItemsThemes",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing Themes item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsThemes"
|
|
],
|
|
"operationId": "deleteSingleItemsThemes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/startEnd": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new startEnd item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "createItemsStartEnd",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the startEnd items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "readItemsStartEnd",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple startEnd items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "updateItemsStartEnd",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing startEnd items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "deleteItemsStartEnd",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/startEnd/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single startEnd item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "readSingleItemsStartEnd",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing startEnd item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "updateSingleItemsStartEnd",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing startEnd item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsStartEnd"
|
|
],
|
|
"operationId": "deleteSingleItemsStartEnd",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/team": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new team item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "createItemsTeam",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the team items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "readItemsTeam",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple team items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "updateItemsTeam",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing team items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "deleteItemsTeam",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/team/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single team item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "readSingleItemsTeam",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing team item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "updateSingleItemsTeam",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTeam"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing team item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTeam"
|
|
],
|
|
"operationId": "deleteSingleItemsTeam",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/texts": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new texts item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "createItemsTexts",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the texts items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "readItemsTexts",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple texts items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "updateItemsTexts",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing texts items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "deleteItemsTexts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/texts/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single texts item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "readSingleItemsTexts",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing texts item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "updateSingleItemsTexts",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing texts item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTexts"
|
|
],
|
|
"operationId": "deleteSingleItemsTexts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/items/types_profileTemplate": {
|
|
"post": {
|
|
"summary": "Create an Item",
|
|
"description": "Create a new types_profileTemplate item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "createItemsTypesProfileTemplate",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "List Items",
|
|
"description": "List the types_profileTemplate items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "readItemsTypesProfileTemplate",
|
|
"security": [
|
|
{
|
|
"Auth": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
},
|
|
"meta": {
|
|
"$ref": "#/components/schemas/x-metadata"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update Multiple Items",
|
|
"description": "Update multiple types_profileTemplate items at the same time.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "updateItemsTypesProfileTemplate",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Limit"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Offset"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Sort"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Filter"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Search"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete Multiple Items",
|
|
"description": "Delete multiple existing types_profileTemplate items.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "deleteItemsTypesProfileTemplate",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
}
|
|
},
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/items/types_profileTemplate/{id}": {
|
|
"get": {
|
|
"summary": "Retrieve an Item",
|
|
"description": "Retrieve a single types_profileTemplate item by unique identifier.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "readSingleItemsTypesProfileTemplate",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Version"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update an Item",
|
|
"description": "Update an existing types_profileTemplate item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "updateSingleItemsTypesProfileTemplate",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Fields"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/Meta"
|
|
},
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete an Item",
|
|
"description": "Delete an existing types_profileTemplate item.",
|
|
"tags": [
|
|
"Items",
|
|
"ItemsTypesProfileTemplate"
|
|
],
|
|
"operationId": "deleteSingleItemsTypesProfileTemplate",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful request"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/UnauthorizedError"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/NotFoundError"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "Index of the item.",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Incremental index of the item.",
|
|
"example": 1
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Unique identifier of the item.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Assets",
|
|
"description": "Image typed files can be dynamically resized and transformed to fit any need."
|
|
},
|
|
{
|
|
"name": "Authentication",
|
|
"description": "All data within the platform is private by default. The public role can be configured to expose data without authentication, or you can pass an access token to the API to access private data."
|
|
},
|
|
{
|
|
"name": "Schema",
|
|
"description": "Retrieve and update the schema of an instance.",
|
|
"x-authentication": "admin",
|
|
"x-schemas": [
|
|
"Schema",
|
|
"Diff"
|
|
]
|
|
},
|
|
{
|
|
"name": "Server",
|
|
"description": "Access to where Directus runs. Allows you to make sure your server has everything needed to run the platform, and check what kind of latency we're dealing with."
|
|
},
|
|
{
|
|
"name": "Utilities",
|
|
"description": "Directus comes with various utility endpoints you can use to simplify your development flow.",
|
|
"x-authentication": "user",
|
|
"x-schemas": [
|
|
"Files",
|
|
"Folders",
|
|
"Users",
|
|
"Roles"
|
|
]
|
|
},
|
|
{
|
|
"name": "Roles",
|
|
"description": "Roles are groups of users that share permissions.",
|
|
"x-collection": "directus_roles"
|
|
},
|
|
{
|
|
"name": "Collections",
|
|
"description": "Collections are the individual collections of items, similar to tables in a database. Changes to collections will alter the schema of the database.",
|
|
"x-collection": "directus_collections"
|
|
},
|
|
{
|
|
"name": "Fields",
|
|
"description": "Fields are individual pieces of content within an item. They are mapped to columns in the database.",
|
|
"x-collection": "directus_fields"
|
|
},
|
|
{
|
|
"name": "Files",
|
|
"description": "Files can be saved in any given location. Directus has a powerful assets endpoint that can be used to generate thumbnails for images on the fly.",
|
|
"x-collection": "directus_files"
|
|
},
|
|
{
|
|
"name": "Folders",
|
|
"description": "Group files by virtual folders.",
|
|
"x-collection": "directus_folders"
|
|
},
|
|
{
|
|
"name": "Activity",
|
|
"description": "All events that happen within Directus are tracked and stored in the activities collection. This gives you full accountability over everything that happens.",
|
|
"x-collection": "directus_activity"
|
|
},
|
|
{
|
|
"name": "Revisions",
|
|
"description": "Revisions are individual changes to items made. Directus keeps track of changes made, so you're able to revert to a previous state at will.",
|
|
"x-collection": "directus_revisions"
|
|
},
|
|
{
|
|
"name": "Relations",
|
|
"description": "What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of.",
|
|
"x-collection": "directus_relations"
|
|
},
|
|
{
|
|
"name": "Permissions",
|
|
"description": "Permissions control who has access to what and when.",
|
|
"x-collection": "directus_permissions"
|
|
},
|
|
{
|
|
"name": "Users",
|
|
"description": "Users are what gives you access to the data.",
|
|
"x-collection": "directus_users"
|
|
},
|
|
{
|
|
"name": "Presets",
|
|
"description": "Presets hold the preferences of individual users of the platform. This allows Directus to show and maintain custom item listings for users of the app.",
|
|
"x-collection": "directus_presets"
|
|
},
|
|
{
|
|
"name": "Webhooks",
|
|
"description": "Webhooks.",
|
|
"x-collection": "directus_webhooks"
|
|
},
|
|
{
|
|
"name": "Flows",
|
|
"description": "Flows enable custom, event-driven data processing and task automation.",
|
|
"x-collection": "directus_flows"
|
|
},
|
|
{
|
|
"name": "Operations",
|
|
"description": "Operations are the building blocks within Data Flows.",
|
|
"x-collection": "directus_operations"
|
|
},
|
|
{
|
|
"name": "Comments",
|
|
"description": "Comments can be added to items.",
|
|
"x-collection": "directus_comments"
|
|
},
|
|
{
|
|
"name": "Versions",
|
|
"description": "Enables users to create unpublished copies of an item, modify them independently from the main version, and promote them to become the new main version when ready.",
|
|
"x-collection": "directus_versions"
|
|
},
|
|
{
|
|
"name": "Settings",
|
|
"description": "Settings control the way the platform works and acts.",
|
|
"x-collection": "directus_settings"
|
|
},
|
|
{
|
|
"name": "Extensions",
|
|
"description": "Directus can easily be extended through the addition of several types of extensions, including layouts, interfaces, and modules.",
|
|
"x-collection": "directus_extensions"
|
|
},
|
|
{
|
|
"name": "ItemsDirectusSyncIDMap",
|
|
"x-collection": "directus_sync_id_map"
|
|
},
|
|
{
|
|
"name": "ItemsRelations",
|
|
"x-collection": "relations"
|
|
},
|
|
{
|
|
"name": "ItemsOceannomadsProfiles",
|
|
"x-collection": "oceannomads_profiles"
|
|
},
|
|
{
|
|
"name": "ItemsMaps",
|
|
"x-collection": "maps"
|
|
},
|
|
{
|
|
"name": "ItemsAttestations",
|
|
"x-collection": "attestations"
|
|
},
|
|
{
|
|
"name": "ItemsAttestationsDirectusUsers",
|
|
"x-collection": "attestations_directus_users"
|
|
},
|
|
{
|
|
"name": "ItemsContactInfos",
|
|
"x-collection": "contactInfos"
|
|
},
|
|
{
|
|
"name": "ItemsCrowdfundings",
|
|
"x-collection": "crowdfundings"
|
|
},
|
|
{
|
|
"name": "ItemsFeatures",
|
|
"x-collection": "features"
|
|
},
|
|
{
|
|
"name": "ItemsGallery",
|
|
"x-collection": "gallery"
|
|
},
|
|
{
|
|
"name": "ItemsGroupSubheaders",
|
|
"x-collection": "groupSubheaders"
|
|
},
|
|
{
|
|
"name": "ItemsGroupSubheadersGroupTypes",
|
|
"x-collection": "groupSubheaders_groupTypes"
|
|
},
|
|
{
|
|
"name": "ItemsGroupTypes",
|
|
"x-collection": "groupTypes"
|
|
},
|
|
{
|
|
"name": "ItemsMarkerIcons",
|
|
"x-collection": "marker_icons"
|
|
},
|
|
{
|
|
"name": "ItemsInviteLinks",
|
|
"x-collection": "inviteLinks"
|
|
},
|
|
{
|
|
"name": "ItemsItems",
|
|
"x-collection": "items"
|
|
},
|
|
{
|
|
"name": "ItemsItemSecrets",
|
|
"x-collection": "itemSecrets"
|
|
},
|
|
{
|
|
"name": "ItemsLayers",
|
|
"x-collection": "layers"
|
|
},
|
|
{
|
|
"name": "ItemsItemsFiles",
|
|
"x-collection": "items_files"
|
|
},
|
|
{
|
|
"name": "ItemsItemsItems",
|
|
"x-collection": "items_items"
|
|
},
|
|
{
|
|
"name": "ItemsItemsTags",
|
|
"x-collection": "items_tags"
|
|
},
|
|
{
|
|
"name": "ItemsTags",
|
|
"x-collection": "tags"
|
|
},
|
|
{
|
|
"name": "ItemsItemsTags1",
|
|
"x-collection": "items_tags_1"
|
|
},
|
|
{
|
|
"name": "ItemsJunctionDirectusUsersTags",
|
|
"x-collection": "junction_directus_users_tags"
|
|
},
|
|
{
|
|
"name": "ItemsJunctionDirectusUsersTags1",
|
|
"x-collection": "junction_directus_users_tags_1"
|
|
},
|
|
{
|
|
"name": "ItemsTypes",
|
|
"x-collection": "types"
|
|
},
|
|
{
|
|
"name": "ItemsLayersDirectusUsers1",
|
|
"x-collection": "layers_directus_users_1"
|
|
},
|
|
{
|
|
"name": "ItemsLayersFiles",
|
|
"x-collection": "layers_files"
|
|
},
|
|
{
|
|
"name": "ItemsLayersMaps",
|
|
"x-collection": "layers_maps"
|
|
},
|
|
{
|
|
"name": "ItemsThemes",
|
|
"x-collection": "Themes"
|
|
},
|
|
{
|
|
"name": "ItemsStartEnd",
|
|
"x-collection": "startEnd"
|
|
},
|
|
{
|
|
"name": "ItemsTeam",
|
|
"x-collection": "team"
|
|
},
|
|
{
|
|
"name": "ItemsTexts",
|
|
"x-collection": "texts"
|
|
},
|
|
{
|
|
"name": "ItemsTypesProfileTemplate",
|
|
"x-collection": "types_profileTemplate"
|
|
}
|
|
],
|
|
"components": {
|
|
"schemas": {
|
|
"Diff": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"diff": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collections": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string"
|
|
},
|
|
"diff": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string"
|
|
},
|
|
"field": {
|
|
"type": "string"
|
|
},
|
|
"diff": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"relations": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collection": {
|
|
"type": "string"
|
|
},
|
|
"field": {
|
|
"type": "string"
|
|
},
|
|
"related_collection": {
|
|
"type": "string"
|
|
},
|
|
"diff": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Files": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the file.",
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02",
|
|
"type": "string"
|
|
},
|
|
"storage": {
|
|
"description": "Where the file is stored. Either `local` for the local filesystem or the name of the storage adapter (for example `s3`).",
|
|
"example": "local",
|
|
"type": "string"
|
|
},
|
|
"filename_disk": {
|
|
"description": "Name of the file on disk. By default, Directus uses a random hash for the filename.",
|
|
"example": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg",
|
|
"type": "string"
|
|
},
|
|
"filename_download": {
|
|
"description": "How you want to the file to be named when it's being downloaded.",
|
|
"example": "avatar.jpg",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title for the file. Is extracted from the filename on upload, but can be edited by the user.",
|
|
"example": "User Avatar",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "MIME type of the file.",
|
|
"example": "image/jpeg",
|
|
"type": "string"
|
|
},
|
|
"folder": {
|
|
"description": "Virtual folder where this file resides in.",
|
|
"example": null,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"uploaded_by": {
|
|
"description": "Who uploaded the file.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"created_on": {
|
|
"description": "When the file was created.",
|
|
"example": "2019-12-03T00:10:15+00:00",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"modified_by": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"modified_on": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"charset": {
|
|
"description": "Character set of the file.",
|
|
"example": "binary",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"filesize": {
|
|
"description": "Size of the file in bytes.",
|
|
"example": 137862,
|
|
"type": "integer"
|
|
},
|
|
"width": {
|
|
"description": "Width of the file in pixels. Only applies to images.",
|
|
"example": 800,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"height": {
|
|
"description": "Height of the file in pixels. Only applies to images.",
|
|
"example": 838,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"duration": {
|
|
"description": "Duration of the file in seconds. Only applies to audio and video.",
|
|
"example": 0,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"embed": {
|
|
"description": "Where the file was embedded from.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"description": "Description for the file.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"location": {
|
|
"description": "Where the file was created. Is automatically populated based on Exif data for images.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tags": {
|
|
"description": "Tags for the file. Is automatically populated based on Exif data for images.",
|
|
"type": "array",
|
|
"nullable": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"metadata": {
|
|
"description": "IPTC, Exif, and ICC metadata extracted from file",
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"focal_point_x": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"focal_point_y": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"tus_id": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"tus_data": {
|
|
"nullable": true
|
|
},
|
|
"uploaded_on": {
|
|
"description": "When the file was last uploaded/replaced.",
|
|
"example": "2019-12-03T00:10:15+00:00",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"x-collection": "directus_files"
|
|
},
|
|
"Folders": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the folder.",
|
|
"example": "0cf0e03d-4364-45df-b77b-ca61f61869d2",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the folder.",
|
|
"example": "New York",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "Unique identifier of the parent folder. This allows for nested folders.",
|
|
"example": null,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Folders"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"x-collection": "directus_folders"
|
|
},
|
|
"Roles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the role.",
|
|
"example": "2f24211d-d928-469a-aea3-3c8f53d4e426",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the role.",
|
|
"example": "Administrator",
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"description": "The role's icon.",
|
|
"example": "verified_user",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Description of the role.",
|
|
"example": "Admins have access to all managed data within the system by default",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"nullable": true,
|
|
"description": "$t:field_options.directus_roles.parent_note",
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
]
|
|
},
|
|
"children": {
|
|
"nullable": true,
|
|
"description": "$t:field_options.directus_roles.children_note",
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"policies": {
|
|
"nullable": true
|
|
},
|
|
"users": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "directus_roles"
|
|
},
|
|
"Schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "integer",
|
|
"example": 1
|
|
},
|
|
"directus": {
|
|
"type": "string"
|
|
},
|
|
"vendor": {
|
|
"type": "string"
|
|
},
|
|
"collections": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
},
|
|
"relations": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Relations"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Users": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the user.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name of the user.",
|
|
"example": "Admin",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name of the user.",
|
|
"example": "User",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "Unique email address for the user.",
|
|
"example": "admin@example.com",
|
|
"type": "string",
|
|
"format": "email"
|
|
},
|
|
"password": {
|
|
"description": "Password of the user.",
|
|
"type": "string"
|
|
},
|
|
"location": {
|
|
"description": "The user's location.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"title": {
|
|
"description": "The user's title.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"description": "The user's description.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tags": {
|
|
"description": "The user's tags.",
|
|
"example": null,
|
|
"type": "array",
|
|
"nullable": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"avatar": {
|
|
"description": "The user's avatar.",
|
|
"example": null,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"language": {
|
|
"description": "The user's language used in Directus.",
|
|
"example": "en-US",
|
|
"type": "string"
|
|
},
|
|
"tfa_secret": {
|
|
"description": "The 2FA secret string that's used to generate one time passwords.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"description": "Status of the user.",
|
|
"example": "active",
|
|
"type": "string",
|
|
"enum": [
|
|
"active",
|
|
"invited",
|
|
"draft",
|
|
"suspended",
|
|
"deleted"
|
|
]
|
|
},
|
|
"role": {
|
|
"description": "Unique identifier of the role of this user.",
|
|
"example": "2f24211d-d928-469a-aea3-3c8f53d4e426",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
]
|
|
},
|
|
"token": {
|
|
"description": "Static token for the user.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"last_access": {
|
|
"description": "When this user used the API last.",
|
|
"example": "2020-05-31T14:32:37Z",
|
|
"type": "string",
|
|
"nullable": true,
|
|
"format": "date-time"
|
|
},
|
|
"last_page": {
|
|
"description": "Last page that the user was on.",
|
|
"example": "/my-project/settings/collections/a",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"provider": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"external_identifier": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"auth_data": {
|
|
"nullable": true
|
|
},
|
|
"email_notifications": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"appearance": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"theme_dark": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"theme_light": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"theme_light_overrides": {
|
|
"nullable": true
|
|
},
|
|
"theme_dark_overrides": {
|
|
"nullable": true
|
|
},
|
|
"imported": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"wc_user": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"notifications": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"policies": {
|
|
"nullable": true
|
|
}
|
|
},
|
|
"x-collection": "directus_users"
|
|
},
|
|
"Query": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Control what fields are being returned in the object.",
|
|
"example": [
|
|
"*",
|
|
"*.*"
|
|
]
|
|
},
|
|
"filter": {
|
|
"type": "object",
|
|
"example": {
|
|
"<field>": {
|
|
"<operator>": "<value>"
|
|
}
|
|
}
|
|
},
|
|
"search": {
|
|
"description": "Filter by items that contain the given search query in one of their fields.",
|
|
"type": "string"
|
|
},
|
|
"sort": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "How to sort the returned items.",
|
|
"example": [
|
|
"-date_created"
|
|
]
|
|
},
|
|
"limit": {
|
|
"type": "number",
|
|
"description": "Set the maximum number of items that will be returned"
|
|
},
|
|
"offset": {
|
|
"type": "number",
|
|
"description": "How many items to skip when fetching data."
|
|
},
|
|
"page": {
|
|
"type": "number",
|
|
"description": "Cursor for use in pagination. Often used in combination with limit."
|
|
},
|
|
"deep": {
|
|
"type": "object",
|
|
"description": "Deep allows you to set any of the other query parameters on a nested relational dataset.",
|
|
"example": {
|
|
"related_articles": {
|
|
"_limit": 3
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-metadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"total_count": {
|
|
"description": "Returns the total item count of the collection you're querying.",
|
|
"type": "integer"
|
|
},
|
|
"filter_count": {
|
|
"description": "Returns the item count of the collection you're querying, taking the current filter/search parameters into account.",
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"Collections": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collection": {
|
|
"description": "The collection key.",
|
|
"example": "customers",
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"display_template": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"hidden": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"singleton": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"translations": {
|
|
"nullable": true
|
|
},
|
|
"archive_field": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"archive_app_filter": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"archive_value": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"unarchive_value": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"sort_field": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"accountability": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"color": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"item_duplication_fields": {
|
|
"nullable": true
|
|
},
|
|
"sort": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"group": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
]
|
|
},
|
|
"collapse": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"preview_url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"versioning": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"x-collection": "directus_collections"
|
|
},
|
|
"Fields": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"collection": {
|
|
"description": "Unique name of the collection this field is in.",
|
|
"example": "about_us",
|
|
"type": "string"
|
|
},
|
|
"field": {
|
|
"description": "Unique name of the field. Field name is unique within the collection.",
|
|
"example": "id",
|
|
"type": "string"
|
|
},
|
|
"special": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"interface": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"nullable": true
|
|
},
|
|
"display": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"display_options": {
|
|
"nullable": true
|
|
},
|
|
"readonly": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"hidden": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"sort": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"width": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"translations": {
|
|
"nullable": true
|
|
},
|
|
"note": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"conditions": {
|
|
"nullable": true
|
|
},
|
|
"required": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"group": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Fields"
|
|
}
|
|
]
|
|
},
|
|
"validation": {
|
|
"nullable": true
|
|
},
|
|
"validation_message": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "directus_fields"
|
|
},
|
|
"Activity": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the object.",
|
|
"example": 2,
|
|
"type": "integer"
|
|
},
|
|
"action": {
|
|
"description": "Action that was performed.",
|
|
"example": "update",
|
|
"type": "string",
|
|
"enum": [
|
|
"create",
|
|
"update",
|
|
"delete",
|
|
"login"
|
|
]
|
|
},
|
|
"user": {
|
|
"description": "The user who performed this action.",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"timestamp": {
|
|
"description": "When the action happened.",
|
|
"example": "2019-12-05T22:52:09Z",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"ip": {
|
|
"description": "The IP address of the user at the time the action took place.",
|
|
"example": "127.0.0.1",
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "ipv4"
|
|
}
|
|
]
|
|
},
|
|
"user_agent": {
|
|
"description": "User agent string of the browser the user used when the action took place.",
|
|
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/78.0.3904.108 Safari/537.36",
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"description": "Collection identifier in which the item resides.",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
]
|
|
},
|
|
"item": {
|
|
"description": "Unique identifier for the item the action applied to. This is always a string, even for integer primary keys.",
|
|
"example": "328",
|
|
"type": "string"
|
|
},
|
|
"origin": {
|
|
"description": "Origin of the request when the action took place.",
|
|
"example": "https://directus.io",
|
|
"type": "string"
|
|
},
|
|
"revisions": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Revisions"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "directus_activity"
|
|
},
|
|
"Revisions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the revision.",
|
|
"example": 1,
|
|
"type": "integer"
|
|
},
|
|
"activity": {
|
|
"description": "Unique identifier for the activity record.",
|
|
"example": 2,
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Activity"
|
|
}
|
|
]
|
|
},
|
|
"collection": {
|
|
"description": "Collection of the updated item.",
|
|
"example": "articles",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
]
|
|
},
|
|
"item": {
|
|
"description": "Primary key of updated item.",
|
|
"example": "168",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"description": "Copy of item state at time of update.",
|
|
"example": {
|
|
"author": 1,
|
|
"body": "This is my first post",
|
|
"featured_image": 15,
|
|
"id": "168",
|
|
"title": "Hello, World!"
|
|
},
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"delta": {
|
|
"description": "Changes between the previous and the current revision.",
|
|
"example": {
|
|
"title": "Hello, World!"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "If the current item was updated relationally, this is the id of the parent revision record",
|
|
"example": null,
|
|
"type": "integer",
|
|
"nullable": true
|
|
},
|
|
"version": {
|
|
"description": "Associated version of this revision.",
|
|
"example": "draft",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Versions"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "directus_revisions"
|
|
},
|
|
"Relations": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the relation.",
|
|
"example": 1,
|
|
"type": "integer"
|
|
},
|
|
"many_collection": {
|
|
"description": "Collection that has the field that holds the foreign key.",
|
|
"example": "directus_activity",
|
|
"type": "string"
|
|
},
|
|
"many_field": {
|
|
"description": "Foreign key. Field that holds the primary key of the related collection.",
|
|
"example": "user",
|
|
"type": "string"
|
|
},
|
|
"one_collection": {
|
|
"description": "Collection on the _one_ side of the relationship.",
|
|
"example": "directus_users",
|
|
"type": "string"
|
|
},
|
|
"one_field": {
|
|
"description": "Alias column that serves as the _one_ side of the relationship.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"one_collection_field": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"one_allowed_collections": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"junction_field": {
|
|
"description": "Field on the junction table that holds the many field of the related relation.",
|
|
"example": null,
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sort_field": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"one_deselect_action": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "directus_relations"
|
|
},
|
|
"Permissions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the permission.",
|
|
"example": 1,
|
|
"type": "integer"
|
|
},
|
|
"collection": {
|
|
"description": "What collection this permission applies to.",
|
|
"example": "customers",
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"description": "What action this permission applies to.",
|
|
"example": "create",
|
|
"type": "string",
|
|
"enum": [
|
|
"create",
|
|
"read",
|
|
"update",
|
|
"delete"
|
|
]
|
|
},
|
|
"permissions": {
|
|
"description": "JSON structure containing the permissions checks for this permission.",
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"validation": {
|
|
"description": "JSON structure containing the validation checks for this permission.",
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"presets": {
|
|
"description": "JSON structure containing the preset value for created/updated items.",
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"fields": {
|
|
"description": "CSV of fields that the user is allowed to interact with.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"policy": {
|
|
"nullable": false
|
|
}
|
|
},
|
|
"x-collection": "directus_permissions"
|
|
},
|
|
"Presets": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for this single collection preset.",
|
|
"example": 155,
|
|
"type": "integer"
|
|
},
|
|
"bookmark": {
|
|
"description": "Name for the bookmark. If this is set, the preset will be considered a bookmark.",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"description": "The unique identifier of the user to whom this collection preset applies.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"role": {
|
|
"description": "The unique identifier of a role in the platform. If `user` is null, this will be used to apply the collection preset or bookmark for all users in the role.",
|
|
"example": "50419801-0f30-8644-2b3c-9bc2d980d0a0",
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
]
|
|
},
|
|
"collection": {
|
|
"description": "What collection this collection preset is used for.",
|
|
"example": "articles",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
]
|
|
},
|
|
"search": {
|
|
"description": "Search query.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"layout": {
|
|
"description": "Key of the layout that is used.",
|
|
"type": "string",
|
|
"example": null
|
|
},
|
|
"layout_query": {
|
|
"description": "Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters.",
|
|
"example": {
|
|
"cards": {
|
|
"sort": "-published_on"
|
|
}
|
|
},
|
|
"nullable": true
|
|
},
|
|
"layout_options": {
|
|
"description": "Options of the views. The properties in here are controlled by the layout.",
|
|
"example": {
|
|
"cards": {
|
|
"icon": "account_circle",
|
|
"title": "{{ first_name }} {{ last_name }}",
|
|
"subtitle": "{{ title }}",
|
|
"size": 3
|
|
}
|
|
},
|
|
"nullable": true
|
|
},
|
|
"refresh_interval": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"filter": {
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"color": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "directus_presets"
|
|
},
|
|
"Webhooks": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "The index of the webhook.",
|
|
"type": "integer",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"description": "The name of the webhook.",
|
|
"type": "string",
|
|
"example": "create articles"
|
|
},
|
|
"method": {
|
|
"description": "Method used in the webhook.",
|
|
"type": "string",
|
|
"example": "POST"
|
|
},
|
|
"url": {
|
|
"description": "The url of the webhook.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"description": "The status of the webhook.",
|
|
"type": "string",
|
|
"example": "inactive"
|
|
},
|
|
"data": {
|
|
"description": "If yes, send the content of what was done",
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"actions": {
|
|
"description": "The actions that triggers this webhook.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"collections": {
|
|
"nullable": false,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"headers": {
|
|
"nullable": true
|
|
},
|
|
"was_active_before_deprecation": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"migrated_flow": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "directus_webhooks"
|
|
},
|
|
"Flows": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the flow.",
|
|
"type": "string",
|
|
"example": "2f24211d-d928-469a-aea3-3c8f53d4e426"
|
|
},
|
|
"name": {
|
|
"description": "The name of the flow.",
|
|
"type": "string",
|
|
"example": "Update Articles Flow"
|
|
},
|
|
"icon": {
|
|
"description": "Icon displayed in the Admin App for the flow.",
|
|
"type": "string",
|
|
"example": "bolt"
|
|
},
|
|
"color": {
|
|
"description": "Color of the icon displayed in the Admin App for the flow.",
|
|
"type": "string",
|
|
"example": "#112233",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Current status of the flow.",
|
|
"type": "string",
|
|
"example": "active",
|
|
"default": "active",
|
|
"enum": [
|
|
"active",
|
|
"inactive"
|
|
]
|
|
},
|
|
"trigger": {
|
|
"description": "Type of trigger for the flow. One of `hook`, `webhook`, `operation`, `schedule`, `manual`.",
|
|
"type": "string",
|
|
"example": "manual"
|
|
},
|
|
"accountability": {
|
|
"description": "The permission used during the flow. One of `$public`, `$trigger`, `$full`, or UUID of a role.",
|
|
"type": "string",
|
|
"example": "$trigger"
|
|
},
|
|
"options": {
|
|
"description": "Options of the selected trigger for the flow.",
|
|
"type": "object",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"operation": {
|
|
"description": "UUID of the operation connected to the trigger in the flow.",
|
|
"example": "92e82998-e421-412f-a513-13701e83e4ce",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
},
|
|
"date_created": {
|
|
"description": "Timestamp in ISO8601 when the flow was created.",
|
|
"type": "string",
|
|
"example": "2022-05-11T13:14:52Z",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"user_created": {
|
|
"description": "The user who created the flow.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"operations": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "directus_flows"
|
|
},
|
|
"Operations": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the operation.",
|
|
"type": "string",
|
|
"example": "2f24211d-d928-469a-aea3-3c8f53d4e426"
|
|
},
|
|
"name": {
|
|
"description": "The name of the operation.",
|
|
"type": "string",
|
|
"example": "Log to Console"
|
|
},
|
|
"key": {
|
|
"description": "Key for the operation. Must be unique within a given flow.",
|
|
"type": "string",
|
|
"example": "log_console"
|
|
},
|
|
"type": {
|
|
"description": "Type of operation. One of `log`, `mail`, `notification`, `create`, `read`, `request`, `sleep`, `transform`, `trigger`, `condition`, or any type of custom operation extensions.",
|
|
"type": "string",
|
|
"example": "log"
|
|
},
|
|
"position_x": {
|
|
"description": "Position of the operation on the X axis within the flow workspace.",
|
|
"type": "integer",
|
|
"example": 12
|
|
},
|
|
"position_y": {
|
|
"description": "Position of the operation on the Y axis within the flow workspace.",
|
|
"type": "integer",
|
|
"example": 12
|
|
},
|
|
"options": {
|
|
"description": "Options depending on the type of the operation.",
|
|
"type": "object",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"resolve": {
|
|
"description": "The operation triggered when the current operation succeeds (or `then` logic of a condition operation).",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
},
|
|
"reject": {
|
|
"description": "The operation triggered when the current operation fails (or `otherwise` logic of a condition operation).",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Operations"
|
|
}
|
|
]
|
|
},
|
|
"flow": {
|
|
"nullable": false,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Flows"
|
|
}
|
|
]
|
|
},
|
|
"date_created": {
|
|
"description": "Timestamp in ISO8601 when the operation was created.",
|
|
"type": "string",
|
|
"example": "2022-05-11T13:14:52Z",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"user_created": {
|
|
"description": "The user who created the operation.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "directus_operations"
|
|
},
|
|
"Comments": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for this single collection preset.",
|
|
"example": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28",
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"description": "The collection of the item the Comment is created for.",
|
|
"example": "articles",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
]
|
|
},
|
|
"item": {
|
|
"description": "The item the Comment is created for.",
|
|
"example": "123",
|
|
"type": "string"
|
|
},
|
|
"comment": {
|
|
"description": "User comment. This will store the comments that show up in the right sidebar of the item edit page in the admin app.",
|
|
"example": "This is a comment",
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"description": "When the Comment was created.",
|
|
"type": "string",
|
|
"example": "2024-01-23T12:34:56Z",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"date_updated": {
|
|
"description": "When the Comment was updated.",
|
|
"type": "string",
|
|
"example": "2024-01-23T12:34:56Z",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"user_created": {
|
|
"description": "User that created the Comment.",
|
|
"example": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"description": "User that updated the Comment.",
|
|
"example": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "directus_comments"
|
|
},
|
|
"Versions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Primary key of the Content Version.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"description": "Key of the Content Version, used as the value for the \"version\" query parameter.",
|
|
"example": "draft",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Descriptive name of the Content Version.",
|
|
"example": "My Draft",
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"description": "Name of the collection the Content Version is created on.",
|
|
"example": "articles",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Collections"
|
|
}
|
|
]
|
|
},
|
|
"item": {
|
|
"description": "The item the Content Version is created on.",
|
|
"example": "168",
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"description": "When the Content Version was created.",
|
|
"type": "string",
|
|
"example": "2022-05-11T13:14:52Z",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"date_updated": {
|
|
"description": "When the Content Version was last updated.",
|
|
"type": "string",
|
|
"example": "2022-05-11T13:14:53Z",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"user_created": {
|
|
"description": "User that created the Content Version.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"description": "User that last updated the Content Version.",
|
|
"example": "63716273-0f29-4648-8a2a-2af2948f6f78",
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"delta": {
|
|
"description": "The current changes compared to the main version of the item.",
|
|
"example": {
|
|
"my_field": "Updated Value"
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"x-collection": "directus_versions"
|
|
},
|
|
"Settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Unique identifier for the setting.",
|
|
"type": "integer",
|
|
"example": 1
|
|
},
|
|
"project_name": {
|
|
"description": "The name of the project.",
|
|
"type": "string",
|
|
"example": "Directus"
|
|
},
|
|
"project_url": {
|
|
"description": "The url of the project.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"project_color": {
|
|
"description": "The brand color of the project.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"project_logo": {
|
|
"description": "The logo of the project.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"public_foreground": {
|
|
"description": "The foreground of the project.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"public_background": {
|
|
"description": "The background of the project.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"public_note": {
|
|
"description": "Note rendered on the public pages of the app.",
|
|
"type": "string",
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"auth_login_attempts": {
|
|
"description": "Allowed authentication login attempts before the user's status is set to blocked.",
|
|
"type": "integer",
|
|
"example": 25
|
|
},
|
|
"auth_password_policy": {
|
|
"description": "Authentication password policy.",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"storage_asset_transform": {
|
|
"description": "What transformations are allowed in the assets endpoint.",
|
|
"type": "string",
|
|
"enum": [
|
|
"all",
|
|
"none",
|
|
"presets"
|
|
],
|
|
"example": "all",
|
|
"nullable": true
|
|
},
|
|
"storage_asset_presets": {
|
|
"description": "Array of allowed",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"description": "Key for the asset. Used in the assets endpoint.",
|
|
"type": "string"
|
|
},
|
|
"fit": {
|
|
"description": "Whether to crop the thumbnail to match the size, or maintain the aspect ratio.",
|
|
"type": "string",
|
|
"enum": [
|
|
"cover",
|
|
"contain",
|
|
"inside",
|
|
"outside"
|
|
]
|
|
},
|
|
"width": {
|
|
"description": "Width of the thumbnail.",
|
|
"type": "integer"
|
|
},
|
|
"height": {
|
|
"description": "Height of the thumbnail.",
|
|
"type": "integer"
|
|
},
|
|
"withoutEnlargement": {
|
|
"description": "No image upscale",
|
|
"type": "boolean"
|
|
},
|
|
"quality": {
|
|
"description": "Quality of the compression used.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"description": "Reformat output image",
|
|
"type": "string",
|
|
"enum": [
|
|
"",
|
|
"jpeg",
|
|
"png",
|
|
"webp",
|
|
"tiff",
|
|
"avif"
|
|
]
|
|
},
|
|
"transforms": {
|
|
"description": "Additional transformations to apply",
|
|
"type": "array",
|
|
"nullable": true,
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"method": {
|
|
"description": "The Sharp method name",
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"description": "A list of arguments to pass to the Sharp method",
|
|
"type": "array",
|
|
"nullable": true,
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"argument": {
|
|
"description": "A JSON representation of the argument value",
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"example": null,
|
|
"nullable": true
|
|
},
|
|
"custom_css": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"storage_default_folder": {
|
|
"description": "Default folder to place files",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"basemaps": {
|
|
"nullable": true
|
|
},
|
|
"mapbox_key": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"module_bar": {
|
|
"nullable": true
|
|
},
|
|
"project_descriptor": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"default_language": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"custom_aspect_ratios": {
|
|
"nullable": true
|
|
},
|
|
"public_favicon": {
|
|
"nullable": true,
|
|
"description": "$t:field_options.directus_settings.project_favicon_note",
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"default_appearance": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"default_theme_light": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"theme_light_overrides": {
|
|
"nullable": true
|
|
},
|
|
"default_theme_dark": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"theme_dark_overrides": {
|
|
"nullable": true
|
|
},
|
|
"report_error_url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"report_bug_url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"report_feature_url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"public_registration": {
|
|
"nullable": false,
|
|
"description": "$t:fields.directus_settings.public_registration_note",
|
|
"type": "boolean"
|
|
},
|
|
"public_registration_verify_email": {
|
|
"nullable": false,
|
|
"description": "$t:fields.directus_settings.public_registration_verify_email_note",
|
|
"type": "boolean"
|
|
},
|
|
"public_registration_role": {
|
|
"nullable": true,
|
|
"description": "$t:fields.directus_settings.public_registration_role_note",
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Roles"
|
|
}
|
|
]
|
|
},
|
|
"public_registration_email_filter": {
|
|
"nullable": true,
|
|
"description": "$t:fields.directus_settings.public_registration_email_filter_note"
|
|
},
|
|
"visual_editor_urls": {
|
|
"nullable": true
|
|
}
|
|
},
|
|
"x-collection": "directus_settings"
|
|
},
|
|
"Extensions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"folder": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"bundle": {
|
|
"description": "Name of the bundle the extension is in.",
|
|
"example": "directus-extension-my-bundle",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"x-collection": "directus_extensions"
|
|
},
|
|
"ItemsDirectusSyncIDMap": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"table": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"sync_id": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"local_id": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
}
|
|
},
|
|
"x-collection": "directus_sync_id_map",
|
|
"required": [
|
|
"table",
|
|
"sync_id",
|
|
"local_id"
|
|
]
|
|
},
|
|
"ItemsRelations": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"relation": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "relations"
|
|
},
|
|
"ItemsOceannomadsProfiles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"avatar_url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"email": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"location": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "oceannomads_profiles",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsMaps": {
|
|
"type": "object",
|
|
"properties": {
|
|
"center": {
|
|
"nullable": true,
|
|
"type": "object"
|
|
},
|
|
"custom_text": {
|
|
"nullable": true,
|
|
"description": "Replace the info text in the info popup",
|
|
"type": "string"
|
|
},
|
|
"default_theme": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsThemes"
|
|
}
|
|
]
|
|
},
|
|
"donation_widget": {
|
|
"nullable": true,
|
|
"description": "Shows a donation widget after 10 minutes",
|
|
"type": "boolean"
|
|
},
|
|
"expand_layer_control": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"geo": {
|
|
"nullable": true,
|
|
"description": "You can include GeoJSON"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"info_open": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"logo": {
|
|
"nullable": true,
|
|
"description": "Used as FavIcon",
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"own_tag_space": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_filter_control": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_gratitude_control": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_layer_control": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_theme_control": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_zoom_control": {
|
|
"nullable": false,
|
|
"type": "boolean"
|
|
},
|
|
"tile_server_attribution": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"tile_server_url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"zoom": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"hide_signup": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_request_password": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"layers": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "maps",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsAttestations": {
|
|
"type": "object",
|
|
"properties": {
|
|
"color": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"emoji": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"shape": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsAttestationsDirectusUsers"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "attestations",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsAttestationsDirectusUsers": {
|
|
"type": "object",
|
|
"properties": {
|
|
"attestations_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsAttestations"
|
|
}
|
|
]
|
|
},
|
|
"directus_users_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"x-collection": "attestations_directus_users"
|
|
},
|
|
"ItemsContactInfos": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"heading": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "contactInfos",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsCrowdfundings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "crowdfundings",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsFeatures": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"heading": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"sort": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"symbol": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "features"
|
|
},
|
|
"ItemsGallery": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"hideInputLabel": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "gallery",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsGroupSubheaders": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"groupStates": {
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"platforms": {
|
|
"nullable": true
|
|
},
|
|
"shareBaseUrl": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"groupTypes": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheadersGroupTypes"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "groupSubheaders",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsGroupSubheadersGroupTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupSubheaders_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
}
|
|
]
|
|
},
|
|
"groupTypes_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupTypes"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"x-collection": "groupSubheaders_groupTypes"
|
|
},
|
|
"ItemsGroupTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"color": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"image": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"markerIcon": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "groupTypes",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsMarkerIcons": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"size": {
|
|
"nullable": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"x-collection": "marker_icons",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsInviteLinks": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "inviteLinks",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"color": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"contact": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"draft": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"end": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"group_type": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"image": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"layer": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
]
|
|
},
|
|
"markerIcon": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"next_appointment": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"openCollectiveSlug": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
},
|
|
"position": {
|
|
"nullable": true,
|
|
"type": "object"
|
|
},
|
|
"public_edit": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"slug": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"start": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"subname": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"telephone": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"gallery": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsFiles"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"needs": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsTags1"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"offers": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsTags"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"relations": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemsItems"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"secrets": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItemSecrets"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "items",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsItemSecrets": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
},
|
|
"secret": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"x-collection": "itemSecrets",
|
|
"required": [
|
|
"secret"
|
|
]
|
|
},
|
|
"ItemsLayers": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"indexIcon": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"index_plus_button": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"itemType": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
]
|
|
},
|
|
"item_presets": {
|
|
"nullable": true
|
|
},
|
|
"listed": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"markerDefaultColor2": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"markerIcon": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMarkerIcons"
|
|
}
|
|
]
|
|
},
|
|
"markerShape": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"menuColor": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"menuIcon": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"menuText": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"onlyOnePerOwner": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"public_edit_items": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"userProfileLayer": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"maps": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersMaps"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notifications": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayersDirectusUsers1"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "layers",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsItemsFiles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"directus_files_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"items_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "items_files"
|
|
},
|
|
"ItemsItemsItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"items_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
},
|
|
"related_items_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "items_items"
|
|
},
|
|
"ItemsItemsTags": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"items_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
},
|
|
"tags_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "items_tags"
|
|
},
|
|
"ItemsTags": {
|
|
"type": "object",
|
|
"properties": {
|
|
"color": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"map": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"offer_or_need": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"x-collection": "tags",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsItemsTags1": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"items_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsItems"
|
|
}
|
|
]
|
|
},
|
|
"tags_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "items_tags_1"
|
|
},
|
|
"ItemsJunctionDirectusUsersTags": {
|
|
"type": "object",
|
|
"properties": {
|
|
"directus_users_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"tags_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "junction_directus_users_tags"
|
|
},
|
|
"ItemsJunctionDirectusUsersTags1": {
|
|
"type": "object",
|
|
"properties": {
|
|
"directus_users_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"tags_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTags"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "junction_directus_users_tags_1"
|
|
},
|
|
"ItemsTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"custom_text": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"icon_as_labels": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"offers_and_needs": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"onepager": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"questlog": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"relations": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_name": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_name_input": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_profile_button": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_start_end": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_start_end_input": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_text": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_text_input": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"template": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"text_area": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"profileTemplate": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypesProfileTemplate"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"x-collection": "types",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsLayersDirectusUsers1": {
|
|
"type": "object",
|
|
"properties": {
|
|
"directus_users_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"layers_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "layers_directus_users_1"
|
|
},
|
|
"ItemsLayersFiles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"directus_files_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"layers_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "layers_files"
|
|
},
|
|
"ItemsLayersMaps": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"layers_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsLayers"
|
|
}
|
|
]
|
|
},
|
|
"maps_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsMaps"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "layers_maps"
|
|
},
|
|
"ItemsThemes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"theme": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-collection": "Themes",
|
|
"required": [
|
|
"theme"
|
|
]
|
|
},
|
|
"ItemsStartEnd": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "startEnd",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsTeam": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"image": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Files"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"sort": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"nullable": false,
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "team",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsTexts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dataField": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"date_updated": {
|
|
"nullable": true,
|
|
"type": "string",
|
|
"format": "timestamp"
|
|
},
|
|
"heading": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"hideWhenEmpty": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"showMarkdownHint": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"size": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"user_created": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
},
|
|
"user_updated": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Users"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "texts",
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"ItemsTypesProfileTemplate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collection": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"nullable": false,
|
|
"type": "integer"
|
|
},
|
|
"item": {
|
|
"nullable": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsRelations"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsContactInfos"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsCrowdfundings"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGallery"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsGroupSubheaders"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsInviteLinks"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsStartEnd"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTexts"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"sort": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"types_id": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ItemsTypes"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-collection": "types_profileTemplate"
|
|
}
|
|
},
|
|
"parameters": {
|
|
"Id": {
|
|
"description": "Index",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"UUId": {
|
|
"description": "Unique identifier for the object.",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"example": "8cbb43fe-4cdf-4991-8352-c461779cec02",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Collection": {
|
|
"description": "Collection of which you want to retrieve the items from.",
|
|
"name": "collection",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Search": {
|
|
"description": "Filter by items that contain the given search query in one of their fields.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Page": {
|
|
"description": "Cursor for use in pagination. Often used in combination with limit.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"Offset": {
|
|
"description": "How many items to skip when fetching data.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"Sort": {
|
|
"description": "How to sort the returned items. `sort` is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (` - `) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ` ? ` to sort randomly.\n",
|
|
"in": "query",
|
|
"name": "sort",
|
|
"required": false,
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Meta": {
|
|
"description": "What metadata to return in the response.",
|
|
"in": "query",
|
|
"name": "meta",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Limit": {
|
|
"description": "A limit on the number of objects that are returned.",
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"Filter": {
|
|
"description": "Select items in collection by given conditions.",
|
|
"in": "query",
|
|
"name": "filter",
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"example": {
|
|
"<field>": {
|
|
"<operator>": "<value>"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Fields": {
|
|
"description": "Control what fields are being returned in the object.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Export": {
|
|
"name": "export",
|
|
"description": "Saves the API response to a file. Accepts one of \"csv\", \"json\", \"xml\", \"yaml\".",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"csv",
|
|
"json",
|
|
"xml",
|
|
"yaml"
|
|
]
|
|
}
|
|
},
|
|
"Version": {
|
|
"name": "version",
|
|
"description": "Retrieve an item's state from a specific Content Version. The value corresponds to the \"key\" of the Content Version.\n",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"NotFoundError": {
|
|
"description": "Error: Not found.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"UnauthorizedError": {
|
|
"description": "Error: Unauthorized request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"KeyAuth": {
|
|
"type": "apiKey",
|
|
"in": "query",
|
|
"name": "access_token"
|
|
},
|
|
"Auth": {
|
|
"type": "apiKey",
|
|
"in": "header",
|
|
"name": "Authorization"
|
|
}
|
|
}
|
|
}
|
|
}
|