Skip to content

Update API reference to Directus 11.17.3#66

Open
kheiner wants to merge 36 commits intodirectus:mainfrom
kheiner:fix/update-oas-spec-to-v-11-17-3
Open

Update API reference to Directus 11.17.3#66
kheiner wants to merge 36 commits intodirectus:mainfrom
kheiner:fix/update-oas-spec-to-v-11-17-3

Conversation

@kheiner
Copy link
Copy Markdown
Contributor

@kheiner kheiner commented Apr 26, 2026 •
edited
Loading

Adds missing endpoints, schema properties, and code samples to bring the OpenAPI spec in line with the current Directus release (I may have accidentally swept in upcoming release items)

What's changed

New endpoints

  • TUS resumable uploads => POST /files/tus, GET/PATCH/DELETE /files/tus/{id}
  • Asset downloads => GET /assets/files (ZIP), GET /assets/folder/{id} (ZIP)
  • Schema apply => adds the force parameter introduced in 8c4df17
  • Utils => POST /utils/revert/{revision} (previously undocumented), POST
    /utils/translations/generate (v11.17.x)
  • Extensions => full rewrite to match UUID-based routing from v10.10.0: adds DELETE
    /extensions/{id}, extensions marketplace registry (list, install, reinstall, uninstall); removes orphaned bundle/name path; SDK samples deferred pending upstream fixes (#27310, #27311, #27312)
  • AI => POST /ai/chat, POST /ai/object, POST /ai/files
  • MCP => GET /mcp, POST /mcp (JSON-RPC 2.0 over HTTP)

Schema updates

  • settings => adds ai_* and mcp_* configuration properties
  • resolves pre-existing errors for missing 4xx responses.

Code sample fixes

  • Standardizes all // Not supported in GraphQL placeholders to use block scalar format (source: |)
  • Standardizes codeSample url for SDK to directus_project_url

Note: I used Claude to help here but I stand by the contributions and have checked them myself. I would appreciate a second set of eyes because I'm not confident in my GraphQL knowledge.

Fixes #66 via 8c8894f, cd1155d, 06f409e, 5258f8d, 5ef3270, 8f2049e, be5e777, 6759120 ( by @gaetansenn)
Fixes #65 via cd1155d
Fixes #62 via 148f3b5
Fixes #61 via 8c8894f
Fixes #57 via 66f60ef
Fixes #56 via cfbec27
Fixes #53 via 06f409e
Fixes #47 via d48849f (by @ComfortablyCoding)
Fixes #43 via c1a95c6 (by @gaetansenn)
Fixes #42 via 93e41ad
Fixes #41 via 01e3af8
Fixes #19 via bbe68ff
Fixes #16 via bbe68ff

gaetansenn and others added 24 commits November 7, 2025 19:19
@gaetansenn
feat: update swagger
567fd12
@gaetansenn
fix: fix format
e09141a
@gaetansenn
feat: optimize params
18174ca
@gaetansenn
fix: add missing graphQL singleton update
c6eff50
@kheiner
Fix path for OAuth endpoint in index.yaml
01e3af8
@kheiner
Update 'data' type in oauth.yaml from array to object
7b0efad 
Changed 'data' type from array to object with properties for name, label, driver, and icon.
@kheiner
Add code samples to oauthProvider.yaml
93e41ad 
Added details explaining that oath is not available in Directus SDK and GraphQL. Fixes directus#42 

This should also enable the REST endpoint to display.
@kheiner
Rename OAuth endpoint to login in index.yaml
1dd8371
@kheiner
Merge branch 'main' into patch-2
6e7a0d5
@kheiner
Merge branch 'main' into patch-1
97f6167
@kheiner
Merge branch 'directus:main' into fix/directus#42-add-example-to-oaut…
e14227b 
…h-providers
@kheiner
Merge branch 'directus:main' into fix/directus#41-update-oauth-providers
b1d1d69
@kheiner
fix: request body in utils
bbe68ff 
Resolves directus#16

Add `type: object` to schema for:
 - Export Data to a File
 - Generate a Hash
 - Verify a Hash
 - Manually Sort Items in Collection
@kheiner
docs: remove punctuation from summary
8fd26d2 
utils/hash/generate and utils/hash/verify contained a `.` at the end of
summary which is inconsistent with the rest of the project.
@kheiner
feat: add /access to API reference
42a7eb1 
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 directus#40
@kheiner
fix(deployments): add deployments
8f2049e 
wip
@kheiner
fix(files): add assets and files
5ef3270
@kheiner
fix(extensions): add support for extensions (release tag v10.10.0)
5258f8d 
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
@kheiner
fix(utils): add revert and translations
06f409e 
Revert has been around a while, looks like it was just missed in
previous spec.
Translations was added in v.11.17.x
@kheiner
fix(schema): add force parameter
8c8894f 
An enhancement to directus#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.
@kheiner
fix(settings): add ai_ and mcp_ properties
cd1155d 
Fixes directus#65
@kheiner
fix(ai): add ai endpoint
be5e777
@kheiner
feat(mcp): add mcp endpoint
6759120
@kheiner
fix(auth): format graphql code-sample to match standards in project
73b9821
@kheiner
Copy link
Copy Markdown
Contributor Author

kheiner commented Apr 26, 2026

Will supersede #63 if approved.

kheiner and others added 5 commits April 26, 2026 13:33
@kheiner
Merge origin/fix/directus#16-undefined-request-body
148f3b5
@kheiner
Merge origin/fix/directus#41-update-oauth-providers
cfbec27
@kheiner
Merge origin/fix/directus#42-add-example-to-oauth-providers
66f60ef
@kheiner
Merge origin/features/move-singleton-items-route
c1a95c6
@kheiner @ComfortablyCoding
Merge origin/pr-26006 (zip download endpoints)
d48849f 
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>
kheiner
kheiner commented Apr 26, 2026
View reviewed changes
Comment thread openapi/paths/auth/oauth/_provider/oauthProvider.yaml Outdated
kheiner
kheiner commented Apr 26, 2026
View reviewed changes
Comment thread openapi/paths/items/_collection/updateItems.yaml
kheiner added 4 commits April 26, 2026 15:56
@kheiner
fix(items): separate mutiple, singular, and singeton operations into …
3605af7 
…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 directus#64)
- fix request body schemas for updateItems and deleteItems (keys and
query forms)
- fix title casing
@kheiner
standardize example url to directus_project_url
dce8722
@kheiner
fix(schemas): add missing type field to nullable access schema proper…
7794769 
…ties
@kheiner
fix(utils): add 4xx responses
4bd638b 
create ignore file for redocly to supress warnings regarding ping and
health
kheiner
kheiner commented Apr 26, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor Author

@kheiner kheiner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with this now. I hope you all like it 🥳

@kheiner kheiner mentioned this pull request Apr 27, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

2 participants

@kheiner @gaetansenn