Merge branch 'main' into m2a-interface

2026-01-23 10:18:03 -05:00 · 2020-11-18 09:49:13 -05:00
parent ececff6e14 71ab1dc2da
commit 995c3d5004
64 changed files with 2719 additions and 249 deletions
--- a/docs/nav-web.yaml
+++ b/docs/nav-web.yaml
@@ -64,28 +64,28 @@
      title: Extensions
      children:
        - type: page
-          path: /guides/extensions/creating-a-custom-display
+          path: /guides/extensions/displays
          title: Creating a Custom Display
        - type: page
-          path: /guides/extensions/creating-a-custom-interface
+          path: /guides/extensions/interfaces
          title: Creating a Custom Interface
        - type: page
-          path: /guides/extensions/creating-a-custom-layout
+          path: /guides/extensions/layouts
          title: Creating a Custom Layout
        - type: page
-          path: /guides/extensions/creating-a-custom-module
+          path: /guides/extensions/modules
          title: Creating a Custom Module
        - type: page
-          path: /guides/extensions/creating-a-custom-api-endpoint
+          path: /guides/extensions/api-endpoints
          title: Creating a Custom API Endpoint
        - type: page
-          path: /guides/extensions/creating-a-custom-api-hook
+          path: /guides/extensions/api-hooks
          title: Creating a Custom API Hook
        - type: page
-          path: /guides/extensions/creating-a-custom-email-template
+          path: /guides/extensions/email-templates
          title: Creating a Custom Email Template
        - type: page
-          path: /guides/extensions/creating-a-custom-storage-adapter
+          path: /guides/extensions/storage-adapters
          title: Creating a Custom Storage Adapter
        - type: page
          path: /guides/extensions/accessing-data
@@ -103,5 +103,71 @@
      path: /reference/error-codes
      title: Error Codes
    - type: page
-      path: /reference/item-rules
-      title: Item Rules
+      path: /reference/filter-rules
+      title: Filter Rules
+    - type: page
+      path: /reference/item-objects
+      title: Item Objects
+    - type: group
+      title: API
+      children:
+        - type: page
+          path: /reference/api/introduction
+          title: Introduction
+        - type: page
+          path: /reference/api/items
+          title: Items
+        - type: page
+          path: /reference/api/activity
+          title: Activity
+        - type: page
+          path: /reference/api/assets
+          title: Assets
+        - type: page
+          path: /reference/api/authentication
+          title: Authentication
+        - type: page
+          path: /reference/api/collections
+          title: Collections
+        - type: page
+          path: /reference/api/extensions
+          title: Extensions
+        - type: page
+          path: /reference/api/fields
+          title: Fields
+        - type: page
+          path: /reference/api/files
+          title: Files
+        - type: page
+          path: /reference/api/folders
+          title: Folders
+        - type: page
+          path: /reference/api/permissions
+          title: Permissions
+        - type: page
+          path: /reference/api/presets
+          title: Presets
+        - type: page
+          path: /reference/api/relations
+          title: Relations
+        - type: page
+          path: /reference/api/revisions
+          title: Revisions
+        - type: page
+          path: /reference/api/roles
+          title: Roles
+        - type: page
+          path: /reference/api/server
+          title: Server
+        - type: page
+          path: /reference/api/settings
+          title: Settings
+        - type: page
+          path: /reference/api/users
+          title: Users
+        - type: page
+          path: /reference/api/utilities
+          title: Utilities
+        - type: page
+          path: /reference/api/webhooks
+          title: Webhooks
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/docs/reference/api/introduction.md
+++ b/docs/reference/api/introduction.md
@@ -0,0 +1,5 @@
+# API Reference
+
+Directus offers both a RESTful and GraphQL API to manage the data in the database. The API has predictable resource-oriented URLs, relies on standard HTTP status codes, and uses JSON for input and output.
+
+The input/output of the API differs greatly for individual installs, as most of the endpoints will return data that's based on your specific schema.
--- a/packages/specs/package-lock.json
+++ b/packages/specs/package-lock.json
--- a/packages/specs/src/openapi.yaml
+++ b/packages/specs/src/openapi.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.1
 info:
