Add 'openapi:refs' command and update related test snapshots

readmeio · Nov 11, 2024 · 95208cf · 95208cf
1 parent 099a6f1
commit 95208cf
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git 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
@@ -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,