mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
@@ -7,6 +7,10 @@ const dirTree = require('directory-tree');
|
||||
const yaml = require('js-yaml');
|
||||
|
||||
async function build() {
|
||||
console.log('Building docs...');
|
||||
|
||||
const start = Date.now();
|
||||
|
||||
const distPath = path.resolve(__dirname, './dist');
|
||||
|
||||
await rimraf(distPath);
|
||||
@@ -35,6 +39,8 @@ async function build() {
|
||||
yaml.safeLoad(yamlString)
|
||||
);
|
||||
}
|
||||
|
||||
console.log(`Built docs in ${Date.now() - start} ms`);
|
||||
}
|
||||
|
||||
build();
|
||||
|
||||
1079
docs/package-lock.json
generated
1079
docs/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -6,7 +6,17 @@
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"build": "node build.js",
|
||||
"prepublish": "npm run build"
|
||||
"prepublish": "npm run build",
|
||||
"dev": "npm-watch build"
|
||||
},
|
||||
"watch": {
|
||||
"build": {
|
||||
"patterns": ["."],
|
||||
"ignore": "dist",
|
||||
"extensions": "md,yaml",
|
||||
"silent": true,
|
||||
"quiet": true
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
@@ -14,5 +24,8 @@
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"gitHead": "4476da28dbbc2824e680137aa28b2b91b5afabec"
|
||||
"gitHead": "4476da28dbbc2824e680137aa28b2b91b5afabec",
|
||||
"devDependencies": {
|
||||
"npm-watch": "^0.7.0"
|
||||
}
|
||||
}
|
||||
|
||||
1420
packages/spec/package-lock.json
generated
1420
packages/spec/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,14 +1,23 @@
|
||||
{
|
||||
"name": "@directus/specs",
|
||||
"version": "9.0.0-beta.10",
|
||||
"description": "Specification of the Directus Api",
|
||||
"description": "OpenAPI Specification of the Directus API",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"ui:watch": "swagger-ui-watcher specs/openapi.yaml",
|
||||
"validate": "swagger-cli validate specs/openapi.yaml",
|
||||
"build": "swagger-cli bundle specs/openapi.yaml -o dist/openapi.json",
|
||||
"build:deref": "swagger-cli bundle specs/openapi.yaml -o dist/openapi-deref.json --dereference",
|
||||
"prepublishOnly": "npm run build && npm run build:deref"
|
||||
"prepublishOnly": "npm run build && npm run build:deref",
|
||||
"dev": "npm-watch build"
|
||||
},
|
||||
"watch": {
|
||||
"build": {
|
||||
"patterns": ["specs"],
|
||||
"extensions": "yaml",
|
||||
"quiet": true,
|
||||
"silent": true
|
||||
}
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -26,5 +35,9 @@
|
||||
"README.md",
|
||||
"index.js"
|
||||
],
|
||||
"gitHead": "4476da28dbbc2824e680137aa28b2b91b5afabec"
|
||||
"gitHead": "4476da28dbbc2824e680137aa28b2b91b5afabec",
|
||||
"devDependencies": {
|
||||
"npm-watch": "^0.7.0",
|
||||
"swagger-cli": "^4.0.4"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -54,156 +54,156 @@ paths:
|
||||
# Activity
|
||||
/activity:
|
||||
$ref: "./paths/activity/activities.yaml"
|
||||
/activity/comment:
|
||||
$ref: "./paths/activity/activity-comments.yaml"
|
||||
/activity/{id}:
|
||||
$ref: "./paths/activity/activity.yaml"
|
||||
/activity/comment/{id}:
|
||||
$ref: "./paths/activity/activity-comment.yaml"
|
||||
# /activity/comment:
|
||||
# $ref: "./paths/activity/activity-comments.yaml"
|
||||
# /activity/{id}:
|
||||
# $ref: "./paths/activity/activity.yaml"
|
||||
# /activity/comment/{id}:
|
||||
# $ref: "./paths/activity/activity-comment.yaml"
|
||||
|
||||
# Assets
|
||||
/assets/{id}:
|
||||
$ref: "./paths/assets/assets.yaml"
|
||||
# # Assets
|
||||
# /assets/{id}:
|
||||
# $ref: "./paths/assets/assets.yaml"
|
||||
|
||||
# Authentication
|
||||
/auth/login:
|
||||
$ref: "./paths/auth/login.yaml"
|
||||
/auth/refresh:
|
||||
$ref: "./paths/auth/refresh.yaml"
|
||||
/auth/logout:
|
||||
$ref: "./paths/auth/logout.yaml"
|
||||
/auth/password/request:
|
||||
$ref: "./paths/auth/password-request.yaml"
|
||||
/auth/password/reset:
|
||||
$ref: "./paths/auth/password-reset.yaml"
|
||||
/auth/sso:
|
||||
$ref: "./paths/auth/sso.yaml"
|
||||
/auth/sso/{provider}:
|
||||
$ref: "./paths/auth/sso-provider.yaml"
|
||||
# # Authentication
|
||||
# /auth/login:
|
||||
# $ref: "./paths/auth/login.yaml"
|
||||
# /auth/refresh:
|
||||
# $ref: "./paths/auth/refresh.yaml"
|
||||
# /auth/logout:
|
||||
# $ref: "./paths/auth/logout.yaml"
|
||||
# /auth/password/request:
|
||||
# $ref: "./paths/auth/password-request.yaml"
|
||||
# /auth/password/reset:
|
||||
# $ref: "./paths/auth/password-reset.yaml"
|
||||
# /auth/sso:
|
||||
# $ref: "./paths/auth/sso.yaml"
|
||||
# /auth/sso/{provider}:
|
||||
# $ref: "./paths/auth/sso-provider.yaml"
|
||||
|
||||
# Items
|
||||
/items/{collection}:
|
||||
$ref: "./paths/items/items.yaml"
|
||||
/items/{collection}/{id}:
|
||||
$ref: "./paths/items/item.yaml"
|
||||
# # Items
|
||||
# /items/{collection}:
|
||||
# $ref: "./paths/items/items.yaml"
|
||||
# /items/{collection}/{id}:
|
||||
# $ref: "./paths/items/item.yaml"
|
||||
|
||||
# Presets
|
||||
/presets:
|
||||
$ref: "./paths/presets/presets.yaml"
|
||||
/presets/{id}:
|
||||
$ref: "./paths/presets/preset.yaml"
|
||||
# # Presets
|
||||
# /presets:
|
||||
# $ref: "./paths/presets/presets.yaml"
|
||||
# /presets/{id}:
|
||||
# $ref: "./paths/presets/preset.yaml"
|
||||
|
||||
# Collections
|
||||
/collections:
|
||||
$ref: "./paths/collections/collections.yaml"
|
||||
/collections/{id}:
|
||||
$ref: "./paths/collections/collection.yaml"
|
||||
# # Collections
|
||||
# /collections:
|
||||
# $ref: "./paths/collections/collections.yaml"
|
||||
# /collections/{id}:
|
||||
# $ref: "./paths/collections/collection.yaml"
|
||||
|
||||
# Extensions
|
||||
/extensions/interfaces:
|
||||
$ref: "./paths/extensions/interfaces.yaml"
|
||||
/extensions/layouts:
|
||||
$ref: "./paths/extensions/layouts.yaml"
|
||||
/extensions/displays:
|
||||
$ref: "./paths/extensions/displays.yaml"
|
||||
/extensions/modules:
|
||||
$ref: "./paths/extensions/modules.yaml"
|
||||
# # Extensions
|
||||
# /extensions/interfaces:
|
||||
# $ref: "./paths/extensions/interfaces.yaml"
|
||||
# /extensions/layouts:
|
||||
# $ref: "./paths/extensions/layouts.yaml"
|
||||
# /extensions/displays:
|
||||
# $ref: "./paths/extensions/displays.yaml"
|
||||
# /extensions/modules:
|
||||
# $ref: "./paths/extensions/modules.yaml"
|
||||
|
||||
# Fields
|
||||
/fields:
|
||||
$ref: "./paths/fields/fields.yaml"
|
||||
/fields/{collection}:
|
||||
$ref: "./paths/fields/collection-fields.yaml"
|
||||
/fields/{collection}/{id}:
|
||||
$ref: "./paths/fields/collection-field.yaml"
|
||||
# # Fields
|
||||
# /fields:
|
||||
# $ref: "./paths/fields/fields.yaml"
|
||||
# /fields/{collection}:
|
||||
# $ref: "./paths/fields/collection-fields.yaml"
|
||||
# /fields/{collection}/{id}:
|
||||
# $ref: "./paths/fields/collection-field.yaml"
|
||||
|
||||
# Files
|
||||
/files:
|
||||
$ref: "./paths/files/files.yaml"
|
||||
/files/{id}:
|
||||
$ref: "./paths/files/file.yaml"
|
||||
/files/{id}/revisions:
|
||||
$ref: "./paths/files/revisions.yaml"
|
||||
/files/{id}/revisions/{offset}:
|
||||
$ref: "./paths/files/revision.yaml"
|
||||
# # Files
|
||||
# /files:
|
||||
# $ref: "./paths/files/files.yaml"
|
||||
# /files/{id}:
|
||||
# $ref: "./paths/files/file.yaml"
|
||||
# /files/{id}/revisions:
|
||||
# $ref: "./paths/files/revisions.yaml"
|
||||
# /files/{id}/revisions/{offset}:
|
||||
# $ref: "./paths/files/revision.yaml"
|
||||
|
||||
# Folders
|
||||
/folders:
|
||||
$ref: "./paths/folders/folders.yaml"
|
||||
/folders/{id}:
|
||||
$ref: "./paths/folders/folder.yaml"
|
||||
# # Folders
|
||||
# /folders:
|
||||
# $ref: "./paths/folders/folders.yaml"
|
||||
# /folders/{id}:
|
||||
# $ref: "./paths/folders/folder.yaml"
|
||||
|
||||
# Permissions
|
||||
/permissions:
|
||||
$ref: "./paths/permissions/permissions.yaml"
|
||||
/permissions/me:
|
||||
$ref: "./paths/permissions/permissions-me.yaml"
|
||||
/permissions/{id}:
|
||||
$ref: "./paths/permissions/permission.yaml"
|
||||
# # Permissions
|
||||
# /permissions:
|
||||
# $ref: "./paths/permissions/permissions.yaml"
|
||||
# /permissions/me:
|
||||
# $ref: "./paths/permissions/permissions-me.yaml"
|
||||
# /permissions/{id}:
|
||||
# $ref: "./paths/permissions/permission.yaml"
|
||||
|
||||
# Relations
|
||||
/relations:
|
||||
$ref: "./paths/relations/relations.yaml"
|
||||
/relations/{id}:
|
||||
$ref: "./paths/relations/relation.yaml"
|
||||
# # Relations
|
||||
# /relations:
|
||||
# $ref: "./paths/relations/relations.yaml"
|
||||
# /relations/{id}:
|
||||
# $ref: "./paths/relations/relation.yaml"
|
||||
|
||||
# Revisions
|
||||
/revisions:
|
||||
$ref: "./paths/revisions/revisions.yaml"
|
||||
/revisions/{id}:
|
||||
$ref: "./paths/revisions/revision.yaml"
|
||||
# # Revisions
|
||||
# /revisions:
|
||||
# $ref: "./paths/revisions/revisions.yaml"
|
||||
# /revisions/{id}:
|
||||
# $ref: "./paths/revisions/revision.yaml"
|
||||
|
||||
# Roles
|
||||
/roles:
|
||||
$ref: "./paths/roles/roles.yaml"
|
||||
/roles/{id}:
|
||||
$ref: "./paths/roles/role.yaml"
|
||||
# # Roles
|
||||
# /roles:
|
||||
# $ref: "./paths/roles/roles.yaml"
|
||||
# /roles/{id}:
|
||||
# $ref: "./paths/roles/role.yaml"
|
||||
|
||||
# Server
|
||||
/server/info:
|
||||
$ref: "./paths/server/info.yaml"
|
||||
/server/ping:
|
||||
$ref: "./paths/server/ping.yaml"
|
||||
# # Server
|
||||
# /server/info:
|
||||
# $ref: "./paths/server/info.yaml"
|
||||
# /server/ping:
|
||||
# $ref: "./paths/server/ping.yaml"
|
||||
|
||||
# Settings
|
||||
/settings:
|
||||
$ref: "./paths/settings/settings.yaml"
|
||||
# # Settings
|
||||
# /settings:
|
||||
# $ref: "./paths/settings/settings.yaml"
|
||||
|
||||
# Users
|
||||
/users:
|
||||
$ref: "./paths/users/users.yaml"
|
||||
/users/{id}:
|
||||
$ref: "./paths/users/user.yaml"
|
||||
/users/{id}/track/page:
|
||||
$ref: "./paths/users/user-tracking.yaml"
|
||||
/users/invite:
|
||||
$ref: "./paths/users/user-invite.yaml"
|
||||
/users/invite/accept:
|
||||
$ref: "./paths/users/user-invite-accept.yaml"
|
||||
/users/me:
|
||||
$ref: "./paths/users/me.yaml"
|
||||
/users/me/track/page:
|
||||
$ref: "./paths/users/me-tracking.yaml"
|
||||
/users/me/tfa/enable:
|
||||
$ref: "./paths/users/me-tfa-enable.yaml"
|
||||
/users/me/tfa/disable:
|
||||
$ref: "./paths/users/me-tfa-disable.yaml"
|
||||
# # Users
|
||||
# /users:
|
||||
# $ref: "./paths/users/users.yaml"
|
||||
# /users/{id}:
|
||||
# $ref: "./paths/users/user.yaml"
|
||||
# /users/{id}/track/page:
|
||||
# $ref: "./paths/users/user-tracking.yaml"
|
||||
# /users/invite:
|
||||
# $ref: "./paths/users/user-invite.yaml"
|
||||
# /users/invite/accept:
|
||||
# $ref: "./paths/users/user-invite-accept.yaml"
|
||||
# /users/me:
|
||||
# $ref: "./paths/users/me.yaml"
|
||||
# /users/me/track/page:
|
||||
# $ref: "./paths/users/me-tracking.yaml"
|
||||
# /users/me/tfa/enable:
|
||||
# $ref: "./paths/users/me-tfa-enable.yaml"
|
||||
# /users/me/tfa/disable:
|
||||
# $ref: "./paths/users/me-tfa-disable.yaml"
|
||||
|
||||
# Utilities
|
||||
/utils/hash:
|
||||
$ref: "./paths/utils/hash.yaml"
|
||||
/utils/hash/verify:
|
||||
$ref: "./paths/utils/hash-match.yaml"
|
||||
/utils/random/string:
|
||||
$ref: "./paths/utils/random.yaml"
|
||||
/utils/sort/{collection}:
|
||||
$ref: "./paths/utils/sort.yaml"
|
||||
# # Utilities
|
||||
# /utils/hash:
|
||||
# $ref: "./paths/utils/hash.yaml"
|
||||
# /utils/hash/verify:
|
||||
# $ref: "./paths/utils/hash-match.yaml"
|
||||
# /utils/random/string:
|
||||
# $ref: "./paths/utils/random.yaml"
|
||||
# /utils/sort/{collection}:
|
||||
# $ref: "./paths/utils/sort.yaml"
|
||||
|
||||
# Webhooks
|
||||
/webhooks:
|
||||
$ref: "./paths/webhooks/webhooks.yaml"
|
||||
/webhooks/{id}:
|
||||
$ref: "./paths/webhooks/webhook.yaml"
|
||||
# # Webhooks
|
||||
# /webhooks:
|
||||
# $ref: "./paths/webhooks/webhooks.yaml"
|
||||
# /webhooks/{id}:
|
||||
# $ref: "./paths/webhooks/webhook.yaml"
|
||||
|
||||
components:
|
||||
schemas:
|
||||
|
||||
@@ -3,4 +3,4 @@ in: query
|
||||
name: page
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
type: integer
|
||||
|
||||
@@ -2,14 +2,14 @@ get:
|
||||
operationId: getActivities
|
||||
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/Single"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/Search"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Fields"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Limit"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Meta"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Offset"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Single"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Sort"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Filter"
|
||||
- $ref: "../../openapi.yaml#/components/parameters/Search"
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
@@ -20,11 +20,11 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Activity"
|
||||
$ref: "../../openapi.yaml#/components/schemas/Activity"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
|
||||
@@ -2,8 +2,8 @@ patch:
|
||||
description: Update the content of an existing comment.
|
||||
operationId: updateComment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -21,25 +21,25 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Activity"
|
||||
$ref: "../../#/components/schemas/Activity"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
delete:
|
||||
description: Delete an existing comment. Deleted comments can not be retrieved.
|
||||
operationId: deleteComment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
responses:
|
||||
"203":
|
||||
description: Deleted succsessfully
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
description: Creates a new comment.
|
||||
operationId: createComment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -27,11 +27,11 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Activity"
|
||||
$ref: "../../#/components/schemas/Activity"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
|
||||
@@ -4,9 +4,9 @@ get:
|
||||
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"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -16,10 +16,10 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Activity"
|
||||
$ref: "../../#/components/schemas/Activity"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
|
||||
@@ -48,4 +48,4 @@ get:
|
||||
schema:
|
||||
type: string
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
|
||||
@@ -16,4 +16,4 @@ post:
|
||||
description: Email address of the user you're requesting a reset for.
|
||||
responses:
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -21,4 +21,4 @@ post:
|
||||
description: New password for the user.
|
||||
responses:
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -35,4 +35,4 @@ post:
|
||||
type: string
|
||||
example: Gy-caJMpmGTA...
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -10,7 +10,7 @@ get:
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- $ref: "#/components/parameters/Mode"
|
||||
- $ref: "../../#/components/parameters/Mode"
|
||||
- name: redirect_url
|
||||
in: query
|
||||
required: true
|
||||
@@ -33,4 +33,4 @@ get:
|
||||
token:
|
||||
type: string
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -19,4 +19,4 @@ get:
|
||||
items:
|
||||
type: string
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: Retrieves the details of a single collection.
|
||||
operationId: getCollection
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
@@ -11,19 +11,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Collection"
|
||||
$ref: "../../#/components/schemas/Collection"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
patch:
|
||||
description: Update an existing collection.
|
||||
operationId: updateCollection
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -95,12 +95,12 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Collection"
|
||||
$ref: "../../#/components/schemas/Collection"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
delete:
|
||||
@@ -110,9 +110,9 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
parameters:
|
||||
|
||||
@@ -2,9 +2,9 @@ get:
|
||||
description: Returns a list of the collections available in the project.
|
||||
operationId: getCollections
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -16,18 +16,18 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Collection"
|
||||
$ref: "../../#/components/schemas/Collection"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
post:
|
||||
description: Create a new collection in Directus.
|
||||
operationId: createCollection
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -105,11 +105,11 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Collection"
|
||||
$ref: "../../#/components/schemas/Collection"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
|
||||
@@ -14,8 +14,8 @@ get:
|
||||
type: object
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
|
||||
@@ -14,8 +14,8 @@ get:
|
||||
items:
|
||||
type: object
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
|
||||
@@ -14,8 +14,8 @@ get:
|
||||
type: object
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
|
||||
@@ -14,8 +14,8 @@ get:
|
||||
type: object
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
|
||||
@@ -10,11 +10,11 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Field"
|
||||
$ref: "../../#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
patch:
|
||||
@@ -197,11 +197,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Field"
|
||||
$ref: "../../#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
delete:
|
||||
@@ -211,9 +211,9 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
parameters:
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: Returns a list of the fields available in the given collection.
|
||||
operationId: getCollectionFields
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "../../#/components/parameters/Sort"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -14,11 +14,11 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Field"
|
||||
$ref: "../../#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
post:
|
||||
@@ -201,12 +201,12 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Field"
|
||||
$ref: "../../#/components/schemas/Field"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
parameters:
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Returns a list of the fields available in the project.
|
||||
operationId: getFields
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Sort"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -15,10 +15,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Field"
|
||||
$ref: "../../#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
|
||||
@@ -12,9 +12,9 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/File"
|
||||
$ref: "../../#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
patch:
|
||||
description: Update an existing file.
|
||||
tags:
|
||||
@@ -34,9 +34,9 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/File"
|
||||
$ref: "../../#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
delete:
|
||||
description: Delete an existing file.
|
||||
tags:
|
||||
@@ -46,6 +46,6 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
|
||||
@@ -14,9 +14,9 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/File"
|
||||
$ref: "../../#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
post:
|
||||
description: Create a new file.
|
||||
tags:
|
||||
@@ -39,6 +39,6 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/File"
|
||||
$ref: "../../#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
- Files
|
||||
operationId: getFileRevision
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
- name: offset
|
||||
in: path
|
||||
description: offset or revision
|
||||
@@ -20,6 +20,6 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Revision"
|
||||
$ref: "../../#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
- Files
|
||||
operationId: getFileRevisions
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -16,6 +16,6 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Revision"
|
||||
$ref: "../../#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Retrieve a single folder by unique identifier.
|
||||
operationId: getFolder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -13,19 +13,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Folder"
|
||||
$ref: "../../#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
patch:
|
||||
description: Update an existing folder
|
||||
operationId: updateFolder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -48,11 +48,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Folder"
|
||||
$ref: "../../#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
|
||||
@@ -63,10 +63,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
|
||||
@@ -2,14 +2,14 @@ get:
|
||||
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/Single"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Sort"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $ref: "../../#/components/parameters/Filter"
|
||||
- $ref: "../../#/components/parameters/search"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -21,19 +21,19 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Folder"
|
||||
$ref: "../../#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
post:
|
||||
description: Create a new folder.
|
||||
operationId: createFolder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -57,10 +57,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Folder"
|
||||
$ref: "../../#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
|
||||
@@ -4,8 +4,8 @@ get:
|
||||
- Items
|
||||
operationId: getItem
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -17,17 +17,17 @@ get:
|
||||
data:
|
||||
type: object
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
patch:
|
||||
description: Update an existing item.
|
||||
tags:
|
||||
- Items
|
||||
operationId: updateItem
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -44,9 +44,9 @@ patch:
|
||||
data:
|
||||
type: object
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
delete:
|
||||
description: Delete an existing item.
|
||||
tags:
|
||||
@@ -56,11 +56,11 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Collection"
|
||||
- $ref: "../../#/components/parameters/Collection"
|
||||
- name: id
|
||||
description: Index of the item.
|
||||
in: path
|
||||
|
||||
@@ -6,14 +6,14 @@ get:
|
||||
security:
|
||||
- Auth: []
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $ref: "../../#/components/parameters/Sort"
|
||||
- $ref: "../../#/components/parameters/Filter"
|
||||
- $ref: "../../#/components/parameters/search"
|
||||
- name: status
|
||||
in: query
|
||||
description: Filter items by the given status
|
||||
@@ -35,14 +35,14 @@ get:
|
||||
items:
|
||||
type: object
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
post:
|
||||
description: Create a new item.
|
||||
tags:
|
||||
- Items
|
||||
operationId: createItem
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -56,6 +56,6 @@ post:
|
||||
schema:
|
||||
type: object
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Collection"
|
||||
- $ref: "../../#/components/parameters/Collection"
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Retrieve a single permissions object by unique identifier.
|
||||
operationId: getPermission
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -13,18 +13,18 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
$ref: "../../#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
patch:
|
||||
description: Update an existing permission
|
||||
operationId: updatePermission
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -83,11 +83,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
$ref: "../../#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
delete:
|
||||
@@ -97,10 +97,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
|
||||
@@ -12,10 +12,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
$ref: "../../#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
|
||||
@@ -2,15 +2,15 @@ get:
|
||||
description: List all permissions.
|
||||
operationId: getPermissions
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $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
|
||||
@@ -22,18 +22,18 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
$ref: "../../#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
post:
|
||||
description: Create a new permission.
|
||||
operationId: createPermission
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -100,10 +100,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
$ref: "../../#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
|
||||
@@ -6,8 +6,8 @@ get:
|
||||
security:
|
||||
- Auth: []
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -17,17 +17,17 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Preset"
|
||||
$ref: "../../#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
patch:
|
||||
tags:
|
||||
- Presets
|
||||
operationId: updatePreset
|
||||
description: Update an existing preset.
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -84,9 +84,9 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Preset"
|
||||
$ref: "../../#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
delete:
|
||||
tags:
|
||||
- Presets
|
||||
@@ -98,6 +98,6 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
|
||||
@@ -6,15 +6,15 @@ get:
|
||||
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/Single"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Page"
|
||||
- $ref: "../../#/components/parameters/Sort"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $ref: "../../#/components/parameters/Filter"
|
||||
- $ref: "../../#/components/parameters/search"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -26,17 +26,17 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Preset"
|
||||
$ref: "../../#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
post:
|
||||
tags:
|
||||
- Presets
|
||||
operationId: createPreset
|
||||
description: Create a new preset.
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -94,6 +94,6 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Preset"
|
||||
$ref: "../../#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Retrieve a single relation by unique identifier.
|
||||
operationId: getRelation
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -13,19 +13,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Relation"
|
||||
$ref: "../../#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
patch:
|
||||
description: Update an existing relation
|
||||
operationId: updateRelation
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -61,11 +61,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Relation"
|
||||
$ref: "../../#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
delete:
|
||||
@@ -75,10 +75,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
|
||||
@@ -2,15 +2,15 @@ get:
|
||||
description: List the relations.
|
||||
operationId: getRelations
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $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
|
||||
@@ -22,19 +22,19 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Relation"
|
||||
$ref: "../../#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
post:
|
||||
description: Create a new relation.
|
||||
operationId: createRelation
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -69,10 +69,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Relation"
|
||||
$ref: "../../#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
|
||||
@@ -2,9 +2,9 @@ get:
|
||||
description: Retrieve a single revision by unique identifier.
|
||||
operationId: getRevision
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -14,10 +14,10 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Revision"
|
||||
$ref: "../../#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Revisions
|
||||
|
||||
@@ -2,15 +2,15 @@ get:
|
||||
description: List the revisions.
|
||||
operationId: getRevisions
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $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
|
||||
@@ -22,10 +22,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Revision"
|
||||
$ref: "../../#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Revisions
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Retrieve a single role by unique identifier.
|
||||
operationId: getRole
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -13,19 +13,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Role"
|
||||
$ref: "../../#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
patch:
|
||||
description: Update an existing role
|
||||
operationId: updateRole
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -66,11 +66,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Role"
|
||||
$ref: "../../#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
delete:
|
||||
@@ -80,10 +80,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
|
||||
@@ -2,15 +2,15 @@ get:
|
||||
description: List the roles.
|
||||
operationId: getRoles
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $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
|
||||
@@ -22,19 +22,19 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Role"
|
||||
$ref: "../../#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
post:
|
||||
description: Create a new role.
|
||||
operationId: createRole
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -76,10 +76,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Role"
|
||||
$ref: "../../#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
|
||||
@@ -19,8 +19,8 @@ get:
|
||||
type: object
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Server
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: Retrieve a single setting by unique identifier.
|
||||
operationId: getSetting
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -12,18 +12,18 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Setting"
|
||||
$ref: "../../#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
patch:
|
||||
description: Update an existing setting
|
||||
operationId: updateSetting
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -45,11 +45,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Setting"
|
||||
$ref: "../../#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
delete:
|
||||
@@ -59,10 +59,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "../../#/components/parameters/Id"
|
||||
|
||||
@@ -2,11 +2,11 @@ get:
|
||||
description: List the settings.
|
||||
operationId: getSettings
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Page"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -16,11 +16,11 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Setting"
|
||||
$ref: "../../#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
patch:
|
||||
@@ -40,18 +40,18 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Setting"
|
||||
$ref: "../../#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
# post:
|
||||
# description: Create a new setting.
|
||||
# operationId: createSettings
|
||||
# parameters:
|
||||
# - $ref: '#/components/parameters/Meta'
|
||||
# - $ref: '../../#/components/parameters/Meta'
|
||||
# requestBody:
|
||||
# content:
|
||||
# application/json:
|
||||
@@ -66,10 +66,10 @@ patch:
|
||||
# type: object
|
||||
# properties:
|
||||
# data:
|
||||
# $ref: '#/components/schemas/Setting'
|
||||
# $ref: '../../#/components/schemas/Setting'
|
||||
# '401':
|
||||
# $ref: '#/components/responses/UnauthorizedError'
|
||||
# $ref: '../../#/components/responses/UnauthorizedError'
|
||||
# '404':
|
||||
# $ref: '#/components/responses/NotFoundError'
|
||||
# $ref: '../../#/components/responses/NotFoundError'
|
||||
# tags:
|
||||
# - Settings
|
||||
|
||||
@@ -5,8 +5,8 @@ post:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -5,8 +5,8 @@ post:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -16,8 +16,8 @@ patch:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Retrieve the currently authenticated user.
|
||||
operationId: me
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -13,11 +13,11 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
patch:
|
||||
@@ -32,10 +32,10 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -17,10 +17,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -22,10 +22,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -4,7 +4,7 @@ patch:
|
||||
to be able to open the Directus admin app from the last page you used.
|
||||
operationId: updateLastUsedPage
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -18,8 +18,8 @@ patch:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -2,8 +2,8 @@ get:
|
||||
description: Retrieve a single user by unique identifier.
|
||||
operationId: getUser
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -13,24 +13,24 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
patch:
|
||||
description: Update an existing user
|
||||
operationId: updateUser
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
@@ -42,9 +42,9 @@ patch:
|
||||
type: object
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
delete:
|
||||
@@ -54,10 +54,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
|
||||
@@ -2,14 +2,14 @@ get:
|
||||
description: List the users.
|
||||
operationId: getUsers
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
- $ref: "#/components/parameters/Filter"
|
||||
- $ref: "#/components/parameters/search"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Limit"
|
||||
- $ref: "../../#/components/parameters/Offset"
|
||||
- $ref: "../../#/components/parameters/Single"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Sort"
|
||||
- $ref: "../../#/components/parameters/Filter"
|
||||
- $ref: "../../#/components/parameters/search"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -21,23 +21,23 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
post:
|
||||
description: Create a new user.
|
||||
operationId: createUser
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful request
|
||||
@@ -47,10 +47,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/User"
|
||||
$ref: "../../#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
|
||||
@@ -10,19 +10,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Webhook"
|
||||
$ref: "../../#/components/schemas/Webhook"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Webhooks
|
||||
patch:
|
||||
description: Update an existing webhook
|
||||
operationId: updateWebhook
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -64,11 +64,11 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Role"
|
||||
$ref: "../../#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Webhooks
|
||||
delete:
|
||||
@@ -78,10 +78,10 @@ delete:
|
||||
"200":
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Webhooks
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- $ref: "../../#/components/parameters/UUId"
|
||||
|
||||
@@ -10,19 +10,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Webhook"
|
||||
$ref: "../../#/components/schemas/Webhook"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Webhooks
|
||||
post:
|
||||
description: Create a new webhook.
|
||||
operationId: createWebhook
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
- $ref: "../../#/components/parameters/Fields"
|
||||
- $ref: "../../#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -64,10 +64,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: "#/components/schemas/Role"
|
||||
$ref: "../../#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
$ref: "../../#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
$ref: "../../#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Webhooks
|
||||
|
||||
Reference in New Issue
Block a user