-  title: Directus API
-  description: Template for generating any kind of SDK.
+  title: Directus
+  description: A real-time API and App dashboard for managing SQL database content.
  contact:
    email: contact@directus.io
  license:
@@ -135,10 +135,6 @@ paths:
    $ref: "./paths/files/files.yaml"
  /files/{id}:
    $ref: "./paths/files/file.yaml"
-  /files/{id}/revisions:
-    $ref: "./paths/files/revisions.yaml"
-  /files/{id}/revisions/{offset}:
-    $ref: "./paths/files/revision.yaml"

  # Folders
  /folders:
@@ -187,8 +183,6 @@ paths:
    $ref: "./paths/users/users.yaml"
  /users/{id}:
    $ref: "./paths/users/user.yaml"
-  /users/{id}/track/page:
-    $ref: "./paths/users/user-tracking.yaml"
  /users/invite:
    $ref: "./paths/users/user-invite.yaml"
  /users/invite/accept:
@@ -202,11 +196,6 @@ paths:
  /users/me/tfa/disable:
    $ref: "./paths/users/me-tfa-disable.yaml"

-  # Utilities
-  /utils/hash:
-    $ref: "./paths/utils/hash.yaml"
-  /utils/hash/verify:
-    $ref: "./paths/utils/hash-match.yaml"
  /utils/random/string:
    $ref: "./paths/utils/random.yaml"
  /utils/sort/{collection}:
--- a/packages/specs/src/paths/activity/activities.yaml
+++ b/packages/specs/src/paths/activity/activities.yaml
@@ -1,5 +1,6 @@
 get:
  operationId: getActivities
+  summary: List Activity Actions
  description: Returns a list of activity actions.
  parameters:
    - $ref: "../../openapi.yaml#/components/parameters/Fields"
--- a/packages/specs/src/paths/activity/activity-comment.yaml
+++ b/packages/specs/src/paths/activity/activity-comment.yaml
@@ -1,4 +1,5 @@
 patch:
+  summary: Update a Comment
  description: Update the content of an existing comment.
  operationId: updateComment
  parameters:
@@ -30,6 +31,7 @@ patch:
  tags:
    - Activity
 delete:
+  summary: Delete a Comment
  description: Delete an existing comment. Deleted comments can not be retrieved.
  operationId: deleteComment
  parameters:
--- a/packages/specs/src/paths/activity/activity-comments.yaml
+++ b/packages/specs/src/paths/activity/activity-comments.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Create a Comment
  description: Creates a new comment.
  operationId: createComment
  parameters:
--- a/packages/specs/src/paths/activity/activity.yaml
+++ b/packages/specs/src/paths/activity/activity.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve an Activity Action
  description:
    Retrieves the details of an existing activity action. Provide the primary
    key of the activity action and Directus will return the corresponding information.
--- a/packages/specs/src/paths/assets/assets.yaml
+++ b/packages/specs/src/paths/assets/assets.yaml
@@ -2,9 +2,8 @@ get:
  tags:
    - Assets
  operationId: getAsset
+  summary: Get an Asset
  description: Image typed files can be dynamically resized and transformed to fit any need.
-  security:
-    - Auth: []
  parameters:
    - name: id
      in: path
--- a/packages/specs/src/paths/auth/login.yaml
+++ b/packages/specs/src/paths/auth/login.yaml
@@ -1,5 +1,6 @@
 post:
-  description: Retrieve a Temporary Access Token.
+  summary: Retrieve a Temporary Access Token
+  description: Retrieve a Temporary Access Token
  tags:
    - Authentication
  operationId: login
--- a/packages/specs/src/paths/auth/logout.yaml
+++ b/packages/specs/src/paths/auth/logout.yaml
@@ -1,5 +1,6 @@
 post:
