docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,83 @@
+---
+description: 'Learn how to extend a validator. This is useful when you want to pass additional data to endpoints in the Medusa core.'
+addHowToData: true
+---
+
+# How to Extend an Endpoint Validator
+
+In this guide, you'll learn how to extend an endpoint validator from the Medusa core.
+
+## Overview
+
+Request fields passed to endpoints that are defined in the Medusa core are validated to ensure that only expected fields are passed, and the passed fields are of correct types.
+
+In some scenarios, you may need to allow passing custom fields into an existing endpoint. If a custom field is passed to an endpoint in the core, the endpoint returns an error in the response.
+
+To allow passing custom fields into core endpoints, you must extend Validators. Validators are classes that are used by the core to validate the request parameters to an endpoint.
+
+This guide explains how to extend a validator to allow passing custom fields to an endpoint. You'll be extending the validator of the admin API Create Product endpoint as an example.
+
+---
+
+## Prerequisites
+
+This guide assumes you already have a Medusa backend installed and configured. If not, you can check out the [backend quickstart guide](../backend/install.mdx).
+
+---
+
+## Step 1: Create File
+
+You can add the code to extend the validator in any file under the `src` directory of your Medusa project, but it should be executed by `src/api/index.ts`.
+
+For example, you can add the code in an exported function defined in the file `src/api/routes/admin/products/create-product.ts`, then import that file in `src/api/index.ts` and execute the function.
+
+For simplicity, this guide adds the code directly in `src/api/index.ts`. Make sure to create it if it's not already created.
+
+---
+
+## Step 2: Extend Validator
+
+In the file you created, which in this case is `src/api/index.ts`, add the following content to extend the validator:
+
+<!-- eslint-disable max-len -->
+
+```ts title=src/api/index.ts
+import { registerOverriddenValidators } from "@medusajs/medusa"
+import {
+   AdminPostProductsReq as MedusaAdminPostProductsReq,
+} from "@medusajs/medusa/dist/api/routes/admin/products/create-product"
+import { IsString } from "class-validator"
+
+class AdminPostProductsReq extends MedusaAdminPostProductsReq {
+   @IsString()
+   custom_field: string
+}
+
+registerOverriddenValidators(AdminPostProductsReq)
+```
+
+In this code snippet you:
+
+1. Import the `registerOverriddenValidators` function from the `@medusajs/medusa` package. This utility function allows you to extend validators in the core.
+2. Import the `AdminPostProductsReq` class from `@medusajs/medusa` as `MedusaAdminPostProductsReq` since this guide extends the Create Product endpoint validator. If you're extending a different validator, make sure to import it instead.
+3. Create a class `AdminPostProductsReq` that extends `MedusaAdminPostProductsReq` and adds a new field `custom_field`. Notice that the name of the class must be the same name of the validator defined in the core. `custom_field` has the type `string`. You can change the type or name of the field, or add more fields.
+4. Call `registerOverriddenValidators` passing it the `AdminPostProductsReq` class you created. This will override the validator defined in the core to include the new field `custom_field` among the existing fields defined in the core.
+
+:::tip
+
+Validators are defined in the same file as the endpoint. To find the validator you need to override, find the endpoint file under `@medusajs/medusa/dist/api/routes` and import the validator in that file.
+
+:::
+
+---
+
+## Step 3: Test it Out
+
+To test out your extended validator, build and start your Medusa backend:
+
+```bash npm2yarn
+npm run build
+npx medusa develop
+```
+
+Then, send a request to the endpoint you extended passing it your custom fields. To test out the example in this guide, send an [authenticated request](https://docs.medusajs.com/api/admin#authentication) to the [Create Product endpoint](https://docs.medusajs.com/api/admin#products_postproducts) and pass it the `custom_field` body parameter. The request should execute with no errors.