From 95208cfd04031049cec54d3ea9ad3f541e8bb7cb Mon Sep 17 00:00:00 2001 From: admin Date: Mon, 11 Nov 2024 23:24:58 +0100 Subject: [PATCH] Add 'openapi:refs' command and update related test snapshots --- __tests__/__snapshots__/index.test.ts.snap | 18 ++++++++++++++++++ .../lib/__snapshots__/commands.test.ts.snap | 5 +++++ 2 files changed, 23 insertions(+) diff --git a/__tests__/__snapshots__/index.test.ts.snap b/__tests__/__snapshots__/index.test.ts.snap index 18d23afde..7bb62c44a 100644 --- a/__tests__/__snapshots__/index.test.ts.snap +++ b/__tests__/__snapshots__/index.test.ts.snap @@ -44,6 +44,12 @@ Related commands $ rdme openapi:inspect Analyze an OpenAPI/Swagger definition for various OpenAPI and ReadMe feature usage. $ rdme openapi:reduce Reduce an OpenAPI definition into a smaller subset. + $ rdme openapi:refs The script resolves circular and recursive + references in OpenAPI by replacing them with object + schemas. However, not all circular references can + be resolved. You can run the openapi:inspect + command to identify which references remain + unresolved. $ rdme openapi:validate Validate your OpenAPI/Swagger definition. " `; @@ -92,6 +98,12 @@ Related commands $ rdme openapi:inspect Analyze an OpenAPI/Swagger definition for various OpenAPI and ReadMe feature usage. $ rdme openapi:reduce Reduce an OpenAPI definition into a smaller subset. + $ rdme openapi:refs The script resolves circular and recursive + references in OpenAPI by replacing them with object + schemas. However, not all circular references can + be resolved. You can run the openapi:inspect + command to identify which references remain + unresolved. $ rdme openapi:validate Validate your OpenAPI/Swagger definition. " `; @@ -140,6 +152,12 @@ Related commands $ rdme openapi:inspect Analyze an OpenAPI/Swagger definition for various OpenAPI and ReadMe feature usage. $ rdme openapi:reduce Reduce an OpenAPI definition into a smaller subset. + $ rdme openapi:refs The script resolves circular and recursive + references in OpenAPI by replacing them with object + schemas. However, not all circular references can + be resolved. You can run the openapi:inspect + command to identify which references remain + unresolved. $ rdme openapi:validate Validate your OpenAPI/Swagger definition. " `; diff --git a/__tests__/lib/__snapshots__/commands.test.ts.snap b/__tests__/lib/__snapshots__/commands.test.ts.snap index 769abe424..0e7ff16cc 100644 --- a/__tests__/lib/__snapshots__/commands.test.ts.snap +++ b/__tests__/lib/__snapshots__/commands.test.ts.snap @@ -49,6 +49,11 @@ exports[`utils > #listByCategory > should list commands by category 1`] = ` "hidden": false, "name": "openapi:validate", }, + { + "description": "The script resolves circular and recursive references in OpenAPI by replacing them with object schemas. However, not all circular references can be resolved. You can run the openapi:inspect command to identify which references remain unresolved.", + "hidden": false, + "name": "openapi:refs", + }, { "description": "Alias for \`rdme openapi:validate\` [deprecated].", "hidden": true,