-  description: Log out of directus.
+  summary: Log Out
+  description: Log Out
  tags:
    - Authentication
  operationId: logout
--- a/packages/specs/src/paths/auth/password-request.yaml
+++ b/packages/specs/src/paths/auth/password-request.yaml
@@ -2,6 +2,7 @@ post:
  tags:
    - Authentication
  operationId: passwordRequest
+  summary: Request a Password Reset
  description: Request a reset password email to be send.
  requestBody:
    content:
--- a/packages/specs/src/paths/auth/password-reset.yaml
+++ b/packages/specs/src/paths/auth/password-reset.yaml
@@ -2,6 +2,7 @@ post:
  tags:
    - Authentication
  operationId: passwordReset
+  summary: Reset a Password
  description: The request a password reset endpoint sends an email with a link to the admin app which in turn uses this endpoint to allow the user to reset their password.
  requestBody:
    content:
--- a/packages/specs/src/paths/auth/refresh.yaml
+++ b/packages/specs/src/paths/auth/refresh.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Refresh Token
  description: Refresh a Temporary Access Token.
  tags:
    - Authentication
--- a/packages/specs/src/paths/auth/sso-provider.yaml
+++ b/packages/specs/src/paths/auth/sso-provider.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List SSO providers
  description: List the SSO providers.
  tags:
    - Authentication
--- a/packages/specs/src/paths/auth/sso.yaml
+++ b/packages/specs/src/paths/auth/sso.yaml
@@ -2,6 +2,7 @@ get:
  tags:
    - Authentication
  operationId: sso
+  summary: List SSO Providers
  description: List the SSO providers.
  responses:
    "200":
--- a/packages/specs/src/paths/collections/collection.yaml
+++ b/packages/specs/src/paths/collections/collection.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Collection
  description: Retrieves the details of a single collection.
  operationId: getCollection
  parameters:
@@ -20,6 +21,7 @@ get:
  tags:
    - Collections
 patch:
+  summary: Update a Collection
  description: Update an existing collection.
  operationId: updateCollection
  parameters:
@@ -103,7 +105,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Collections
+
 delete:
+  summary: Delete a Collection
  description: "Delete an existing collection. Warning: This will delete the whole collection, including the items within. Proceed with caution."
  operationId: deleteCollection
  responses:
@@ -115,6 +119,7 @@ delete:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Collections
+
 parameters:
  - name: id
    in: path
--- a/packages/specs/src/paths/collections/collections.yaml
+++ b/packages/specs/src/paths/collections/collections.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Collections
  description: Returns a list of the collections available in the project.
  operationId: getCollections
  parameters:
@@ -23,7 +24,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Collections
+
 post:
+  summary: Create a Collection
  description: Create a new collection in Directus.
  operationId: createCollection
  parameters:
--- a/packages/specs/src/paths/extensions/displays.yaml
+++ b/packages/specs/src/paths/extensions/displays.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Displays
  description: List all installed custom displays.
  operationId: getDisplays
  responses:
--- a/packages/specs/src/paths/extensions/interfaces.yaml
+++ b/packages/specs/src/paths/extensions/interfaces.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Interfaces
  description: List all installed custom interfaces.
  operationId: getInterfaces
  responses:
--- a/packages/specs/src/paths/extensions/layouts.yaml
+++ b/packages/specs/src/paths/extensions/layouts.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Layouts
  description: List all installed custom layouts.
  operationId: getLayouts
  responses:
--- a/packages/specs/src/paths/extensions/modules.yaml
+++ b/packages/specs/src/paths/extensions/modules.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Modules
  description: List all installed custom modules.
  operationId: getModules
  responses:
--- a/packages/specs/src/paths/fields/collection-field.yaml
+++ b/packages/specs/src/paths/fields/collection-field.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Field
  description: Retrieves the details of a single field in a given collection.
  operationId: getCollectionField
  responses:
