docs: add Query documentation (#9079)

- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
This commit is contained in:
Shahed Nasser
2024-09-10 12:31:47 +00:00
committed by GitHub
parent 1d8dd54014
commit e9b5f76f9a
31 changed files with 437 additions and 635 deletions
@@ -256,7 +256,7 @@ import {
defineMiddlewares,
MedusaNextFunction,
MedusaRequest,
MedusaResponse
MedusaResponse,
} from "@medusajs/medusa"
import { MedusaError } from "@medusajs/utils"
@@ -268,9 +268,9 @@ export default defineMiddlewares({
next: MedusaNextFunction
) => {
res.status(400).json({
error: "Something happened."
error: "Something happened.",
})
}
},
})
```
@@ -83,7 +83,7 @@ For example:
```ts title="src/api/admin/custom/route.ts" highlights={[["15"]]}
import type {
AuthenticatedMedusaRequest,
MedusaResponse
MedusaResponse,
} from "@medusajs/medusa"
export const GET = async (
@@ -17,14 +17,14 @@ export const jsonHighlights = [
]
```ts title="src/api/store/custom/route.ts" highlights={jsonHighlights} apiTesting testApiUrl="http://localhost:9000/store/custom" testApiMethod="GET"
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa";
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
res.json({
message: "Hello, World!"
message: "Hello, World!",
})
}
```
@@ -52,14 +52,14 @@ export const statusHighlight = [
]
```ts title="src/api/store/custom/route.ts" highlights={statusHighlight} apiTesting testApiUrl="http://localhost:9000/store/custom" testApiMethod="GET"
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa";
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
res.status(201).json({
message: "Hello, World!"
message: "Hello, World!",
})
}
```
@@ -84,7 +84,7 @@ export const streamHighlights = [
]
```ts highlights={streamHighlights}
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa";
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
export const GET = async (
req: MedusaRequest,
@@ -27,7 +27,7 @@ import { z } from "zod"
export const PostStoreCustomSchema = z.object({
a: z.number(),
b: z.number()
b: z.number(),
})
```
@@ -48,7 +48,7 @@ For example, create the file `src/api/middlewares.ts` with the following content
```ts title="src/api/middlewares.ts"
import { defineMiddlewares } from "@medusajs/medusa"
import {
validateAndTransformBody
validateAndTransformBody,
} from "@medusajs/medusa/dist/api/utils/validate-body"
import { PostStoreCustomSchema } from "./store/custom/validators"
@@ -58,7 +58,7 @@ export default defineMiddlewares({
matcher: "/store/custom",
method: "POST",
middlewares: [
validateAndTransformBody(PostStoreCustomSchema)
validateAndTransformBody(PostStoreCustomSchema),
],
},
],
@@ -87,9 +87,9 @@ export const routeHighlights = [
]
```ts title="src/api/store/custom/route.ts" highlights={routeHighlights}
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa";
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { z } from "zod"
import { PostStoreCustomSchema } from "./validators";
import { PostStoreCustomSchema } from "./validators"
type PostStoreCustomSchemaType = z.infer<
typeof PostStoreCustomSchema
@@ -100,7 +100,7 @@ export const POST = async (
res: MedusaResponse
) => {
res.json({
sum: req.validatedBody.a + req.validatedBody.b
sum: req.validatedBody.a + req.validatedBody.b,
})
}
```