From a907fe5fe35df124b22ddcdc23dd2a1c62ff82ae Mon Sep 17 00:00:00 2001 From: Ali Helmy Date: Fri, 28 Jun 2024 14:58:45 +0300 Subject: [PATCH 1/2] [855] Add download URL property to versions --- demo/package.json | 4 ++-- packages/docusaurus-plugin-openapi-docs/package.json | 2 +- packages/docusaurus-plugin-openapi-docs/src/index.ts | 1 + packages/docusaurus-plugin-openapi-docs/src/types.ts | 1 + packages/docusaurus-theme-openapi-docs/package.json | 2 +- 5 files changed, 6 insertions(+), 4 deletions(-) diff --git a/demo/package.json b/demo/package.json index 6627631fc..bec68c5e2 100644 --- a/demo/package.json +++ b/demo/package.json @@ -25,8 +25,8 @@ "@docusaurus/plugin-google-gtag": "3.4.0", "@docusaurus/preset-classic": "3.4.0", "clsx": "^1.1.1", - "docusaurus-plugin-openapi-docs": "^3.0.0-beta.10", - "docusaurus-theme-openapi-docs": "^3.0.0-beta.10", + "docusaurus-plugin-openapi-docs": "^3.0.0-beta.11", + "docusaurus-theme-openapi-docs": "^3.0.0-beta.11", "prism-react-renderer": "^2.3.0", "react": "^18.2.0", "react-dom": "^18.2.0" diff --git a/packages/docusaurus-plugin-openapi-docs/package.json b/packages/docusaurus-plugin-openapi-docs/package.json index d8776e1d1..f8e8dfad7 100644 --- a/packages/docusaurus-plugin-openapi-docs/package.json +++ b/packages/docusaurus-plugin-openapi-docs/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-plugin-openapi-docs", "description": "OpenAPI plugin for Docusaurus.", - "version": "3.0.0-beta.10", + "version": "3.0.0-beta.11", "license": "MIT", "keywords": [ "openapi", diff --git a/packages/docusaurus-plugin-openapi-docs/src/index.ts b/packages/docusaurus-plugin-openapi-docs/src/index.ts index 78898f460..6d5e39366 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/index.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/index.ts @@ -531,6 +531,7 @@ custom_edit_url: null version: version, label: metadata.label, baseUrl: metadata.baseUrl, + downloadUrl: metadata.downloadUrl, }); } diff --git a/packages/docusaurus-plugin-openapi-docs/src/types.ts b/packages/docusaurus-plugin-openapi-docs/src/types.ts index 1a44d39c7..77023c89e 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/types.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/types.ts @@ -70,6 +70,7 @@ export interface APIVersionOptions { outputDir: string; label: string; baseUrl: string; + downloadUrl?: string; } export interface LoadedContent { diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index a1564b97f..14c911dfe 100644 --- a/packages/docusaurus-theme-openapi-docs/package.json +++ b/packages/docusaurus-theme-openapi-docs/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-theme-openapi-docs", "description": "OpenAPI theme for Docusaurus.", - "version": "3.0.0-beta.10", + "version": "3.0.0-beta.11", "license": "MIT", "keywords": [ "openapi", From fc526f6eed32f4e874dd31463d3e455984d52e61 Mon Sep 17 00:00:00 2001 From: Ali Helmy Date: Fri, 28 Jun 2024 23:12:40 +0300 Subject: [PATCH 2/2] Add downloadUrl to schema Joi and delete it for merge --- packages/docusaurus-plugin-openapi-docs/src/index.ts | 1 + packages/docusaurus-plugin-openapi-docs/src/options.ts | 1 + 2 files changed, 2 insertions(+) diff --git a/packages/docusaurus-plugin-openapi-docs/src/index.ts b/packages/docusaurus-plugin-openapi-docs/src/index.ts index 6d5e39366..4eff2238e 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/index.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/index.ts @@ -686,6 +686,7 @@ custom_edit_url: null delete parentConfig.version; delete parentConfig.label; delete parentConfig.baseUrl; + delete parentConfig.downloadUrl; // TODO: handle when no versions are defined by version command is passed if (versionId === "all") { diff --git a/packages/docusaurus-plugin-openapi-docs/src/options.ts b/packages/docusaurus-plugin-openapi-docs/src/options.ts index f42a02b05..e3f11ddec 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/options.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/options.ts @@ -59,6 +59,7 @@ export const OptionsSchema = Joi.object({ outputDir: Joi.string().required(), label: Joi.string().required(), baseUrl: Joi.string().required(), + downloadUrl: Joi.string(), }) ), })