@@ -17,7 +18,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Fields
+
 patch:
+  summary: Update a Field
  description: Update an existing field.
  operationId: updateField
  requestBody:
@@ -204,7 +207,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Fields
+
 delete:
+  summary: Delete a Field
  description: Delete an existing field.
  operationId: deleteField
  responses:
@@ -216,6 +221,7 @@ delete:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Fields
+
 parameters:
  - name: collection
    in: path
--- a/packages/specs/src/paths/fields/collection-fields.yaml
+++ b/packages/specs/src/paths/fields/collection-fields.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Fields in Collection
  description: Returns a list of the fields available in the given collection.
  operationId: getCollectionFields
  parameters:
@@ -21,7 +22,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Fields
+
 post:
+  summary: Create Field in Collection
  description: Create a new field in a given collection.
  operationId: createField
  requestBody:
--- a/packages/specs/src/paths/fields/fields.yaml
+++ b/packages/specs/src/paths/fields/fields.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List All Fields
  description: Returns a list of the fields available in the project.
  operationId: getFields
  parameters:
--- a/packages/specs/src/paths/files/file.yaml
+++ b/packages/specs/src/paths/files/file.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Files
  description: Retrieve a single file by unique identifier.
  tags:
    - Files
@@ -15,7 +16,9 @@ get:
                $ref: "../../openapi.yaml#/components/schemas/Files"
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 patch:
+  summary: Update a File
  description: Update an existing file.
  tags:
    - Files
@@ -37,7 +40,9 @@ patch:
                $ref: "../../openapi.yaml#/components/schemas/Files"
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 delete:
+  summary: Delete a File
  description: Delete an existing file.
  tags:
    - Files
--- a/packages/specs/src/paths/files/files.yaml
+++ b/packages/specs/src/paths/files/files.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Files
  description: List the files.
  tags:
    - Files
@@ -17,8 +18,10 @@ get:
                  $ref: "../../openapi.yaml#/components/schemas/Files"
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 post:
-  description: Create a new file.
+  summary: Create a File
+  description: Create a new file
  tags:
    - Files
  operationId: createFile
--- a/packages/specs/src/paths/files/revision.yaml
+++ b/packages/specs/src/paths/files/revision.yaml
@@ -1,25 +0,0 @@
-get:
-  description: Retrieve a single revision of the file by offset.
-  tags:
-    - Files
-  operationId: getFileRevision
-  parameters:
-    - $ref: "../../openapi.yaml#/components/parameters/UUId"
-    - name: offset
-      in: path
-      description: offset or revision
-      required: true
-      schema:
-        type: integer
-  responses:
-    "200":
-      description: Successful request
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              data:
-                $ref: "../../openapi.yaml#/components/schemas/Revisions"
-    "401":
-      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
--- a/packages/specs/src/paths/files/revisions.yaml
+++ b/packages/specs/src/paths/files/revisions.yaml
@@ -1,21 +0,0 @@
-get:
-  description: List the revisions made to the given file.
-  tags:
-    - Files
-  operationId: getFileRevisions
-  parameters:
-    - $ref: "../../openapi.yaml#/components/parameters/UUId"
-  responses:
-    "200":
-      description: Successful request
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              data:
-                type: array
-                items:
-                  $ref: "../../openapi.yaml#/components/schemas/Revisions"
-    "401":
-      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
--- a/packages/specs/src/paths/folders/folder.yaml
+++ b/packages/specs/src/paths/folders/folder.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Folder
  description: Retrieve a single folder by unique identifier.
  operationId: getFolder
  parameters:
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Folders
+
 patch:
+  summary: Update a Folder
  description: Update an existing folder
  operationId: updateFolder
  parameters:
@@ -57,6 +60,7 @@ patch:
    - Folders

 delete:
+  summary: Delete a Folder
  description: Delete an existing folder
  operationId: deleteFolder
  responses:
