Skip to content

Add directory export/import instructions for the Data Management feature#3043

Open
pwizla wants to merge 54 commits intomainfrom
cms/directory-export-import
Open

Add directory export/import instructions for the Data Management feature#3043
pwizla wants to merge 54 commits intomainfrom
cms/directory-export-import

Conversation

@pwizla
Copy link
Copy Markdown
Collaborator

@pwizla pwizla commented Apr 10, 2026

This PR documents strapi/strapiPR 25867.

pwizla and others added 30 commits April 3, 2026 11:51
z is not re-exported from @strapi/utils, only validateZod is.
Users must import z directly from the zod package.
Also clarify that validateZod returns parsed data on success.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The Options interface in both sanitize and validate only defines
auth. strictParams and route do not exist in the codebase.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The function does not produce UPPER_SNAKE_CASE. It uses slugify
with lowercase: false, preserving original casing with underscore
separators.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add missing options parameter and document the returned function
signature (body, errorMessage?) with default options
{ strict: true, abortEarly: false }.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
env.json: specify it throws a wrapped Error with descriptive message,
not the raw SyntaxError.
env.oneOf: clarify that non-matching values silently return default,
and document the two specific throw conditions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add missing documentation for the defaults and maxLimit options.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Fix ApplicationError typo 'occured' → 'occurred' and align
NotImplementedError default to match source: 'This feature is not implemented yet'

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…refactored

Remove duplicated table cell content on line 32 and add link to
the full strapi-utils documentation in the additional notes section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… text

Replace 7 identical '### Usage example' h3 headings with contextual
sentences ending with a colon, reducing TOC noise while preserving
the code examples themselves.
Remove h3s that were the only sub-section of their parent h2:
Available methods (env), Parameters (parseType, setCreatorFields),
Return values by type (parseType), createAPISanitizers (sanitize),
createAPIValidators (validate), validateZod (zod).
Content is preserved as inline text with function names in backticks.
Add toc_max_heading_level: 2 to keep only the 17 top-level sections
in the secondary navbar. Rewrite example intro lines as proper
sentences starting with 'The following example…'.
Sort function/method tables alphabetically by first column in:
async, contentTypes (attribute + schema inspection), env methods,
file, pagination, strings, and relations.

Tables kept in non-alphabetical order where a logical grouping
makes more sense: contentTypes constants (semantic pairs),
errors (inheritance hierarchy), hooks methods/factories (lifecycle
order), providerFactory methods/hooks (CRUD lifecycle), parseType
params (function signature order), yup methods (by schema type).
Add an example that demonstrates iterating over attributes to find
relations, retrieving writable fields, and checking draft-and-publish
support — the most common contentTypes use cases.
Ensure every code block, table, and structured element is introduced
by a complete sentence, following Google/Microsoft docs style guides
and the editorial convention used across the rest of the Strapi docs.
Add editorial rule to AGENTS.cms.md requiring every code block, table,
or structured element to be preceded by a complete introductory sentence.
This ensures the Drafter applies the convention from the start.
Add an inline <Annotation> on 'scalar value' in the contentTypes
attribute inspection table.
Add lead-in sentences before the Tabs import blocks in the env
and errors sections.
Remove 'path:' prefix from code block title in strapi-utils.
Update AGENTS.cms.md to clarify that title= should contain the
file path directly, never prefixed with 'path:'.
Fix title= attributes in deployment.md, middlewares.md, and
error-handling.md to use the file path directly without 'path:'.
@pwizla pwizla requested a review from innerdvations April 10, 2026 09:59
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment Apr 10, 2026 10:02am

Request Review

@pwizla pwizla requested a review from butcherZ April 10, 2026 10:00
@pwizla pwizla self-assigned this Apr 10, 2026
@github-actions github-actions bot added internal PRs created by the Strapi core team pr: new content PRs for new product features or new documentation sections source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo labels Apr 10, 2026
Copy link
Copy Markdown
Collaborator

@innerdvations innerdvations left a comment

Choose a reason for hiding this comment

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

LGTM!

@pwizla pwizla added the flag: merge pending release Pending Strapi Release label Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

flag: merge pending release Pending Strapi Release internal PRs created by the Strapi core team pr: new content PRs for new product features or new documentation sections source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants