mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
fixes and changes
This commit is contained in:
@@ -8,15 +8,25 @@ properties:
|
||||
description: Action that was performed.
|
||||
example: update
|
||||
type: string
|
||||
enum: [authenticate, comment, upload, create, update, delete, soft-delete, revert, invalid-credentials]
|
||||
enum:
|
||||
[
|
||||
authenticate,
|
||||
comment,
|
||||
upload,
|
||||
create,
|
||||
update,
|
||||
delete,
|
||||
soft-delete,
|
||||
revert,
|
||||
invalid-credentials,
|
||||
]
|
||||
action_by:
|
||||
description: Unique identifier of the user account who caused this action.
|
||||
example: 63716273-0f29-4648-8a2a-2af2948f6f78
|
||||
type: string
|
||||
$ref: "./user.yaml"
|
||||
description: The user who caused this action.
|
||||
nullable: true # States the SQL structure
|
||||
action_on:
|
||||
description: When the action happened.
|
||||
example: '2019-12-05 22:52:09'
|
||||
example: "2019-12-05 22:52:09"
|
||||
type: string
|
||||
format: date-time
|
||||
ip:
|
||||
@@ -37,11 +47,12 @@ properties:
|
||||
type: string
|
||||
item:
|
||||
description: Unique identifier for the item the action applied to. This is always a string, even for integer primary keys.
|
||||
example: '328'
|
||||
example: "328"
|
||||
type: string
|
||||
comment:
|
||||
description: User comment. This will store the comments that show up in the right
|
||||
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: null
|
||||
type: string
|
||||
nullable: true
|
||||
nullable: true
|
||||
|
||||
@@ -1,5 +1,31 @@
|
||||
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: First 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.
|
||||
example: "*********"
|
||||
type: string
|
||||
location:
|
||||
description: Location of the user.
|
||||
example: null
|
||||
type: string
|
||||
nullable: true
|
||||
tfa_secret:
|
||||
description: The 2FA secret string that's used to generate one time passwords.
|
||||
example: null
|
||||
@@ -12,36 +38,19 @@ properties:
|
||||
- type: integer
|
||||
nullable: true
|
||||
- type: string
|
||||
- $ref: '../openapi.yaml#/components/schemas/File'
|
||||
- $ref: "../openapi.yaml#/components/schemas/File"
|
||||
nullable: true
|
||||
email:
|
||||
description: Unique email address for the user.
|
||||
example: admin@example.com
|
||||
type: string
|
||||
format: email
|
||||
external_id:
|
||||
description: ID used for SCIM.
|
||||
example: null
|
||||
type: string
|
||||
nullable: true
|
||||
first_name:
|
||||
description: First name of the user.
|
||||
example: Admin
|
||||
type: string
|
||||
id:
|
||||
description: Unique identifier for the user.
|
||||
example: 63716273-0f29-4648-8a2a-2af2948f6f78
|
||||
type: string
|
||||
last_login:
|
||||
description: When this user logged in last.
|
||||
example: '2020-05-31 14:32:37'
|
||||
example: "2020-05-31 14:32:37"
|
||||
type: string
|
||||
nullable: true
|
||||
format: date-time
|
||||
last_name:
|
||||
description: First name of the user.
|
||||
example: User
|
||||
type: string
|
||||
last_page:
|
||||
description: Last page that the user was on.
|
||||
example: /my-project/settings/collections/a
|
||||
@@ -73,4 +82,4 @@ properties:
|
||||
description: The user's title.
|
||||
example: null
|
||||
type: string
|
||||
nullable: true
|
||||
nullable: true
|
||||
|
||||
@@ -6,14 +6,14 @@ info:
|
||||
email: contact@directus.io
|
||||
license:
|
||||
name: GPL-3.0
|
||||
url: 'https://www.gnu.org/licenses/gpl-3.0.de.html'
|
||||
url: "https://www.gnu.org/licenses/gpl-3.0.de.html"
|
||||
version: 1.0.0
|
||||
externalDocs:
|
||||
description: Directus Docs
|
||||
url: 'https://docs.directus.io'
|
||||
url: "https://docs.directus.io"
|
||||
servers:
|
||||
- url: 'https://demo.directus.io/'
|
||||
- url: '/'
|
||||
- url: "https://demo.directus.io/"
|
||||
- url: "/"
|
||||
tags:
|
||||
- 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.
|
||||
@@ -60,233 +60,232 @@ tags:
|
||||
- name: Webhooks
|
||||
description: Webhooks.
|
||||
paths:
|
||||
|
||||
# Activity
|
||||
/activity:
|
||||
$ref: './paths/activity/activitys.yaml'
|
||||
$ref: "./paths/activity/activities.yaml"
|
||||
/activity/comment:
|
||||
$ref: './paths/activity/activity-comments.yaml'
|
||||
$ref: "./paths/activity/activity-comments.yaml"
|
||||
/activity/{id}:
|
||||
$ref: './paths/activity/activity.yaml'
|
||||
$ref: "./paths/activity/activity.yaml"
|
||||
/activity/comment/{id}:
|
||||
$ref: './paths/activity/activity-comment.yaml'
|
||||
$ref: "./paths/activity/activity-comment.yaml"
|
||||
|
||||
# Assets
|
||||
/assets/{key}:
|
||||
$ref: './paths/assets/assets.yaml'
|
||||
$ref: "./paths/assets/assets.yaml"
|
||||
|
||||
# Authentication
|
||||
/auth/login:
|
||||
$ref: './paths/auth/login.yaml'
|
||||
$ref: "./paths/auth/login.yaml"
|
||||
/auth/refresh:
|
||||
$ref: './paths/auth/refresh.yaml'
|
||||
$ref: "./paths/auth/refresh.yaml"
|
||||
/auth/logout:
|
||||
$ref: './paths/auth/logout.yaml'
|
||||
$ref: "./paths/auth/logout.yaml"
|
||||
/auth/password/request:
|
||||
$ref: './paths/auth/password-request.yaml'
|
||||
$ref: "./paths/auth/password-request.yaml"
|
||||
/auth/password/reset:
|
||||
$ref: './paths/auth/password-reset.yaml'
|
||||
$ref: "./paths/auth/password-reset.yaml"
|
||||
/auth/sso:
|
||||
$ref: './paths/auth/sso.yaml'
|
||||
$ref: "./paths/auth/sso.yaml"
|
||||
/auth/sso/{provider}:
|
||||
$ref: './paths/auth/sso-provider.yaml'
|
||||
$ref: "./paths/auth/sso-provider.yaml"
|
||||
|
||||
# Items
|
||||
/items/{collection}:
|
||||
$ref: './paths/items/items.yaml'
|
||||
$ref: "./paths/items/items.yaml"
|
||||
/items/{collection}/{id}:
|
||||
$ref: './paths/items/item.yaml'
|
||||
$ref: "./paths/items/item.yaml"
|
||||
|
||||
# Presets
|
||||
/presets:
|
||||
$ref: './paths/presets/presets.yaml'
|
||||
$ref: "./paths/presets/presets.yaml"
|
||||
/presets/{id}:
|
||||
$ref: './paths/presets/preset.yaml'
|
||||
$ref: "./paths/presets/preset.yaml"
|
||||
|
||||
# Collections
|
||||
/collections:
|
||||
$ref: './paths/collections/collections.yaml'
|
||||
$ref: "./paths/collections/collections.yaml"
|
||||
/collections/{collection}:
|
||||
$ref: './paths/collections/collection.yaml'
|
||||
|
||||
$ref: "./paths/collections/collection.yaml"
|
||||
|
||||
# Extensions
|
||||
/interfaces:
|
||||
$ref: './paths/extensions/interfaces.yaml'
|
||||
$ref: "./paths/extensions/interfaces.yaml"
|
||||
/layouts:
|
||||
$ref: './paths/extensions/layouts.yaml'
|
||||
$ref: "./paths/extensions/layouts.yaml"
|
||||
/modules:
|
||||
$ref: './paths/extensions/modules.yaml'
|
||||
$ref: "./paths/extensions/modules.yaml"
|
||||
|
||||
# Fields
|
||||
/fields:
|
||||
$ref: './paths/fields/fields.yaml'
|
||||
$ref: "./paths/fields/fields.yaml"
|
||||
/fields/{collection}:
|
||||
$ref: './paths/fields/collection-fields.yaml'
|
||||
$ref: "./paths/fields/collection-fields.yaml"
|
||||
/fields/{collection}/{field}:
|
||||
$ref: './paths/fields/collection-field.yaml'
|
||||
$ref: "./paths/fields/collection-field.yaml"
|
||||
|
||||
# Files
|
||||
/files:
|
||||
$ref: './paths/files/files.yaml'
|
||||
$ref: "./paths/files/files.yaml"
|
||||
/files/{id}:
|
||||
$ref: './paths/files/file.yaml'
|
||||
$ref: "./paths/files/file.yaml"
|
||||
/files/{id}/revisions:
|
||||
$ref: './paths/files/revisions.yaml'
|
||||
$ref: "./paths/files/revisions.yaml"
|
||||
/files/{id}/revisions/{offset}:
|
||||
$ref: './paths/files/revision.yaml'
|
||||
$ref: "./paths/files/revision.yaml"
|
||||
|
||||
# Folders
|
||||
/folders:
|
||||
$ref: './paths/folders/folders.yaml'
|
||||
$ref: "./paths/folders/folders.yaml"
|
||||
/folders/{id}:
|
||||
$ref: './paths/folders/folder.yaml'
|
||||
$ref: "./paths/folders/folder.yaml"
|
||||
|
||||
# Mail
|
||||
/mail:
|
||||
$ref: './paths/mail/mail.yaml'
|
||||
$ref: "./paths/mail/mail.yaml"
|
||||
|
||||
# Permissions
|
||||
/permissions:
|
||||
$ref: './paths/permissions/permissions.yaml'
|
||||
$ref: "./paths/permissions/permissions.yaml"
|
||||
/permissions/me:
|
||||
$ref: './paths/permissions/permissions-me.yaml'
|
||||
$ref: "./paths/permissions/permissions-me.yaml"
|
||||
/permissions/{id}:
|
||||
$ref: './paths/permissions/permission.yaml'
|
||||
$ref: "./paths/permissions/permission.yaml"
|
||||
/permissions/me/{collection}:
|
||||
$ref: './paths/permissions/permissions-me-collection.yaml'
|
||||
$ref: "./paths/permissions/permissions-me-collection.yaml"
|
||||
|
||||
# Relations
|
||||
/relations:
|
||||
$ref: './paths/relations/relations.yaml'
|
||||
$ref: "./paths/relations/relations.yaml"
|
||||
/relations/{id}:
|
||||
$ref: './paths/relations/relation.yaml'
|
||||
$ref: "./paths/relations/relation.yaml"
|
||||
|
||||
# Revisions
|
||||
/revisions:
|
||||
$ref: './paths/revisions/revisions.yaml'
|
||||
$ref: "./paths/revisions/revisions.yaml"
|
||||
/revisions/{id}:
|
||||
$ref: './paths/revisions/revision.yaml'
|
||||
$ref: "./paths/revisions/revision.yaml"
|
||||
|
||||
# Revisions
|
||||
/roles:
|
||||
$ref: './paths/roles/roles.yaml'
|
||||
$ref: "./paths/roles/roles.yaml"
|
||||
/roles/{id}:
|
||||
$ref: './paths/roles/role.yaml'
|
||||
$ref: "./paths/roles/role.yaml"
|
||||
|
||||
# SCIM
|
||||
/scim/v2/Users:
|
||||
$ref: './paths/scim/users.yaml'
|
||||
$ref: "./paths/scim/users.yaml"
|
||||
/scim/v2/Users/{id}:
|
||||
$ref: './paths/scim/user.yaml'
|
||||
$ref: "./paths/scim/user.yaml"
|
||||
/scim/v2/Groups:
|
||||
$ref: './paths/scim/groups.yaml'
|
||||
$ref: "./paths/scim/groups.yaml"
|
||||
/scim/v2/Groups/{id}:
|
||||
$ref: './paths/scim/group.yaml'
|
||||
|
||||
$ref: "./paths/scim/group.yaml"
|
||||
|
||||
# Server
|
||||
/server/info:
|
||||
$ref: './paths/server/info.yaml'
|
||||
$ref: "./paths/server/info.yaml"
|
||||
servers:
|
||||
- url: 'https://demo.directus.io/'
|
||||
- url: "https://demo.directus.io/"
|
||||
/server/ping:
|
||||
$ref: './paths/server/ping.yaml'
|
||||
$ref: "./paths/server/ping.yaml"
|
||||
servers:
|
||||
- url: 'https://demo.directus.io/'
|
||||
- url: "https://demo.directus.io/"
|
||||
|
||||
# Settings
|
||||
/settings:
|
||||
$ref: './paths/settings/settings.yaml'
|
||||
$ref: "./paths/settings/settings.yaml"
|
||||
|
||||
# Users
|
||||
/users:
|
||||
$ref: './paths/users/users.yaml'
|
||||
$ref: "./paths/users/users.yaml"
|
||||
/users/me:
|
||||
$ref: './paths/users/me.yaml'
|
||||
$ref: "./paths/users/me.yaml"
|
||||
/users/invite:
|
||||
$ref: './paths/users/user-invite.yaml'
|
||||
$ref: "./paths/users/user-invite.yaml"
|
||||
/users/{id}:
|
||||
$ref: './paths/users/user.yaml'
|
||||
$ref: "./paths/users/user.yaml"
|
||||
/users/invite/{token}:
|
||||
$ref: './paths/users/user-invite-token.yaml'
|
||||
$ref: "./paths/users/user-invite-token.yaml"
|
||||
/users/{id}/track/page:
|
||||
$ref: './paths/users/user-tracking.yaml'
|
||||
$ref: "./paths/users/user-tracking.yaml"
|
||||
|
||||
# Utilities
|
||||
/utils/hash:
|
||||
$ref: './paths/utils/hash.yaml'
|
||||
$ref: "./paths/utils/hash.yaml"
|
||||
/utils/hash/verify:
|
||||
$ref: './paths/utils/hash-match.yaml'
|
||||
$ref: "./paths/utils/hash-match.yaml"
|
||||
/utils/random/string:
|
||||
$ref: './paths/utils/random.yaml'
|
||||
$ref: "./paths/utils/random.yaml"
|
||||
|
||||
# Webhooks
|
||||
/webhooks:
|
||||
$ref: './paths/webhooks/webhooks.yaml'
|
||||
$ref: "./paths/webhooks/webhooks.yaml"
|
||||
|
||||
components:
|
||||
schemas:
|
||||
Activity:
|
||||
$ref: './components/activity.yaml'
|
||||
$ref: "./components/activity.yaml"
|
||||
Preset:
|
||||
$ref: './components/preset.yaml'
|
||||
$ref: "./components/preset.yaml"
|
||||
Collection:
|
||||
$ref: './components/collection.yaml'
|
||||
$ref: "./components/collection.yaml"
|
||||
Field:
|
||||
$ref: './components/field.yaml'
|
||||
$ref: "./components/field.yaml"
|
||||
File:
|
||||
$ref: './components/file.yaml'
|
||||
$ref: "./components/file.yaml"
|
||||
Folder:
|
||||
$ref: './components/folder.yaml'
|
||||
$ref: "./components/folder.yaml"
|
||||
Item:
|
||||
$ref: './components/item.yaml'
|
||||
$ref: "./components/item.yaml"
|
||||
Permissions:
|
||||
$ref: './components/permissions.yaml'
|
||||
$ref: "./components/permissions.yaml"
|
||||
Relation:
|
||||
$ref: './components/relation.yaml'
|
||||
$ref: "./components/relation.yaml"
|
||||
Revision:
|
||||
$ref: './components/revision.yaml'
|
||||
$ref: "./components/revision.yaml"
|
||||
Role:
|
||||
$ref: './components/role.yaml'
|
||||
$ref: "./components/role.yaml"
|
||||
Setting:
|
||||
$ref: './components/setting.yaml'
|
||||
$ref: "./components/setting.yaml"
|
||||
User:
|
||||
$ref: './components/user.yaml'
|
||||
$ref: "./components/user.yaml"
|
||||
Webhook:
|
||||
$ref: './components/webhook.yaml'
|
||||
$ref: "./components/webhook.yaml"
|
||||
parameters:
|
||||
# All path parameters
|
||||
# All path parameters
|
||||
Id:
|
||||
$ref: './parameters/id.yaml'
|
||||
$ref: "./parameters/id.yaml"
|
||||
UUId:
|
||||
$ref: './parameters/uuid.yaml'
|
||||
$ref: "./parameters/uuid.yaml"
|
||||
Collection:
|
||||
$ref: './parameters/collection.yaml'
|
||||
$ref: "./parameters/collection.yaml"
|
||||
# All query parameters
|
||||
q:
|
||||
$ref: './parameters/q.yaml'
|
||||
$ref: "./parameters/q.yaml"
|
||||
Page:
|
||||
$ref: './parameters/page.yaml'
|
||||
$ref: "./parameters/page.yaml"
|
||||
Offset:
|
||||
$ref: './parameters/offset.yaml'
|
||||
$ref: "./parameters/offset.yaml"
|
||||
Single:
|
||||
$ref: './parameters/single.yaml'
|
||||
$ref: "./parameters/single.yaml"
|
||||
Sort:
|
||||
$ref: './parameters/sort.yaml'
|
||||
$ref: "./parameters/sort.yaml"
|
||||
Meta:
|
||||
$ref: './parameters/meta.yaml'
|
||||
$ref: "./parameters/meta.yaml"
|
||||
Limit:
|
||||
$ref: './parameters/limit.yaml'
|
||||
$ref: "./parameters/limit.yaml"
|
||||
Filter:
|
||||
$ref: './parameters/filter.yaml'
|
||||
$ref: "./parameters/filter.yaml"
|
||||
Fields:
|
||||
$ref: './parameters/fields.yaml'
|
||||
$ref: "./parameters/fields.yaml"
|
||||
Mode:
|
||||
$ref: './parameters/mode.yaml'
|
||||
$ref: "./parameters/mode.yaml"
|
||||
responses:
|
||||
NotFoundError:
|
||||
$ref: './responses/notFoundError.yaml'
|
||||
$ref: "./responses/notFoundError.yaml"
|
||||
UnauthorizedError:
|
||||
$ref: './responses/unauthorizedError.yaml'
|
||||
$ref: "./responses/unauthorizedError.yaml"
|
||||
securitySchemes:
|
||||
KeyAuth:
|
||||
type: apiKey
|
||||
@@ -296,8 +295,8 @@ components:
|
||||
Auth:
|
||||
type: apiKey
|
||||
in: header
|
||||
name: 'Authorization'
|
||||
name: "Authorization"
|
||||
description: To authenticate, use the "/auth/authenticate" endpoint with the credentials "admin@example.com" | "password". Use the api key here like so "Bearer \<key\>".
|
||||
security:
|
||||
security:
|
||||
- Auth: []
|
||||
- KeyAuth: []
|
||||
|
||||
30
packages/spec/specs/paths/activity/activities.yaml
Normal file
30
packages/spec/specs/paths/activity/activities.yaml
Normal file
@@ -0,0 +1,30 @@
|
||||
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/q"
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Activity"
|
||||
description: Successful request
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
@@ -2,7 +2,8 @@ patch:
|
||||
description: Update the content of an existing comment.
|
||||
operationId: updateComment
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,32 +14,32 @@ patch:
|
||||
type: string
|
||||
example: My updated comment
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Activity'
|
||||
$ref: "#/components/schemas/Activity"
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
- Activity
|
||||
delete:
|
||||
description: Delete an existing comment. Deleted comments can not be retrieved.
|
||||
operationId: deleteComment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Id"
|
||||
responses:
|
||||
'203':
|
||||
"203":
|
||||
description: Deleted succsessfully
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- Activity
|
||||
|
||||
@@ -2,13 +2,13 @@ post:
|
||||
description: Creates a new comment.
|
||||
operationId: createComment
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ "collection", "item", "comment" ]
|
||||
required: ["collection", "item", "comment"]
|
||||
properties:
|
||||
collection:
|
||||
type: string
|
||||
@@ -20,18 +20,18 @@ post:
|
||||
type: string
|
||||
example: A new comment
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Activity'
|
||||
$ref: "#/components/schemas/Activity"
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
- Activity
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
get:
|
||||
description: Retrieves the details of an existing activity action. Provide the primary
|
||||
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: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -15,10 +16,10 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Activity'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Activity"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Activity
|
||||
- Activity
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
get:
|
||||
operationId: getActivitys
|
||||
description: Returns a list of activity actions.
|
||||
parameters:
|
||||
- $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/q'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Activity'
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
tags:
|
||||
- Activity
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
- Assets
|
||||
operationId: getAsset
|
||||
description: Image typed files can be dynamically resized and transformed to fit any need.
|
||||
security:
|
||||
security:
|
||||
- Auth: []
|
||||
parameters:
|
||||
- name: key
|
||||
@@ -41,11 +41,11 @@ get:
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
|
||||
@@ -8,7 +8,7 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ email, password ]
|
||||
required: [email, password]
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
@@ -28,19 +28,19 @@ post:
|
||||
type: string
|
||||
description: If 2FA is enabled, you need to pass the one time password.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful authentification
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
public:
|
||||
type: boolean
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
token:
|
||||
access_token:
|
||||
type: string
|
||||
user:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
example: eyJhbGciOiJI...
|
||||
expires:
|
||||
type: integer
|
||||
example: 900
|
||||
|
||||
@@ -8,7 +8,7 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ email ]
|
||||
required: [email]
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
@@ -19,5 +19,5 @@ post:
|
||||
example: https://mydomain.com/passwordreset
|
||||
description: Provide a custom reset url which the link in the Email will lead to. The reset token will be passed as a parameter.
|
||||
responses:
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -8,7 +8,7 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ token, password ]
|
||||
required: [token, password]
|
||||
properties:
|
||||
token:
|
||||
type: string
|
||||
@@ -20,5 +20,5 @@ post:
|
||||
format: password
|
||||
description: New password for the user.
|
||||
responses:
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -8,26 +8,28 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ token ]
|
||||
required: [token]
|
||||
properties:
|
||||
refresh_token:
|
||||
type: string
|
||||
example: eyJ0eXAiOiJKV...
|
||||
description: JWT access token you want to refresh. This token can't be expired.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
public:
|
||||
type: boolean
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
token:
|
||||
access_token:
|
||||
type: string
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
example: eyJhbGciOiJI...
|
||||
expires:
|
||||
type: integer
|
||||
example: 900
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -10,7 +10,7 @@ get:
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Mode'
|
||||
- $ref: "#/components/parameters/Mode"
|
||||
- name: redirect_url
|
||||
in: query
|
||||
required: true
|
||||
@@ -18,7 +18,7 @@ get:
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -32,5 +32,5 @@ get:
|
||||
properties:
|
||||
token:
|
||||
type: string
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
operationId: sso
|
||||
description: List the SSO providers.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -18,5 +18,5 @@ get:
|
||||
example: ["github", "facebook"]
|
||||
items:
|
||||
type: string
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -2,28 +2,28 @@ get:
|
||||
description: Retrieves the details of a single collection.
|
||||
operationId: getCollection
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Collection'
|
||||
$ref: "#/components/schemas/Collection"
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
- Collections
|
||||
patch:
|
||||
description: Update an existing collection.
|
||||
operationId: updateCollection
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -49,37 +49,37 @@ patch:
|
||||
type: object
|
||||
description: Key value pairs of how to show this collection's name in different languages in the admin app.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Collection'
|
||||
$ref: "#/components/schemas/Collection"
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
- Collections
|
||||
delete:
|
||||
description: "Delete an existing collection. Warning: This will delete the whole collection, including the items within. Proceed with caution."
|
||||
operationId: deleteCollection
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
- Collections
|
||||
parameters:
|
||||
- name: collection
|
||||
in: path
|
||||
required: true
|
||||
description: The unique name of the collection.
|
||||
schema:
|
||||
type: string
|
||||
type: string
|
||||
|
||||
@@ -2,11 +2,11 @@ get:
|
||||
description: Returns a list of the collections available in the project.
|
||||
operationId: getCollections
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Offset"
|
||||
- $ref: "#/components/parameters/Single"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -16,24 +16,24 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Collection'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Collection"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
- Collections
|
||||
post:
|
||||
description: Create a new collection in Directus.
|
||||
operationId: createCollection
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ collection, fields ]
|
||||
required: [collection, fields]
|
||||
properties:
|
||||
collection:
|
||||
type: string
|
||||
@@ -61,18 +61,18 @@ post:
|
||||
type: string
|
||||
description: Key value pairs of how to show this collection's name in different languages in the admin app.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Collection'
|
||||
$ref: "#/components/schemas/Collection"
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Collections
|
||||
- Collections
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: List all installed custom interfaces.
|
||||
operationId: getInterfaces
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,9 +13,9 @@ get:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
- Extensions
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: List all installed custom layouts.
|
||||
operationId: getLayouts
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -13,9 +13,9 @@ get:
|
||||
items:
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
- Extensions
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: List all installed custom modules.
|
||||
operationId: getModules
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -13,9 +13,9 @@ get:
|
||||
items:
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Extensions
|
||||
- Extensions
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: Retrieves the details of a single field in a given collection.
|
||||
operationId: getCollectionField
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -10,13 +10,13 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Field'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
- Fields
|
||||
patch:
|
||||
description: Update an existing field.
|
||||
operationId: updateField
|
||||
@@ -68,7 +68,7 @@ patch:
|
||||
description: Sort order of this field on the edit page of the admin app.
|
||||
type: integer
|
||||
translation:
|
||||
description: 'Key value pair of `<locale>: <translation>` that allows the user to change the displayed name of the field in the admin app.'
|
||||
description: "Key value pair of `<locale>: <translation>` that allows the user to change the displayed name of the field in the admin app."
|
||||
type: object
|
||||
unique:
|
||||
description: If the value of this field should be unique within the collection.
|
||||
@@ -85,7 +85,7 @@ patch:
|
||||
type: integer
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -93,26 +93,26 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Field'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
- Fields
|
||||
|
||||
delete:
|
||||
description: Delete an existing field.
|
||||
operationId: deleteField
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
- Fields
|
||||
parameters:
|
||||
- name: collection
|
||||
in: path
|
||||
@@ -125,4 +125,4 @@ parameters:
|
||||
description: The unique name of the field.
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
required: true
|
||||
|
||||
@@ -2,9 +2,9 @@ get:
|
||||
description: Returns a list of the fields available in the given collection.
|
||||
operationId: getCollectionFields
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -14,13 +14,13 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Field'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
- Fields
|
||||
post:
|
||||
description: Create a new field in a given collection.
|
||||
operationId: createField
|
||||
@@ -28,7 +28,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
required: [ field, datatype, type, length ]
|
||||
required: [field, datatype, type, length]
|
||||
properties:
|
||||
field:
|
||||
description: Unique name of the field. Field name is unique within the collection.
|
||||
@@ -79,7 +79,7 @@ post:
|
||||
description: Sort order of this field on the edit page of the admin app.
|
||||
type: integer
|
||||
translation:
|
||||
description: 'Key value pair of `<locale>: <translation>` that allows the user to change the displayed name of the field in the admin app.'
|
||||
description: "Key value pair of `<locale>: <translation>` that allows the user to change the displayed name of the field in the admin app."
|
||||
type: object
|
||||
unique:
|
||||
description: If the value of this field should be unique within the collection.
|
||||
@@ -96,25 +96,25 @@ post:
|
||||
type: integer
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Field'
|
||||
$ref: "#/components/schemas/Field"
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
- Fields
|
||||
parameters:
|
||||
- description: Unique identifier of the collection the item resides in.
|
||||
in: path
|
||||
name: collection
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
type: string
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Returns a list of the fields available in the project.
|
||||
operationId: getFields
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: "#/components/parameters/Limit"
|
||||
- $ref: "#/components/parameters/Sort"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -15,10 +15,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Field'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Field"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Fields
|
||||
- Fields
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
- Files
|
||||
operationId: getFile
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -12,9 +12,9 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/File'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
patch:
|
||||
description: Update an existing file.
|
||||
tags:
|
||||
@@ -26,7 +26,7 @@ patch:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -34,18 +34,18 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/File'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
delete:
|
||||
description: Delete an existing file.
|
||||
tags:
|
||||
- Files
|
||||
operationId: deleteFile
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
- Files
|
||||
operationId: getFiles
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -14,9 +14,9 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/File'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
post:
|
||||
description: Create a new file.
|
||||
tags:
|
||||
@@ -31,7 +31,7 @@ post:
|
||||
data:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -39,6 +39,6 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/File'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/File"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
- Files
|
||||
operationId: getFileRevision
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
- name: offset
|
||||
in: path
|
||||
description: offset or revision
|
||||
@@ -12,7 +12,7 @@ get:
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -20,6 +20,6 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Revision'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -4,9 +4,9 @@ get:
|
||||
- Files
|
||||
operationId: getFileRevisions
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -16,6 +16,6 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Revision'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Retrieve a single folder by unique identifier.
|
||||
operationId: getFolder
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,19 +13,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Folder'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
- Folders
|
||||
patch:
|
||||
description: Update an existing folder
|
||||
operationId: updateFolder
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -40,7 +40,7 @@ patch:
|
||||
example: 3
|
||||
description: Unique identifier of the parent folder. This allows for nested folders.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -48,25 +48,25 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Folder'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
- Folders
|
||||
|
||||
delete:
|
||||
description: Delete an existing folder
|
||||
operationId: deleteFolder
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
- Folders
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
|
||||
@@ -2,16 +2,16 @@ get:
|
||||
description: List the folders.
|
||||
operationId: getFolders
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $ref: '../../openapi.yaml#/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/q"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -21,19 +21,19 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Folder'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
- Folders
|
||||
post:
|
||||
description: Create a new folder.
|
||||
operationId: createFolder
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -49,7 +49,7 @@ post:
|
||||
type: integer
|
||||
required: [name]
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -57,10 +57,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Folder'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Folder"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Folders
|
||||
- Folders
|
||||
|
||||
@@ -4,10 +4,10 @@ get:
|
||||
- Items
|
||||
operationId: getItem
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -16,25 +16,25 @@ get:
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
patch:
|
||||
description: Update an existing item.
|
||||
tags:
|
||||
- Items
|
||||
operationId: updateItem
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -43,24 +43,24 @@ patch:
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
delete:
|
||||
description: Delete an existing item.
|
||||
tags:
|
||||
- Items
|
||||
operationId: deleteItem
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Collection'
|
||||
- $ref: "#/components/parameters/Collection"
|
||||
- name: id
|
||||
description: Index of the item.
|
||||
in: path
|
||||
@@ -72,4 +72,4 @@ parameters:
|
||||
example: 1
|
||||
- type: string
|
||||
description: Unique identifier of the item.
|
||||
example: 8cbb43fe-4cdf-4991-8352-c461779cec02
|
||||
example: 8cbb43fe-4cdf-4991-8352-c461779cec02
|
||||
|
||||
@@ -3,17 +3,17 @@ get:
|
||||
tags:
|
||||
- Items
|
||||
operationId: getItems
|
||||
security:
|
||||
security:
|
||||
- Auth: []
|
||||
parameters:
|
||||
- $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/q'
|
||||
- $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/q"
|
||||
- name: status
|
||||
in: query
|
||||
description: Filter items by the given status
|
||||
@@ -23,7 +23,7 @@ get:
|
||||
items:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -34,28 +34,28 @@ get:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
post:
|
||||
description: Create a new item.
|
||||
tags:
|
||||
- Items
|
||||
operationId: createItem
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Collection'
|
||||
- $ref: "#/components/parameters/Collection"
|
||||
|
||||
@@ -38,15 +38,15 @@ post:
|
||||
type: string
|
||||
enum: [html, text]
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Mail
|
||||
- Mail
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Retrieve a single permissions object by unique identifier.
|
||||
operationId: getPermission
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,18 +13,18 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Permissions'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
patch:
|
||||
description: Update an existing permission
|
||||
operationId: updatePermission
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -75,7 +75,7 @@ patch:
|
||||
type: object
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -83,24 +83,24 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Permissions'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
delete:
|
||||
description: Delete an existing permission
|
||||
operationId: deletePermission
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
|
||||
@@ -2,9 +2,9 @@ get:
|
||||
description: List the permissions that apply to the current user for the given collection
|
||||
operationId: Enter text here
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Collection'
|
||||
- $ref: "#/components/parameters/Collection"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -14,10 +14,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Permissions'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: List the permissions that apply to the current user.
|
||||
operationId: getMyPermissions
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -12,10 +12,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Permissions'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
|
||||
@@ -2,17 +2,17 @@ get:
|
||||
description: List all permissions.
|
||||
operationId: getPermissions
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $ref: '../../openapi.yaml#/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/q"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -22,18 +22,18 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Permissions'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
post:
|
||||
description: Create a new permission.
|
||||
operationId: createPermission
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -72,7 +72,7 @@ post:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ['featured_image']
|
||||
example: ["featured_image"]
|
||||
status:
|
||||
description: What status this permission applies to.
|
||||
type: string
|
||||
@@ -92,7 +92,7 @@ post:
|
||||
type: string
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -100,10 +100,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Permissions'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Permissions"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Permissions
|
||||
- Permissions
|
||||
|
||||
@@ -3,13 +3,13 @@ get:
|
||||
- Presets
|
||||
operationId: getPreset
|
||||
description: Retrieve a single preset by unique identifier.
|
||||
security:
|
||||
security:
|
||||
- Auth: []
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -17,23 +17,23 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Preset'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
patch:
|
||||
tags:
|
||||
- Presets
|
||||
operationId: updatePreset
|
||||
description: Update an existing preset.
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ collection ]
|
||||
required: [collection]
|
||||
properties:
|
||||
collection:
|
||||
type: string
|
||||
@@ -60,7 +60,7 @@ patch:
|
||||
operator:
|
||||
type: string
|
||||
example: gte
|
||||
value:
|
||||
value:
|
||||
type: integer
|
||||
example: 4.5
|
||||
view_type:
|
||||
@@ -76,7 +76,7 @@ patch:
|
||||
type: object
|
||||
description: Key value pair of language-translation. Can be used to translate the bookmark title in multiple languages.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -84,9 +84,9 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Preset'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
delete:
|
||||
tags:
|
||||
- Presets
|
||||
@@ -95,9 +95,9 @@ delete:
|
||||
security:
|
||||
- Auth: []
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
|
||||
@@ -3,20 +3,20 @@ get:
|
||||
- Presets
|
||||
operationId: getPresets
|
||||
description: List the presets.
|
||||
security:
|
||||
security:
|
||||
- Auth: []
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Page'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $ref: '../../openapi.yaml#/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/q"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -26,23 +26,23 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Preset'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
post:
|
||||
tags:
|
||||
- Presets
|
||||
operationId: createPreset
|
||||
description: Create a new preset.
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [ collection ]
|
||||
required: [collection]
|
||||
properties:
|
||||
collection:
|
||||
type: string
|
||||
@@ -69,7 +69,7 @@ post:
|
||||
operator:
|
||||
type: string
|
||||
example: gte
|
||||
value:
|
||||
value:
|
||||
type: integer
|
||||
example: 4.5
|
||||
view_type:
|
||||
@@ -85,7 +85,7 @@ post:
|
||||
type: object
|
||||
description: Key value pair of language-translation. Can be used to translate the bookmark title in multiple languages.
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -93,6 +93,6 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Preset'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
$ref: "#/components/schemas/Preset"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Retrieve a single relation by unique identifier.
|
||||
operationId: getRelation
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,19 +13,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Relation'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
- Relations
|
||||
patch:
|
||||
description: Update an existing relation
|
||||
operationId: updateRelation
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -38,7 +38,8 @@ patch:
|
||||
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
|
||||
description:
|
||||
Foreign key. Field that holds the primary key of the related
|
||||
collection.
|
||||
type: string
|
||||
field_one:
|
||||
@@ -46,12 +47,13 @@ patch:
|
||||
type: string
|
||||
example: books
|
||||
junction_field:
|
||||
description: Field on the junction table that holds the primary key of
|
||||
description:
|
||||
Field on the junction table that holds the primary key of
|
||||
the related collection.
|
||||
type: string
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -59,24 +61,24 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Relation'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
- Relations
|
||||
delete:
|
||||
description: Delete an existing relation.
|
||||
operationId: deleteRelation
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
- Relations
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
|
||||
@@ -2,17 +2,17 @@ get:
|
||||
description: List the relations.
|
||||
operationId: getRelations
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $ref: '../../openapi.yaml#/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/q"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -22,19 +22,19 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Relation'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
- Relations
|
||||
post:
|
||||
description: Create a new relation.
|
||||
operationId: createRelation
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -61,7 +61,7 @@ post:
|
||||
type: string
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -69,10 +69,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Relation'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Relation"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Relations
|
||||
- Relations
|
||||
|
||||
@@ -2,11 +2,11 @@ get:
|
||||
description: Retrieve a single revision by unique identifier.
|
||||
operationId: getRevision
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -14,10 +14,10 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Revision'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Revisions
|
||||
- Revisions
|
||||
|
||||
@@ -2,17 +2,17 @@ get:
|
||||
description: List the revisions.
|
||||
operationId: getRevisions
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $ref: '../../openapi.yaml#/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/q"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -22,10 +22,10 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Revision'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Revision"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Revisions
|
||||
- Revisions
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Retrieve a single role by unique identifier.
|
||||
operationId: getRole
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,19 +13,19 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Role'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
- Roles
|
||||
patch:
|
||||
description: Update an existing role
|
||||
operationId: updateRole
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -44,7 +44,8 @@ patch:
|
||||
description: ID used with external services in SCIM.
|
||||
type: string
|
||||
ip_whitelist:
|
||||
description: Array of IP addresses that are allowed to connect to the
|
||||
description:
|
||||
Array of IP addresses that are allowed to connect to the
|
||||
API as a user of this role.
|
||||
type: array
|
||||
items:
|
||||
@@ -57,7 +58,7 @@ patch:
|
||||
type: string
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -65,24 +66,24 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Role'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
- Roles
|
||||
delete:
|
||||
description: Delete an existing role
|
||||
operationId: deleteRole
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
- Roles
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
|
||||
@@ -2,17 +2,17 @@ get:
|
||||
description: List the roles.
|
||||
operationId: getRoles
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $ref: '../../openapi.yaml#/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/q"
|
||||
- $ref: "#/components/parameters/Page"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -22,19 +22,19 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Role'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
- Roles
|
||||
post:
|
||||
description: Create a new role.
|
||||
operationId: createRole
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -53,7 +53,8 @@ post:
|
||||
description: ID used with external services in SCIM.
|
||||
type: string
|
||||
ip_whitelist:
|
||||
description: Array of IP addresses that are allowed to connect to the
|
||||
description:
|
||||
Array of IP addresses that are allowed to connect to the
|
||||
API as a user of this role.
|
||||
type: array
|
||||
items:
|
||||
@@ -67,7 +68,7 @@ post:
|
||||
example: Interns
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -75,10 +76,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Role'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Roles
|
||||
- Roles
|
||||
|
||||
@@ -2,18 +2,18 @@ get:
|
||||
description: Retrieve a single SCIM Group by unique identifier.
|
||||
operationId: getSCIMGroup
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
patch:
|
||||
description: Update an existing SCIM Group
|
||||
operationId: updateSCIMGroup
|
||||
@@ -23,29 +23,29 @@ patch:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
delete:
|
||||
description: Delete an existing SCIM Group
|
||||
operationId: deleteSCIMGroup
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
|
||||
@@ -2,39 +2,40 @@ get:
|
||||
description: List the SCIM Groups.
|
||||
operationId: getSCIMGroups
|
||||
parameters:
|
||||
- description: The 1-based index of the first result in the current set of list results.
|
||||
in: query
|
||||
name: startIndex
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
- description: Specifies the desired maximum number of query results per page.
|
||||
in: query
|
||||
name: count
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
- description: Filter by `id`, `userName`, `emails.value` and `externalId` attributes
|
||||
are supported. Only the `eq` operator is supported. Uses format `?filter=id eq
|
||||
15`
|
||||
in: query
|
||||
name: filter
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
- description: The 1-based index of the first result in the current set of list results.
|
||||
in: query
|
||||
name: startIndex
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
- description: Specifies the desired maximum number of query results per page.
|
||||
in: query
|
||||
name: count
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
- description:
|
||||
Filter by `id`, `userName`, `emails.value` and `externalId` attributes
|
||||
are supported. Only the `eq` operator is supported. Uses format `?filter=id eq
|
||||
15`
|
||||
in: query
|
||||
name: filter
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
post:
|
||||
description: Create a new SCIM Group.
|
||||
operationId: createSCIMGroup
|
||||
@@ -44,15 +45,15 @@ post:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
|
||||
@@ -2,7 +2,8 @@ get:
|
||||
description: Retrieve a single SCIM user by unique identifier.
|
||||
operationId: getSCIMUser
|
||||
parameters:
|
||||
- description: The `external_id` saved in `directus_users`. Corresponds to the `id`
|
||||
- description:
|
||||
The `external_id` saved in `directus_users`. Corresponds to the `id`
|
||||
in the SCIM Users endpoint result.
|
||||
in: path
|
||||
name: id
|
||||
@@ -10,64 +11,66 @@ get:
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
patch:
|
||||
description: Update an existing SCIM User
|
||||
operationId: updateSCIMUser
|
||||
parameters:
|
||||
- description: The `external_id` saved in `directus_users`. Corresponds to the `id`
|
||||
in the SCIM Users endpoint result.
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- description:
|
||||
The `external_id` saved in `directus_users`. Corresponds to the `id`
|
||||
in the SCIM Users endpoint result.
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
delete:
|
||||
description: Delete an existing SCIM User
|
||||
operationId: deleteSCIMUser
|
||||
parameters:
|
||||
- description: The `external_id` saved in `directus_users`. Corresponds to the `id`
|
||||
in the SCIM Users endpoint result.
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- description:
|
||||
The `external_id` saved in `directus_users`. Corresponds to the `id`
|
||||
in the SCIM Users endpoint result.
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
|
||||
@@ -14,8 +14,9 @@ get:
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
- description: Filter by `id`, `userName`, `emails.value` and `externalId` attributes
|
||||
are supported. Only the `eq` operator is supported. Uses format `?filter=id eq
|
||||
- description:
|
||||
Filter by `id`, `userName`, `emails.value` and `externalId` attributes
|
||||
are supported. Only the `eq` operator is supported. Uses format `?filter=id eq
|
||||
15`
|
||||
in: query
|
||||
name: filter
|
||||
@@ -23,18 +24,18 @@ get:
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
post:
|
||||
description: Create a new SCIM User.
|
||||
operationId: createSCIMUser
|
||||
@@ -44,15 +45,15 @@ post:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- SCIM
|
||||
- SCIM
|
||||
|
||||
@@ -2,14 +2,14 @@ get:
|
||||
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
|
||||
- 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':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -18,9 +18,9 @@ get:
|
||||
type: object
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Server
|
||||
- Server
|
||||
|
||||
@@ -2,9 +2,9 @@ get:
|
||||
description: Retrieve a single setting by unique identifier.
|
||||
operationId: getSetting
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -12,18 +12,18 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Setting'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
- Settings
|
||||
patch:
|
||||
description: Update an existing setting
|
||||
operationId: updateSetting
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -37,7 +37,7 @@ patch:
|
||||
type: string
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -45,24 +45,24 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Setting'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
- Settings
|
||||
delete:
|
||||
description: Delete an existing setting
|
||||
operationId: deleteSetting
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
- Settings
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Id'
|
||||
- $ref: "#/components/parameters/Id"
|
||||
|
||||
@@ -2,13 +2,13 @@ get:
|
||||
description: List the settings.
|
||||
operationId: getSettings
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: '../../openapi.yaml#/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':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -16,13 +16,13 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Setting'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
- Settings
|
||||
patch:
|
||||
description: Update an existing setting
|
||||
operationId: updateSetting
|
||||
@@ -32,7 +32,7 @@ patch:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -40,18 +40,18 @@ patch:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Setting'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Setting"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Settings
|
||||
- Settings
|
||||
# post:
|
||||
# description: Create a new setting.
|
||||
# operationId: createSettings
|
||||
# parameters:
|
||||
# - $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
# - $ref: '#/components/parameters/Meta'
|
||||
# requestBody:
|
||||
# content:
|
||||
# application/json:
|
||||
@@ -66,10 +66,10 @@ patch:
|
||||
# type: object
|
||||
# properties:
|
||||
# data:
|
||||
# $ref: '../../openapi.yaml#/components/schemas/Setting'
|
||||
# $ref: '#/components/schemas/Setting'
|
||||
# '401':
|
||||
# $ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
# $ref: '#/components/responses/UnauthorizedError'
|
||||
# '404':
|
||||
# $ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
# $ref: '#/components/responses/NotFoundError'
|
||||
# tags:
|
||||
# - Settings
|
||||
# - Settings
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Retrieve the currently authenticated user.
|
||||
operationId: me
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,10 +13,10 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
|
||||
@@ -9,7 +9,7 @@ post:
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -17,10 +17,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
post:
|
||||
description: Invites one or more users to this project. It creates a user with an
|
||||
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
|
||||
@@ -13,7 +14,7 @@ post:
|
||||
description: Email address or array of email addresses of the to-be-invited user(s).
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -21,10 +22,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
patch:
|
||||
description: Updates the last used page field of the user. This is used internally
|
||||
description:
|
||||
Updates the last used page field of the user. This is used internally
|
||||
to be able to open the Directus admin app from the last page you used.
|
||||
operationId: updateLastUsedPage
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -14,11 +15,11 @@ patch:
|
||||
type: string
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
|
||||
@@ -2,10 +2,10 @@ get:
|
||||
description: Retrieve a single user by unique identifier.
|
||||
operationId: getUser
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -13,26 +13,26 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
patch:
|
||||
description: Update an existing user
|
||||
operationId: updateUser
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Fields"
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
$ref: "#/components/schemas/User"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -41,23 +41,23 @@ patch:
|
||||
type: object
|
||||
type: object
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
delete:
|
||||
description: Delete an existing user
|
||||
operationId: deleteUser
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|
||||
- $ref: "#/components/parameters/UUId"
|
||||
|
||||
@@ -2,16 +2,16 @@ get:
|
||||
description: List the users.
|
||||
operationId: getUsers
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Limit'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Offset'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Single'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Sort'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Filter'
|
||||
- $ref: '../../openapi.yaml#/components/parameters/q'
|
||||
- $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/q"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -21,25 +21,25 @@ get:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
post:
|
||||
description: Create a new user.
|
||||
operationId: createUser
|
||||
parameters:
|
||||
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
||||
- $ref: "#/components/parameters/Meta"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
$ref: "#/components/schemas/User"
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -47,10 +47,10 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/User'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/User"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Users
|
||||
- Users
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
description: Get all webhooks.
|
||||
operationId: getWebhooks
|
||||
responses:
|
||||
'200':
|
||||
"200":
|
||||
description: Successful request
|
||||
content:
|
||||
application/json:
|
||||
@@ -10,10 +10,10 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
$ref: '../../openapi.yaml#/components/schemas/Webhook'
|
||||
'401':
|
||||
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
||||
$ref: "#/components/schemas/Webhook"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFoundError"
|
||||
tags:
|
||||
- Webhooks
|
||||
- Webhooks
|
||||
|
||||
Reference in New Issue
Block a user