Skip to content

fix(spec): correct response shapes and query params per core review#70

Merged
rijkvanzanten merged 1 commit intofix/update-oas-spec-to-v-11-17-3from
bry/fix-pr-66-review
Apr 30, 2026
Merged

fix(spec): correct response shapes and query params per core review#70
rijkvanzanten merged 1 commit intofix/update-oas-spec-to-v-11-17-3from
bry/fix-pr-66-review

Conversation

@bryantgillespie
Copy link
Copy Markdown
Member

Addresses review findings on #66 by aligning the spec with what Directus core actually returns and parses. Each fix verified against directus/directus.

Summary

  • /auth: data is ReadProviderOutput[], not a single object. Response also includes disableDefault (not public). Added sessionOnly query param. (api/src/controllers/auth.ts:258, api/src/utils/get-auth-providers.ts:11)
  • group query params: renamed groupgroupBy and _group_groupBy. sanitizeQuery only parses groupBy/_groupBy. (api/src/utils/sanitize-query.ts:48)
  • /ai/files: handler calls res.json(result) where result is ProviderFileRef. Removed { data: ... } wrapper, typed full shape (provider, fileId, filename, mimeType, sizeBytes, expiresAt). (api/src/ai/files/controllers/upload.ts:132, packages/ai/src/types.ts:81)
  • No-content mutations: registry install, reinstall, and utils revert never set res.locals.payload; respond middleware emits 204. Changed documented status from 200 to 204. (api/src/middleware/respond.ts:124)
  • Registry list response: added meta.filter_count and the full extension item schema (id, name, description, total_downloads, verified, type, last_updated, host_version, sandbox, license, publisher{...}). (packages/extensions-registry/src/modules/list/schemas/registry-list-response.ts)

Test plan

  • `pnpm build` — bundles cleanly
  • `pnpm lint` — passes (only the pre-existing `/deployments/webhooks/{provider}` ambiguity warning remains)
  • Spot-check rendered Redoc output for /auth, /ai/files, /extensions/registry

- /auth: data is array of providers, response includes disableDefault
- params: rename group -> groupBy and _group -> _groupBy to match sanitizeQuery
- /ai/files: return top-level ProviderFileRef, not wrapped in data
- registry install/reinstall and utils revert: 200 -> 204 (no payload)
- registry list: add meta.filter_count and full extension item schema
@bryantgillespie
Copy link
Copy Markdown
Member Author

Used AI to push this one obviously but manually verified these guys.

@rijkvanzanten rijkvanzanten merged commit 95fde39 into fix/update-oas-spec-to-v-11-17-3 Apr 30, 2026
@rijkvanzanten rijkvanzanten deleted the bry/fix-pr-66-review branch April 30, 2026 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants