github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Remove remaining leftovers from deprecated single query param

Browse Source
This commit is contained in:
rijkvanzanten
2021-05-25 11:38:33 -04:00
parent 7006410c47
commit c3589d138f
17 changed files with 337 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/src/types/query.ts
View File

@@ -11,10 +11,6 @@ export type Query = {
search?: string;
export?: 'json' | 'csv' | 'xml';
deep?: Record<string, Query>;
/**
* @deprecated see https://github.com/directus/directus/discussions/5601 : use limit instead
*/
single?: boolean;
};
export type Sort = {

1
api/src/utils/validate-query.ts
View File

@@ -15,7 +15,6 @@ const querySchema = Joi.object({
limit: Joi.number(),
offset: Joi.number(),
page: Joi.number(),
single: Joi.boolean(),
meta: Joi.array().items(Joi.string().valid('total_count', 'filter_count')),
search: Joi.string(),
export: Joi.string().valid('json', 'csv', 'xml'),

1
packages/cli/src/core/extensions/query.ts
View File

@@ -295,7 +295,6 @@ export default (toolbox: Toolbox): void => {
meta: options.meta,
offset: options.offset,
page: options.page,
single: options.single,
sort: options.sort,
};

1
packages/sdk/src/items.ts
View File

@@ -40,7 +40,6 @@ export type QueryMany<T> = QueryOne<T> & {
limit?: number;
offset?: number;
page?: number;
single?: boolean;
meta?: keyof ItemMetadata | '*';
};

209
packages/specs/src/openapi.yaml
View File

@@ -6,52 +6,71 @@ info:
email: contact@directus.io
license:
name: GPL-3.0
url: "https://www.gnu.org/licenses/gpl-3.0.html"
url: 'https://www.gnu.org/licenses/gpl-3.0.html'
version: 9.0.0
externalDocs:
description: Directus Docs
url: "https://docs.directus.io"
url: 'https://docs.directus.io'
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.
description:
All events that happen within Directus are tracked and stored in the activities collection. This gives you full
accountability over everything that happens.
x-collection: directus_activity
- name: Assets
description: Image typed files can be dynamically resized and transformed to fit any need.
- name: Authentication
description: All events that happen within Directus are tracked and stored in the activities collection. This gives you full accountability over everything that happens.
description:
All events that happen within Directus are tracked and stored in the activities collection. This gives you full
accountability over everything that happens.
- name: Presets
description: Presets hold the preferences of individual users of the platform. This allows Directus to show and maintain custom item listings for users of the app.
description:
Presets hold the preferences of individual users of the platform. This allows Directus to show and maintain custom
item listings for users of the app.
x-collection: directus_presets
- name: Collections
description: Collections are the individual collections of items, similar to tables in a database. Changes to collections will alter the schema of the database.
description:
Collections are the individual collections of items, similar to tables in a database. Changes to collections will
alter the schema of the database.
x-collection: directus_collections
- name: Extensions
description: Directus can easily be extended through the addition of several types of extensions, including layouts, interfaces, and modules.
description:
Directus can easily be extended through the addition of several types of extensions, including layouts,
interfaces, and modules.
- name: Fields
description: Fields are individual pieces of content within an item. They are mapped to columns in the database.
x-collection: directus_fields
- name: Files
description: Files can be saved in any given location. Directus has a powerful assets endpoint that can be used to generate thumbnails for images on the fly.
description:
Files can be saved in any given location. Directus has a powerful assets endpoint that can be used to generate
thumbnails for images on the fly.
x-collection: directus_files
- name: Folders
description: Group files by virtual folders.
x-collection: directus_folders
- name: Items
description: Items are individual pieces of data in your database. They can be anything, from articles, to IoT status checks.
description:
Items are individual pieces of data in your database. They can be anything, from articles, to IoT status checks.
- name: Permissions
description: Permissions control who has access to what and when.
x-collection: directus_permissions
- name: Relations
description: What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of.
description:
What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever
other structures you can think of.
x-collection: directus_relations
- name: Revisions
description: Revisions are individual changes to items made. Directus keeps track of changes made, so you're able to revert to a previous state at will.
description:
Revisions are individual changes to items made. Directus keeps track of changes made, so you're able to revert to
a previous state at will.
x-collection: directus_revisions
- name: Roles
description: Roles are groups of users that share permissions.
x-collection: directus_roles
- name: Server
description: Access to where Directus runs. Allows you to make sure your server has everything needed to run the platform, and check what kind of latency we're dealing with.
description:
Access to where Directus runs. Allows you to make sure your server has everything needed to run the platform, and
check what kind of latency we're dealing with.
- name: Settings
description: Settings control the way the platform works and acts.
x-collection: directus_settings
@@ -66,212 +85,210 @@ tags:
paths:
# Activity
/activity:
$ref: "./paths/activity/activities.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/{id}:
$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/oauth:
$ref: "./paths/auth/oauth.yaml"
$ref: './paths/auth/oauth.yaml'
/auth/oauth/{provider}:
$ref: "./paths/auth/oauth-provider.yaml"
$ref: './paths/auth/oauth-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/{id}:
$ref: "./paths/collections/collection.yaml"
$ref: './paths/collections/collection.yaml'
# Extensions
/extensions/interfaces:
$ref: "./paths/extensions/interfaces.yaml"
$ref: './paths/extensions/interfaces.yaml'
/extensions/layouts:
$ref: "./paths/extensions/layouts.yaml"
$ref: './paths/extensions/layouts.yaml'
/extensions/displays:
$ref: "./paths/extensions/displays.yaml"
$ref: './paths/extensions/displays.yaml'
/extensions/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}/{id}:
$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'
# Folders
/folders:
$ref: "./paths/folders/folders.yaml"
$ref: './paths/folders/folders.yaml'
/folders/{id}:
$ref: "./paths/folders/folder.yaml"
$ref: './paths/folders/folder.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'
# 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'
# Roles
/roles:
$ref: "./paths/roles/roles.yaml"
$ref: './paths/roles/roles.yaml'
/roles/{id}:
$ref: "./paths/roles/role.yaml"
$ref: './paths/roles/role.yaml'
# Server
/server/info:
$ref: "./paths/server/info.yaml"
$ref: './paths/server/info.yaml'
/server/ping:
$ref: "./paths/server/ping.yaml"
$ref: './paths/server/ping.yaml'
# 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/{id}:
$ref: "./paths/users/user.yaml"
$ref: './paths/users/user.yaml'
/users/invite:
$ref: "./paths/users/user-invite.yaml"
$ref: './paths/users/user-invite.yaml'
/users/invite/accept:
$ref: "./paths/users/user-invite-accept.yaml"
$ref: './paths/users/user-invite-accept.yaml'
/users/me:
$ref: "./paths/users/me.yaml"
$ref: './paths/users/me.yaml'
/users/me/track/page:
$ref: "./paths/users/me-tracking.yaml"
$ref: './paths/users/me-tracking.yaml'
/users/me/tfa/enable:
$ref: "./paths/users/me-tfa-enable.yaml"
$ref: './paths/users/me-tfa-enable.yaml'
/users/me/tfa/disable:
$ref: "./paths/users/me-tfa-disable.yaml"
$ref: './paths/users/me-tfa-disable.yaml'
/utils/random/string:
$ref: "./paths/utils/random.yaml"
$ref: './paths/utils/random.yaml'
/utils/sort/{collection}:
$ref: "./paths/utils/sort.yaml"
$ref: './paths/utils/sort.yaml'
# Webhooks
/webhooks:
$ref: "./paths/webhooks/webhooks.yaml"
$ref: './paths/webhooks/webhooks.yaml'
/webhooks/{id}:
$ref: "./paths/webhooks/webhook.yaml"
$ref: './paths/webhooks/webhook.yaml'
components:
schemas:
Activity:
$ref: "./components/activity.yaml"
$ref: './components/activity.yaml'
Presets:
$ref: "./components/preset.yaml"
$ref: './components/preset.yaml'
Collections:
$ref: "./components/collection.yaml"
$ref: './components/collection.yaml'
Fields:
$ref: "./components/field.yaml"
$ref: './components/field.yaml'
Files:
$ref: "./components/file.yaml"
$ref: './components/file.yaml'
Folders:
$ref: "./components/folder.yaml"
$ref: './components/folder.yaml'
Items:
$ref: "./components/item.yaml"
$ref: './components/item.yaml'
Permissions:
$ref: "./components/permissions.yaml"
$ref: './components/permissions.yaml'
Relations:
$ref: "./components/relation.yaml"
$ref: './components/relation.yaml'
Revisions:
$ref: "./components/revision.yaml"
$ref: './components/revision.yaml'
Roles:
$ref: "./components/role.yaml"
$ref: './components/role.yaml'
Settings:
$ref: "./components/setting.yaml"
$ref: './components/setting.yaml'
Users:
$ref: "./components/user.yaml"
$ref: './components/user.yaml'
Webhooks:
$ref: "./components/webhook.yaml"
$ref: './components/webhook.yaml'
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
Search:
$ref: "./parameters/search.yaml"
$ref: './parameters/search.yaml'
Page:
$ref: "./parameters/page.yaml"
$ref: './parameters/page.yaml'
Offset:
$ref: "./parameters/offset.yaml"
Single:
$ref: "./parameters/single.yaml"
$ref: './parameters/offset.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
@@ -280,7 +297,7 @@ components:
Auth:
type: apiKey
in: header
name: "Authorization"
name: 'Authorization'
security:
- Auth: []
- KeyAuth: []

6
packages/specs/src/parameters/single.yaml
View File

@@ -1,6 +0,0 @@
description: Return the result as if it was a single item. Useful for selecting a single item based on filters and search queries.
in: query
name: single
required: false
schema:
type: integer

28
packages/specs/src/paths/activity/activities.yaml
View File

@@ -3,16 +3,16 @@ get:
summary: List Activity Actions
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/Search"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
responses:
"200":
'200':
content:
application/json:
schema:
@@ -21,11 +21,11 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Activity"
$ref: '../../openapi.yaml#/components/schemas/Activity'
description: Successful request
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Activity

39
packages/specs/src/paths/collections/collections.yaml
View File

@@ -3,11 +3,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: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -17,11 +17,11 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Collections"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Collections'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Collections
@@ -30,7 +30,7 @@ post:
description: Create a new collection in Directus.
operationId: createCollection
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
@@ -44,7 +44,9 @@ post:
example: my_collection
fields:
type: array
description: The fields contained in this collection. See the fields reference for more information. Each individual field requires field, type, and interface to be provided.
description:
The fields contained in this collection. See the fields reference for more information. Each individual
field requires field, type, and interface to be provided.
items:
type: object
icon:
@@ -71,7 +73,8 @@ post:
type: boolean
example: false
translation:
description: Key value pairs of how to show this collection's name in different languages in the admin app.
description:
Key value pairs of how to show this collection's name in different languages in the admin app.
type: string
example: null
nullable: true
@@ -101,18 +104,18 @@ post:
example: null
nullable: true
responses:
"200":
'200':
content:
application/json:
schema:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Collections"
$ref: '../../openapi.yaml#/components/schemas/Collections'
description: Successful request
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Collections

45
packages/specs/src/paths/folders/folders.yaml
View File

@@ -3,16 +3,15 @@ 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/Search"
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $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/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -22,11 +21,11 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Folders"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Folders'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Folders
@@ -35,8 +34,8 @@ post:
description: Create a new folder.
operationId: createFolder
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Fields"
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
@@ -52,7 +51,7 @@ post:
type: integer
required: [name]
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -60,10 +59,10 @@ post:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Folders"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Folders'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Folders
- Folders

32
packages/specs/src/paths/items/items.yaml
View File

@@ -7,16 +7,16 @@ get:
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/Search"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -27,8 +27,8 @@ get:
type: array
items:
type: object
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
post:
summary: Create an Item
@@ -37,20 +37,20 @@ post:
- Items
operationId: createItem
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/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: '../../openapi.yaml#/components/responses/UnauthorizedError'
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Collection"
- $ref: '../../openapi.yaml#/components/parameters/Collection'

46
packages/specs/src/paths/permissions/permissions.yaml
View File

@@ -3,17 +3,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/Search"
- $ref: "../../openapi.yaml#/components/parameters/Page"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
- $ref: '../../openapi.yaml#/components/parameters/Page'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -23,11 +23,11 @@ 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: '../../openapi.yaml#/components/schemas/Permissions'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Permissions
@@ -36,7 +36,7 @@ post:
description: Create a new permission.
operationId: createPermission
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
@@ -75,7 +75,7 @@ post:
type: array
items:
type: string
example: ["featured_image"]
example: ['featured_image']
status:
description: What status this permission applies to.
type: string
@@ -95,7 +95,7 @@ post:
type: string
type: object
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -103,10 +103,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: '../../openapi.yaml#/components/schemas/Permissions'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Permissions

49
packages/specs/src/paths/presets/presets.yaml
View File

@@ -7,17 +7,17 @@ get:
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/Search"
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $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/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -27,9 +27,9 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Presets"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
$ref: '../../openapi.yaml#/components/schemas/Presets'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
post:
tags:
@@ -38,8 +38,8 @@ post:
summary: Create a Preset
description: Create a new preset.
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Fields"
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
@@ -53,11 +53,14 @@ post:
example: articles
title:
type: string
description: Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.
description:
Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.
example: Highly rated articles
role:
type: string
description: The unique identifier of a role in the platform. If user is null, this will be used to apply the collection preset or bookmark for all users in the role.
description:
The unique identifier of a role in the platform. If user is null, this will be used to apply the
collection preset or bookmark for all users in the role.
example: null
search:
type: string
@@ -84,12 +87,14 @@ post:
description: Name of the view type that is used.
layout_query:
type: string
description: Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters.
description:
Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same
format as the JS SDK parameters.
layout_options:
type: string
description: Options of the views. The properties in here are controlled by the layout.
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -97,6 +102,6 @@ post:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Presets"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
$ref: '../../openapi.yaml#/components/schemas/Presets'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'

46
packages/specs/src/paths/relations/relations.yaml
View File

@@ -3,17 +3,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/Search"
- $ref: "../../openapi.yaml#/components/parameters/Page"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
- $ref: '../../openapi.yaml#/components/parameters/Page'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -23,11 +23,11 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Relations"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Relations'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Relations
@@ -36,8 +36,8 @@ post:
description: Create a new relation.
operationId: createRelation
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Fields"
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
@@ -64,7 +64,7 @@ post:
type: string
type: object
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -72,10 +72,10 @@ post:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Relations"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Relations'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Relations

30
packages/specs/src/paths/revisions/revisions.yaml
View File

@@ -3,17 +3,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/Search"
- $ref: "../../openapi.yaml#/components/parameters/Page"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
- $ref: '../../openapi.yaml#/components/parameters/Page'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -23,10 +23,10 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Revisions"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Revisions'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Revisions

50
packages/specs/src/paths/roles/roles.yaml
View File

@@ -3,17 +3,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/Search"
- $ref: "../../openapi.yaml#/components/parameters/Page"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
- $ref: '../../openapi.yaml#/components/parameters/Page'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -23,11 +23,11 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Roles"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Roles'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Roles
@@ -36,8 +36,8 @@ post:
description: Create a new role.
operationId: createRole
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Fields"
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
@@ -56,9 +56,7 @@ 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
API as a user of this role.
description: Array of IP addresses that are allowed to connect to the API as a user of this role.
type: array
items:
type: string
@@ -71,7 +69,7 @@ post:
example: Interns
type: object
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -79,10 +77,10 @@ post:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Roles"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Roles'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Roles

34
packages/specs/src/paths/settings/settings.yaml
View File

@@ -3,13 +3,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: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Page'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -17,11 +17,11 @@ get:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Settings"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Settings'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Settings
@@ -35,7 +35,7 @@ patch:
schema:
type: object
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -43,10 +43,10 @@ patch:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Settings"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Settings'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Settings

44
packages/specs/src/paths/users/users.yaml
View File

@@ -3,16 +3,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/Search"
- $ref: '../../openapi.yaml#/components/parameters/Fields'
- $ref: '../../openapi.yaml#/components/parameters/Limit'
- $ref: '../../openapi.yaml#/components/parameters/Offset'
- $ref: '../../openapi.yaml#/components/parameters/Meta'
- $ref: '../../openapi.yaml#/components/parameters/Sort'
- $ref: '../../openapi.yaml#/components/parameters/Filter'
- $ref: '../../openapi.yaml#/components/parameters/Search'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -22,11 +22,11 @@ get:
data:
type: array
items:
$ref: "../../openapi.yaml#/components/schemas/Users"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Users'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Users
@@ -35,14 +35,14 @@ post:
description: Create a new user.
operationId: createUser
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Meta"
- $ref: '../../openapi.yaml#/components/parameters/Meta'
requestBody:
content:
application/json:
schema:
$ref: "../../openapi.yaml#/components/schemas/Users"
$ref: '../../openapi.yaml#/components/schemas/Users'
responses:
"200":
'200':
description: Successful request
content:
application/json:
@@ -50,10 +50,10 @@ post:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Users"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
$ref: '../../openapi.yaml#/components/schemas/Users'
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- Users