docs: Add request and error examples (#2109)

This commit is contained in:
Shahed Nasser
2022-09-04 21:08:05 +03:00
committed by GitHub
parent c0a002b262
commit 4961aece1c
246 changed files with 8566 additions and 285 deletions

View File

@@ -4,15 +4,14 @@ const fs = require("fs")
const OAS = require("oas-normalize")
const swaggerInline = require("swagger-inline")
const { exec } = require("child_process");
const { exit } = require("process");
const isDryRun = process.argv.indexOf('--dry-run') !== -1;
// Storefront API
swaggerInline(
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/store"],
["./packages/medusa/src/models", "./packages/medusa/src/api/middlewares" , "./packages/medusa/src/api/routes/store"],
{
base: "./docs/api/store-spec3-base.json",
base: "./docs/api/store-spec3-base.yaml",
}
).then((gen) => {
const oas = new OAS(gen)
@@ -31,9 +30,9 @@ swaggerInline(
})
swaggerInline(
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/store"],
["./packages/medusa/src/models", "./packages/medusa/src/api/middlewares" , "./packages/medusa/src/api/routes/store"],
{
base: "./docs/api/store-spec3-base.json",
base: "./docs/api/store-spec3-base.yaml",
format: "yaml",
}
).then((gen) => {
@@ -52,9 +51,9 @@ swaggerInline(
// Admin API
swaggerInline(
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/admin"],
["./packages/medusa/src/models", "./packages/medusa/src/api/middlewares" , "./packages/medusa/src/api/routes/admin"],
{
base: "./docs/api/admin-spec3-base.json",
base: "./docs/api/admin-spec3-base.yaml",
}
).then((gen) => {
const oas = new OAS(gen)
@@ -73,9 +72,9 @@ swaggerInline(
})
swaggerInline(
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/admin"],
["./packages/medusa/src/models", "./packages/medusa/src/api/middlewares" , "./packages/medusa/src/api/routes/admin"],
{
base: "./docs/api/admin-spec3-base.json",
base: "./docs/api/admin-spec3-base.yaml",
format: "yaml",
}
).then((gen) => {
@@ -91,4 +90,4 @@ swaggerInline(
} else {
console.log('No errors occurred while generating Admin API Reference');
}
})
})