Files
medusa-store/www/apps/docs/content/references/modules/inventory.mdx
Shahed Nasser bb87db8342 docs: prep for v2 documentation (#6710)
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.
2024-03-18 07:47:35 +00:00

33 lines
2.1 KiB
Plaintext

import TypeList from "@site/src/components/TypeList"
# inventory
## Interfaces
- [FindConfig](../inventory/interfaces/inventory.FindConfig.mdx)
- [StringComparisonOperator](../inventory/interfaces/inventory.StringComparisonOperator.mdx)
- [NumericalComparisonOperator](../inventory/interfaces/inventory.NumericalComparisonOperator.mdx)
- [FilterableReservationItemProps](../inventory/interfaces/inventory.FilterableReservationItemProps.mdx)
- [FilterableInventoryItemProps](../inventory/interfaces/inventory.FilterableInventoryItemProps.mdx)
- [CreateInventoryItemInput](../inventory/interfaces/inventory.CreateInventoryItemInput.mdx)
- [CreateReservationItemInput](../inventory/interfaces/inventory.CreateReservationItemInput.mdx)
- [FilterableInventoryLevelProps](../inventory/interfaces/inventory.FilterableInventoryLevelProps.mdx)
- [CreateInventoryLevelInput](../inventory/interfaces/inventory.CreateInventoryLevelInput.mdx)
- [UpdateInventoryLevelInput](../inventory/interfaces/inventory.UpdateInventoryLevelInput.mdx)
- [BulkUpdateInventoryLevelInput](../inventory/interfaces/inventory.BulkUpdateInventoryLevelInput.mdx)
- [UpdateReservationItemInput](../inventory/interfaces/inventory.UpdateReservationItemInput.mdx)
- [IInventoryService](../inventory/interfaces/inventory.IInventoryService.mdx)
- [JoinerServiceConfigAlias](../inventory/interfaces/inventory.JoinerServiceConfigAlias.mdx)
- [JoinerServiceConfig](../inventory/interfaces/inventory.JoinerServiceConfig.mdx)
- [IModuleService](../inventory/interfaces/inventory.IModuleService.mdx)
- [SharedContext](../inventory/interfaces/inventory.SharedContext.mdx)
## Type Aliases
- [InventoryItemDTO](../inventory/types/inventory.InventoryItemDTO.mdx)
- [ReservationItemDTO](../inventory/types/inventory.ReservationItemDTO.mdx)
- [InventoryLevelDTO](../inventory/types/inventory.InventoryLevelDTO.mdx)
- [JoinerRelationship](../inventory/types/inventory.JoinerRelationship.mdx)
- [ModuleJoinerConfig](../inventory/types/inventory.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../inventory/types/inventory.ModuleJoinerRelationship.mdx)