--- a/packages/specs/src/paths/folders/folders.yaml
+++ b/packages/specs/src/paths/folders/folders.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Folders
  description: List the folders.
  operationId: getFolders
  parameters:
@@ -28,7 +29,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Folders
+
 post:
+  summary: Create a Folder
  description: Create a new folder.
  operationId: createFolder
  parameters:
--- a/packages/specs/src/paths/items/item.yaml
+++ b/packages/specs/src/paths/items/item.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve an Item
  description: Retrieve a single item by unique identifier.
  tags:
    - Items
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
    "404":
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
+
 patch:
+  summary: Update an Item
  description: Update an existing item.
  tags:
    - Items
@@ -47,7 +50,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
    "404":
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
+
 delete:
+  summary: Delete an Item
  description: Delete an existing item.
  tags:
    - Items
--- a/packages/specs/src/paths/items/items.yaml
+++ b/packages/specs/src/paths/items/items.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Items
  description: List the items.
  tags:
    - Items
@@ -28,7 +29,9 @@ get:
                  type: object
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 post:
+  summary: Create an Item
  description: Create a new item.
  tags:
    - Items
--- a/packages/specs/src/paths/permissions/permission.yaml
+++ b/packages/specs/src/paths/permissions/permission.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Permission
  description: Retrieve a single permissions object by unique identifier.
  operationId: getPermission
  parameters:
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Permissions
+
 patch:
+  summary: Update a Permission
  description: Update an existing permission
  operationId: updatePermission
  parameters:
@@ -90,7 +93,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Permissions
+
 delete:
+  summary: Delete a Permission
  description: Delete an existing permission
  operationId: deletePermission
  responses:
@@ -102,5 +107,6 @@ delete:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Permissions
+
 parameters:
  - $ref: "../../openapi.yaml#/components/parameters/Id"
--- a/packages/specs/src/paths/permissions/permissions-me.yaml
+++ b/packages/specs/src/paths/permissions/permissions-me.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List My Permissions
  description: List the permissions that apply to the current user.
  operationId: getMyPermissions
  responses:
--- a/packages/specs/src/paths/permissions/permissions.yaml
+++ b/packages/specs/src/paths/permissions/permissions.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Permissions
  description: List all permissions.
  operationId: getPermissions
  parameters:
@@ -29,7 +30,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Permissions
+
 post:
+  summary: Create a Permission
  description: Create a new permission.
  operationId: createPermission
  parameters:
--- a/packages/specs/src/paths/presets/preset.yaml
+++ b/packages/specs/src/paths/presets/preset.yaml
@@ -2,6 +2,7 @@ get:
  tags:
    - Presets
  operationId: getPreset
+  summary: Retrieve a Preset
  description: Retrieve a single preset by unique identifier.
  security:
    - Auth: []
@@ -20,10 +21,12 @@ get:
                $ref: "../../openapi.yaml#/components/schemas/Presets"
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 patch:
  tags:
    - Presets
  operationId: updatePreset
+  summary: Update a Preset
  description: Update an existing preset.
  parameters:
    - $ref: "../../openapi.yaml#/components/parameters/Fields"
@@ -87,10 +90,12 @@ patch:
                $ref: "../../openapi.yaml#/components/schemas/Presets"
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 delete:
  tags:
    - Presets
  operationId: deletePreset
+  summary: Delete a Preset
  description: Delete an existing preset.
  security:
    - Auth: []
--- a/packages/specs/src/paths/presets/presets.yaml
+++ b/packages/specs/src/paths/presets/presets.yaml
@@ -2,6 +2,7 @@ get:
  tags:
    - Presets
  operationId: getPresets
+  summary: List Presets
  description: List the presets.
  security:
    - Auth: []
@@ -29,10 +30,12 @@ get:
                  $ref: "../../openapi.yaml#/components/schemas/Presets"
    "401":
      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
+
 post:
  tags:
    - Presets
  operationId: createPreset
+  summary: Create a Preset
  description: Create a new preset.
  parameters:
    - $ref: "../../openapi.yaml#/components/parameters/Fields"
--- a/packages/specs/src/paths/relations/relation.yaml
+++ b/packages/specs/src/paths/relations/relation.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Relation
  description: Retrieve a single relation by unique identifier.
  operationId: getRelation
  parameters:
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Relations
+
 patch:
+  summary: Update a Relation
  description: Update an existing relation
  operationId: updateRelation
  parameters:
@@ -68,7 +71,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Relations
+
 delete:
+  summary: Delete a Relation
  description: Delete an existing relation.
  operationId: deleteRelation
  responses:
--- a/packages/specs/src/paths/relations/relations.yaml
+++ b/packages/specs/src/paths/relations/relations.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Relations
  description: List the relations.
  operationId: getRelations
  parameters:
@@ -29,7 +30,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Relations
+
 post:
+  summary: Create a Relation
  description: Create a new relation.
  operationId: createRelation
  parameters:
--- a/packages/specs/src/paths/revisions/revision.yaml
+++ b/packages/specs/src/paths/revisions/revision.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Revision
  description: Retrieve a single revision by unique identifier.
  operationId: getRevision
  parameters:
--- a/packages/specs/src/paths/revisions/revisions.yaml
+++ b/packages/specs/src/paths/revisions/revisions.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Revisions
  description: List the revisions.
  operationId: getRevisions
  parameters:
--- a/packages/specs/src/paths/roles/role.yaml
+++ b/packages/specs/src/paths/roles/role.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Role
  description: Retrieve a single role by unique identifier.
  operationId: getRole
  parameters:
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Roles
+
 patch:
+  summary: Update a Role
  description: Update an existing role
  operationId: updateRole
  parameters:
@@ -73,7 +76,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Roles
+
 delete:
+  summary: Delete a Role
  description: Delete an existing role
  operationId: deleteRole
  responses:
--- a/packages/specs/src/paths/roles/roles.yaml
+++ b/packages/specs/src/paths/roles/roles.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Roles
  description: List the roles.
  operationId: getRoles
  parameters:
@@ -29,7 +30,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Roles
+
 post:
+  summary: Create a Role
  description: Create a new role.
  operationId: createRole
  parameters:
--- a/packages/specs/src/paths/server/info.yaml
+++ b/packages/specs/src/paths/server/info.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: System Info
  description: Perform a system status check and return the options.
  operationId: serverInfo
  parameters:
--- a/packages/specs/src/paths/server/ping.yaml
+++ b/packages/specs/src/paths/server/ping.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Ping
  description: Ping, pong. Ping.. pong.
  operationId: ping
  responses:
@@ -11,4 +12,4 @@ get:
            example: pong
      description: Successful request
  tags:
-  - Server
+  - Server
--- a/packages/specs/src/paths/settings/setting.yaml
+++ b/packages/specs/src/paths/settings/setting.yaml
@@ -1,68 +0,0 @@
-get:
-  description: Retrieve a single setting by unique identifier.
-  operationId: getSetting
-  parameters:
-    - $ref: "../../openapi.yaml#/components/parameters/Meta"
-  responses:
-    "200":
-      description: Successful request
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              data:
-                $ref: "../../openapi.yaml#/components/schemas/Settings"
-    "401":
-      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
-    "404":
-      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
-  tags:
-    - Settings
-patch:
-  description: Update an existing setting
-  operationId: updateSetting
-  parameters:
-    - $ref: "../../openapi.yaml#/components/parameters/Meta"
-  requestBody:
-    content:
-      application/json:
-        schema:
-          properties:
-            key:
-              description: Key for the setting
-              type: string
-            value:
-              description: Value for the setting
-              type: string
-          type: object
-  responses:
-    "200":
-      description: Successful request
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              data:
-                $ref: "../../openapi.yaml#/components/schemas/Settings"
-    "401":
-      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
-    "404":
-      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
-  tags:
-    - Settings
-delete:
-  description: Delete an existing setting
-  operationId: deleteSetting
-  responses:
-    "200":
-      description: Successful request
-    "401":
-      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
-    "404":
-      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
-  tags:
-    - Settings
-parameters:
-  - $ref: "../../openapi.yaml#/components/parameters/Id"
--- a/packages/specs/src/paths/settings/settings.yaml
+++ b/packages/specs/src/paths/settings/settings.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve Settings
  description: List the settings.
  operationId: getSettings
  parameters:
@@ -23,8 +24,10 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Settings
+
 patch:
-  description: Update an existing setting
+  summary: Update Settings
+  description: Update the settings
  operationId: updateSetting
  requestBody:
    content:
@@ -47,29 +50,3 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Settings
-# post:
-#   description: Create a new setting.
-#   operationId: createSettings
-#   parameters:
-#     - $ref: '../../openapi.yaml#/components/parameters/Meta'
-#   requestBody:
-#     content:
-#       application/json:
-#         schema:
-#           type: object
-#   responses:
-#     '200':
-#       description: Successful request
-#       content:
-#         application/json:
-#           schema:
-#             type: object
-#             properties:
-#               data:
-#                 $ref: '../../openapi.yaml#/components/schemas/Settings'
-#     '401':
-#       $ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
-#     '404':
-#       $ref: '../../openapi.yaml#/components/responses/NotFoundError'
-#   tags:
-#   - Settings
--- a/packages/specs/src/paths/users/me-tfa-disable.yaml
+++ b/packages/specs/src/paths/users/me-tfa-disable.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Disable 2FA
  description: Disables two-factor authentication for the currently authenticated user.
  operationId: meTfaDisable
  responses:
--- a/packages/specs/src/paths/users/me-tfa-enable.yaml
+++ b/packages/specs/src/paths/users/me-tfa-enable.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Enable 2FA
  description: Enables two-factor authentication for the currently authenticated user.
  operationId: meTfaEnable
  responses:
--- a/packages/specs/src/paths/users/me-tracking.yaml
+++ b/packages/specs/src/paths/users/me-tracking.yaml
@@ -1,4 +1,5 @@
 patch:
+  summary: Update Last Page
  description:
    Updates the last used page field of the currently authenticated user. This is used internally
    to be able to open the Directus admin app from the last page you used.
--- a/packages/specs/src/paths/users/me.yaml
+++ b/packages/specs/src/paths/users/me.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve Current User
  description: Retrieve the currently authenticated user.
  operationId: me
  parameters:
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Users
+
 patch:
+  summary: Update Current User
  description: Update the currently authenticated user.
  operationId: me
  responses:
--- a/packages/specs/src/paths/users/user-invite-accept.yaml
+++ b/packages/specs/src/paths/users/user-invite-accept.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Accept User Invite
  description: Accepts and enables an invited user using a JWT invitation token.
  operationId: acceptInvite
  parameters:
--- a/packages/specs/src/paths/users/user-invite.yaml
+++ b/packages/specs/src/paths/users/user-invite.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Invite User(s)
  description:
    Invites one or more users to this project. It creates a user with an
    invited status, and then sends an email to the user with instructions on how to
--- a/packages/specs/src/paths/users/user-tracking.yaml
+++ b/packages/specs/src/paths/users/user-tracking.yaml
@@ -1,25 +0,0 @@
-patch:
-  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"
-  requestBody:
-    content:
-      application/json:
-        schema:
-          properties:
-            last_page:
-              description: Path of the page you used last.
-              type: string
-          type: object
-  responses:
-    "200":
-      description: Successful request
-    "401":
-      $ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
-    "404":
-      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
-  tags:
-    - Users
--- a/packages/specs/src/paths/users/user.yaml
+++ b/packages/specs/src/paths/users/user.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a User
  description: Retrieve a single user by unique identifier.
  operationId: getUser
  parameters:
