From 62d46a1df3d551fb9658922541ef06cfbc82b7b6 Mon Sep 17 00:00:00 2001 From: seb Date: Mon, 28 Sep 2026 12:13:17 +0200 Subject: [PATCH] u --- docs/api/README.md | 12 ++++++------ docs/api/routes/article/{:sku => _sku}/print.md | 0 .../api/routes/article/{:sku => _sku}/track_stock.md | 0 .../{:manifestarticleId.md => _manifestarticleId.md} | 0 docs/api/routes/ledger/sku/{:sku.md => _sku.md} | 0 docs/api/routes/printer/{:id.put.md => _id.put.md} | 0 docs/api/routes/warehouse/{:id.put.md => _id.put.md} | 0 scripts/generateApiDocs.js | 3 ++- 8 files changed, 8 insertions(+), 7 deletions(-) rename docs/api/routes/article/{:sku => _sku}/print.md (100%) rename docs/api/routes/article/{:sku => _sku}/track_stock.md (100%) rename docs/api/routes/ledger/manifestarticle/{:manifestarticleId.md => _manifestarticleId.md} (100%) rename docs/api/routes/ledger/sku/{:sku.md => _sku.md} (100%) rename docs/api/routes/printer/{:id.put.md => _id.put.md} (100%) rename docs/api/routes/warehouse/{:id.put.md => _id.put.md} (100%) diff --git a/docs/api/README.md b/docs/api/README.md index 42c0d36..e921696 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -43,13 +43,13 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/article/delete-image.md`](routes/article/delete-image.md) | `DELETE /article/{sku}/image/{fullHash}` | | [`routes/article/order-images.md`](routes/article/order-images.md) | `PUT /article/{sku}/images/order` | | [`routes/article/set-prices.md`](routes/article/set-prices.md) | `PUT /article/{sku}/prices` | -| [`routes/article/:sku/print.md`](routes/article/:sku/print.md) | `POST /article/{sku}/print` | +| [`routes/article/_sku/print.md`](routes/article/_sku/print.md) | `POST /article/{sku}/print` | | [`routes/article/supplier/list.md`](routes/article/supplier/list.md) | `GET /article/{sku}/supplier` | | [`routes/article/supplier/create.md`](routes/article/supplier/create.md) | `POST /article/{sku}/supplier` | | [`routes/article/supplier/order.md`](routes/article/supplier/order.md) | `PUT /article/{sku}/supplier/order` | | [`routes/article/supplier/delete.md`](routes/article/supplier/delete.md) | `DELETE /article/{sku}/supplier/{id}` | | [`routes/article/supplier/update.md`](routes/article/supplier/update.md) | `PATCH /article/{sku}/supplier/{id}` | -| [`routes/article/:sku/track_stock.md`](routes/article/:sku/track_stock.md) | `PUT /article/{sku}/track_stock` | +| [`routes/article/_sku/track_stock.md`](routes/article/_sku/track_stock.md) | `PUT /article/{sku}/track_stock` | | [`routes/article/set-weight.md`](routes/article/set-weight.md) | `PUT /article/{sku}/weight` | | [`routes/articleIndex.md`](routes/articleIndex.md) | `GET /articleIndex` | | [`routes/auth/login.md`](routes/auth/login.md) | `POST /auth/login` | @@ -112,8 +112,8 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/labeltemplate/update.md`](routes/labeltemplate/update.md) | `PUT /labeltemplate/{id}` | | [`routes/ledger.get.md`](routes/ledger.get.md) | `GET /ledger` | | [`routes/ledger.post.md`](routes/ledger.post.md) | `POST /ledger` | -| [`routes/ledger/manifestarticle/:manifestarticleId.md`](routes/ledger/manifestarticle/:manifestarticleId.md) | `GET /ledger/manifestarticle/{manifestarticleId}` | -| [`routes/ledger/sku/:sku.md`](routes/ledger/sku/:sku.md) | `GET /ledger/sku/{sku}` | +| [`routes/ledger/manifestarticle/_manifestarticleId.md`](routes/ledger/manifestarticle/_manifestarticleId.md) | `GET /ledger/manifestarticle/{manifestarticleId}` | +| [`routes/ledger/sku/_sku.md`](routes/ledger/sku/_sku.md) | `GET /ledger/sku/{sku}` | | [`routes/number/list.md`](routes/number/list.md) | `GET /number` | | [`routes/number/update.md`](routes/number/update.md) | `PATCH /number/{id}` | | [`routes/order/list.md`](routes/order/list.md) | `GET /order` | @@ -134,7 +134,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/printer/delete.md`](routes/printer/delete.md) | `DELETE /printer/{id}` | | [`routes/printer/get.md`](routes/printer/get.md) | `GET /printer/{id}` | | [`routes/printer/update.md`](routes/printer/update.md) | `PATCH /printer/{id}` | -| [`routes/printer/:id.put.md`](routes/printer/:id.put.md) | `PUT /printer/{id}` | +| [`routes/printer/_id.put.md`](routes/printer/_id.put.md) | `PUT /printer/{id}` | | [`routes/quote/list.md`](routes/quote/list.md) | `GET /quote` | | [`routes/quote/create.md`](routes/quote/create.md) | `POST /quote` | | [`routes/quote/delete.md`](routes/quote/delete.md) | `DELETE /quote/{id}` | @@ -159,7 +159,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/warehouse/delete.md`](routes/warehouse/delete.md) | `DELETE /warehouse/{id}` | | [`routes/warehouse/get.md`](routes/warehouse/get.md) | `GET /warehouse/{id}` | | [`routes/warehouse/update.md`](routes/warehouse/update.md) | `PATCH /warehouse/{id}` | -| [`routes/warehouse/:id.put.md`](routes/warehouse/:id.put.md) | `PUT /warehouse/{id}` | +| [`routes/warehouse/_id.put.md`](routes/warehouse/_id.put.md) | `PUT /warehouse/{id}` | Machine-readable spec: [`openapi.json`](openapi.json). diff --git a/docs/api/routes/article/:sku/print.md b/docs/api/routes/article/_sku/print.md similarity index 100% rename from docs/api/routes/article/:sku/print.md rename to docs/api/routes/article/_sku/print.md diff --git a/docs/api/routes/article/:sku/track_stock.md b/docs/api/routes/article/_sku/track_stock.md similarity index 100% rename from docs/api/routes/article/:sku/track_stock.md rename to docs/api/routes/article/_sku/track_stock.md diff --git a/docs/api/routes/ledger/manifestarticle/:manifestarticleId.md b/docs/api/routes/ledger/manifestarticle/_manifestarticleId.md similarity index 100% rename from docs/api/routes/ledger/manifestarticle/:manifestarticleId.md rename to docs/api/routes/ledger/manifestarticle/_manifestarticleId.md diff --git a/docs/api/routes/ledger/sku/:sku.md b/docs/api/routes/ledger/sku/_sku.md similarity index 100% rename from docs/api/routes/ledger/sku/:sku.md rename to docs/api/routes/ledger/sku/_sku.md diff --git a/docs/api/routes/printer/:id.put.md b/docs/api/routes/printer/_id.put.md similarity index 100% rename from docs/api/routes/printer/:id.put.md rename to docs/api/routes/printer/_id.put.md diff --git a/docs/api/routes/warehouse/:id.put.md b/docs/api/routes/warehouse/_id.put.md similarity index 100% rename from docs/api/routes/warehouse/:id.put.md rename to docs/api/routes/warehouse/_id.put.md diff --git a/scripts/generateApiDocs.js b/scripts/generateApiDocs.js index fd7a781..6f0633c 100644 --- a/scripts/generateApiDocs.js +++ b/scripts/generateApiDocs.js @@ -202,7 +202,8 @@ function docsFileFor(apiPath, method) { const cleaned = apiPath .replace(/^\//, '') - .replace(/\{([^}]+)\}/g, ':$1'); + .replace(/\{([^}]+)\}/g, '_$1') + .replace(/:([a-zA-Z0-9_]+)/g, '_$1'); const segments = cleaned.split('/').filter(Boolean); if (segments.length === 0) return `${method}.md`;