Update API reference to Directus 11.17.4 (#66)

* feat: update swagger

* fix: fix format

* feat: optimize params

* fix: add missing graphQL singleton update

* Fix path for OAuth endpoint in index.yaml

* Update 'data' type in oauth.yaml from array to object

Changed 'data' type from array to object with properties for name, label, driver, and icon.

* Add code samples to oauthProvider.yaml

Added details explaining that oath is not available in Directus SDK and GraphQL. Fixes #42 

This should also enable the REST endpoint to display.

* Rename OAuth endpoint to login in index.yaml

* fix: request body in utils

Resolves #16

Add `type: object` to schema for:
 - Export Data to a File
 - Generate a Hash
 - Verify a Hash
 - Manually Sort Items in Collection

* docs: remove punctuation from summary

utils/hash/generate and utils/hash/verify contained a `.` at the end of
summary which is inconsistent with the rest of the project.

* feat: add `/access` to API reference

Adds Schema reference as well as the applicable CRUD options.

NOTE: I opted to clarify in filenames that they reference accessRules
rather than trying to figure out how to pluralize accesses in a way that
makes sense.

Fixes #40

* fix(deployments): add deployments

wip

* fix(files): add assets and files

* fix(extensions): add support for extensions (release tag v10.10.0)

TODO: the SDK examples need to be revisited after the following issues
are resolved in the monorepo
directus/directus#27310
directus/directus#27311
directus/directus#27312

* fix(utils): add revert and translations

Revert has been around a while, looks like it was just missed in
previous spec.
Translations was added in v.11.17.x

* fix(schema): add `force` parameter

An enhancement to #61 commit 2ac6094 :
- Add more details to explain conditions that bypass might be necessary
- Version updated, force is introduced in
8c4df17bb6463d0678bff985c161d1376b980325 but there's not a tagged
release. 11.17.3 is at least closest active release right now.

* fix(settings): add ai_ and mcp_ properties

Fixes #65

* fix(ai): add ai endpoint

* feat(mcp): add mcp endpoint

* fix(auth): format graphql code-sample to match standards in project

* Merge origin/pr-26006 (zip download endpoints)

Resolved conflicts by keeping POST method and application/zip responses
(matching API implementation) over pr-26006's incorrect GET variants.
Also fixed duplicate YAML key in oauth.yaml introduced by prior merge.

Co-authored-by: daedalus <44623501+ComfortablyCoding@users.noreply.github.com>

* Apply suggestion from @kheiner

respecting 73b9821 intent

* fix(items): separate mutiple, singular, and singeton operations into distinct entries

- restore singleton as it's own path with PATCH and GET only => I had to
double up the ghost RTL character to make that happen (see #64)
- fix request body schemas for updateItems and deleteItems (keys and
query forms)
- fix title casing

* standardize example url to directus_project_url

* fix(schemas): add missing type field to nullable access schema properties

* fix(utils): add 4xx responses

create ignore file for redocly to supress warnings regarding ping and
health

* fix(health): updated response to explain auth vs no-auth

May change as a result of
directus/directus#27160

* formatting

* Update openapi/index.yaml

* Update openapi/index.yaml

Co-authored-by: kheiner <heiner@heiner.work>

---------

Co-authored-by: Gaetan SENN <gaetan.senn@gmail.com>
Co-authored-by: daedalus <44623501+ComfortablyCoding@users.noreply.github.com>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>

Author: 4 people

.redocly.lint-ignore.yaml

@@ -0,0 +1,6 @@
+# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
+# See https://redocly.com/docs/cli/ for more information.
+dist/oas.yaml:
+  operation-4xx-response:
+    - '#/paths/~1server~1ping/get/responses'
+    - '#/paths/~1server~1health/get/responses'

openapi/components/parameters.yaml

@@ -103,8 +103,7 @@ Export:
     - yaml
 Version:
   name: version
-  description: >-
-    Retrieve an item's state from a specific Content Version. The value corresponds to the "key" of the Content Version.
+  description: Retrieve an item's state from a specific Content Version. The value corresponds to the "key" of the Content Version.
   in: query
   required: false
   schema:
@@ -118,11 +117,148 @@ ConcurrentIndexCreation:
     type: boolean
     default: false
 Backlink:
-  name: backlink
   description: >-
     Retrieve relational items excluding reverse relations when using wildcard fields.
+  name: backlink
   in: query
   required: false
   schema:
     type: boolean
     default: true
+Aggregate:
+  description: >-
+    Aggregate functions allow you to perform calculations on a set of values. Accepts one or more of `count`, `countDistinct`, `countAll`, `sum`, `sumDistinct`, `avg`, `avgDistinct`, `min`, `max`.
+  name: aggregate
+  in: query
+  required: false
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          count:
+            type: array
+            items:
+              type: string
+            description: Count the number of items. Use `['*']` to count all items.
+          countDistinct:
+            type: array
+            items:
+              type: string
+            description: Count the number of unique values in the specified fields.
+          countAll:
+            type: array
+            items:
+              type: string
+            description: Count all items including related items (used with groupBy).
+          sum:
+            type: array
+            items:
+              type: string
+            description: Sum the values of the specified fields.
+          sumDistinct:
+            type: array
+            items:
+              type: string
+            description: Sum the unique values of the specified fields.
+          avg:
+            type: array
+            items:
+              type: string
+            description: Calculate the average of the specified fields.
+          avgDistinct:
+            type: array
+            items:
+              type: string
+            description: Calculate the average of unique values in the specified fields.
+          min:
+            type: array
+            items:
+              type: string
+            description: Find the minimum value of the specified fields.
+          max:
+            type: array
+            items:
+              type: string
+            description: Find the maximum value of the specified fields.
+        example:
+          count: ['*']
+          sum: ['price']
+          avg: ['rating']
+Deep:
+  description: Deep allows you to set any of the other query parameters on a nested relational dataset. Use underscore-prefixed parameter names.
+  name: deep
+  in: query
+  required: false
+  content:
+    application/json:
+      schema:
+        type: object
+        additionalProperties:
+          type: object
+          description: Query parameters for the related field (prefixed with underscore).
+          properties:
+            _fields:
+              type: array
+              items:
+                type: string
+            _sort:
+              type: array
+              items:
+                type: string
+            _filter:
+              type: object
+            _limit:
+              type: integer
+            _offset:
+              type: integer
+            _page:
+              type: integer
+            _search:
+              type: string
+            _group:
+              type: array
+              items:
+                type: string
+            _aggregate:
+              type: object
+        example:
+          related_articles:
+            _limit: 3
+            _sort: ['-date_created']
+            _filter:
+              status:
+                _eq: 'published'
+Alias:
+  description: Alias allows you to rename fields in the response payload. The key is the new name, the value is the original field name.
+  name: alias
+  in: query
+  required: false
+  content:
+    application/json:
+      schema:
+        type: object
+        additionalProperties:
+          type: string
+        example:
+          display_name: full_name
+          creation_date: date_created
+Group:
+  description: >-
+    Grouping allows for running the aggregation functions based on a shared value. Accepts an array of field names.
+  name: group
+  in: query
+  required: false
+  explode: false
+  schema:
+    type: array
+    items:
+      type: string
+VersionRaw:
+  description: Retrieve the raw delta of a Content Version item instead of the full merged item.
+  name: versionRaw
+  in: query
+  required: false
+  schema:
+    type: boolean
+    default: false

openapi/components/responses.yaml

@@ -1,3 +1,33 @@
+BadRequestError:
+  description: "Error: Bad request."
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          error:
+            type: object
+            properties:
+              code:
+                type: integer
+                format: int64
+              message:
+                type: string
+ForbiddenError:
+  description: "Error: Forbidden."
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          error:
+            type: object
+            properties:
+              code:
+                type: integer
+                format: int64
+              message:
+                type: string
 NotFoundError:
   description: "Error: Not found."
   content:

openapi/components/schemas/_index.yaml

@@ -1,5 +1,7 @@
 x-metadata:
   $ref: x-metadata.yaml
+Access:
+  $ref: access.yaml
 Activity:
   $ref: activity.yaml
 Collections:
@@ -8,6 +10,8 @@ Comments:
   $ref: comments.yaml
 Dashboards:
   $ref: dashboards.yaml
+Deployments:
+  $ref: deployments.yaml
 Diff:
   $ref: diff.yaml
 Extensions:
@@ -22,6 +26,10 @@ Folders:
   $ref: folders.yaml
 Items:
   $ref: items.yaml
+JsonRpcRequest:
+  $ref: jsonrpc-request.yaml
+JsonRpcResponse:
+  $ref: jsonrpc-response.yaml
 Notifications:
   $ref: notifications.yaml
 Operations:

openapi/components/schemas/access.yaml

@@ -0,0 +1,38 @@
+type: object
+properties:
+  id:
+    description: Primary key of the access rule.
+    example: 8cbb43fe-4cdf-4991-8352-c461779cec02
+    type: string
+    format: uuid
+  role:
+    description: The role this access rule applies to. Nullable if the rule applies directly to a user. Many-to-one to roles.
+    example: 8b4474c0-288d-4bb8-b62e-8330646bb6aa
+    nullable: true
+    type: string
+    oneOf:
+      - type: string
+        format: uuid
+      - $ref: roles.yaml
+  user:
+    description: The user this access rule applies to. Nullable if the rule applies to a role. Many-to-one to users.
+    example: 0bc7b36a-9ba9-4ce0-83f0-0a526f354e07
+    nullable: true
+    type: string
+    oneOf:
+      - type: string
+        format: uuid
+      - $ref: users.yaml
+  policy:
+    description: The policy associated with this access rule. Many-to-one to policies.
+    example: 22640672-eef0-4ee9-ab04-591f3afb2886
+    oneOf:
+      - type: string
+        format: uuid
+      - $ref: policies.yaml
+  sort:
+    description: Sort order of this access rule.
+    example: 1
+    nullable: true
+    type: integer
+x-collection: directus_access

openapi/components/schemas/deployments.yaml

@@ -0,0 +1,45 @@
+type: object
+properties:
+  id:
+    description: Unique identifier for the deployment configuration.
+    example: 8cbb43fe-4cdf-4991-8352-c461779cec02
+    type: string
+    format: uuid
+  provider:
+    description: The deployment provider. One of `vercel` or `netlify`.
+    example: vercel
+    type: string
+    enum:
+      - vercel
+      - netlify
+  credentials:
+    description: Provider-specific credentials (e.g. API token). Stored encrypted.
+    type: object
+    example:
+      token: abc123
+  options:
+    description: Provider-specific configuration options.
+    nullable: true
+    type: object
+    example:
+      team_id: team_abc123
+  webhook_ids:
+    description: IDs of webhooks registered with the provider for this config.
+    nullable: true
+    type: array
+    items:
+      type: string
+  webhook_secret:
+    description: Secret used to verify webhook payloads from the provider.
+    nullable: true
+    type: string
+  last_synced_at:
+    description: Timestamp of the last provider sync.
+    nullable: true
+    type: string
+    format: date-time
+  date_created:
+    description: When this deployment config was created.
+    type: string
+    format: date-time
+x-collection: directus_deployments

openapi/components/schemas/jsonrpc-request.yaml

@@ -0,0 +1,23 @@
+type: object
+description: A JSON-RPC 2.0 request or notification message.
+required:
+  - jsonrpc
+  - method
+properties:
+  jsonrpc:
+    description: JSON-RPC protocol version. Must be `"2.0"`.
+    type: string
+    enum:
+      - '2.0'
+  id:
+    description: >-
+      Request identifier. May be a string, integer, or null; omit for notifications.
+    oneOf:
+      - type: string
+      - type: integer
+  method:
+    description: MCP method name (e.g. `tools/list`, `tools/call`, `prompts/list`, `prompts/get`, `notifications/initialized`).
+    type: string
+  params:
+    description: Method-specific parameters.
+    type: object

openapi/components/schemas/jsonrpc-response.yaml

@@ -0,0 +1,28 @@
+type: object
+description: A JSON-RPC 2.0 response message.
+required:
+  - jsonrpc
+properties:
+  jsonrpc:
+    description: JSON-RPC protocol version. Always `"2.0"`.
+    type: string
+    enum:
+      - '2.0'
+  id:
+    description: Echoes the `id` from the corresponding request.
+    oneOf:
+      - type: string
+      - type: integer
+  result:
+    description: Method-specific result. Present on success.
+    type: object
+  error:
+    description: Error details. Present on failure.
+    type: object
+    properties:
+      code:
+        type: integer
+      message:
+        type: string
+      data:
+        type: object