@@ -20,7 +21,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Users
+
 patch:
+  summary: Update a User
  description: Update an existing user
  operationId: updateUser
  parameters:
@@ -47,7 +50,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Users
+
 delete:
+  summary: Delete a User
  description: Delete an existing user
  operationId: deleteUser
  responses:
--- a/packages/specs/src/paths/users/users.yaml
+++ b/packages/specs/src/paths/users/users.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Users
  description: List the users.
  operationId: getUsers
  parameters:
@@ -28,7 +29,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Users
+
 post:
+  summary: Create a User
  description: Create a new user.
  operationId: createUser
  parameters:
--- a/packages/specs/src/paths/utils/hash-match.yaml
+++ b/packages/specs/src/paths/utils/hash-match.yaml
@@ -1,27 +0,0 @@
-post:
-  description: Check if a hash is valid for a given string.
-  operationId: checkHash
-  requestBody:
-    content:
-      application/json:
-        schema:
-          properties:
-            hash:
-              description: The hash you want to verify.
-              type: string
-            string:
-              description: String you want to hash.
-              type: string
-          type: object
-  responses:
-    '200':
-      description: Successful request
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              data:
-                type: boolean
-  tags:
-  - Utilities
--- a/packages/specs/src/paths/utils/hash.yaml
+++ b/packages/specs/src/paths/utils/hash.yaml
@@ -1,26 +0,0 @@
-post:
-  description: Create a hash for a given string.
-  operationId: hash
-  requestBody:
-    content:
-      application/json:
-        schema:
-          type: object
-          properties:
-            string:
-              description: String you want to hash.        
-              type: string
-              example: Directus
-  responses:
-    '200':
-      content:
-        application/json:
-          schema:
-            properties:
-              data:
-                type: string
-                example: $argon2i$v=19$m=4096,t=3,p=1$DbHhm1nACWQHG2tkjm+zXQ$cHl7ISy9xlGWZr35zBteK8PdvBi6FiEEEBv236Wgha0
-            type: object
-      description: Successful request
-  tags:
-  - Utilities
--- a/packages/specs/src/paths/utils/random.yaml
+++ b/packages/specs/src/paths/utils/random.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Get a Random String
  description: Returns a random string of given length.
  operationId: random
  parameters:
@@ -20,4 +21,4 @@ get:
            type: object
      description: Successful request
  tags:
-  - Utilities
+  - Utilities
--- a/packages/specs/src/paths/utils/sort.yaml
+++ b/packages/specs/src/paths/utils/sort.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Sort Items
  description: Re-sort items in collection based on start and to value of item
  operationId: sort
  requestBody:
--- a/packages/specs/src/paths/webhooks/webhook.yaml
+++ b/packages/specs/src/paths/webhooks/webhook.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: Retrieve a Webhook
  description: Retrieve a single webhook by unique identifier.
  operationId: getWebhook
  responses:
@@ -17,7 +18,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Webhooks
+
 patch:
+  summary: Update a Webhook
  description: Update an existing webhook
  operationId: updateWebhook
  parameters:
@@ -71,7 +74,9 @@ patch:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Webhooks
+
 delete:
+  summary: Delete a Webhook
  description: Delete an existing webhook
  operationId: deleteWebhook
  responses:
--- a/packages/specs/src/paths/webhooks/webhooks.yaml
+++ b/packages/specs/src/paths/webhooks/webhooks.yaml
@@ -1,4 +1,5 @@
 get:
+  summary: List Webhooks
  description: Get all webhooks.
  operationId: getWebhooks
  responses:
@@ -17,7 +18,9 @@ get:
      $ref: "../../openapi.yaml#/components/responses/NotFoundError"
  tags:
    - Webhooks
+
 post:
+  summary: Create a Webhook
  description: Create a new webhook.
  operationId: createWebhook
  parameters: