This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
18 lines
555 B
Plaintext
18 lines
555 B
Plaintext
---
|
|
displayed_sidebar: workflowsSidebar
|
|
slug: /references/workflows
|
|
---
|
|
|
|
import TypeList from "@site/src/components/TypeList"
|
|
|
|
# Workflows API Reference
|
|
|
|
This section of the documentation provides a reference to the utility functions of the `@medusajs/workflows-sdk` package.
|
|
|
|
## Functions
|
|
|
|
- [createStep](../workflows/functions/workflows.createStep.mdx)
|
|
- [createWorkflow](../workflows/functions/workflows.createWorkflow.mdx)
|
|
- [parallelize](../workflows/functions/workflows.parallelize.mdx)
|
|
- [transform](../workflows/functions/workflows.transform.mdx)
|