Merge branch 'next' into kanad-2024-11-21/v9-release-branch

.github/workflows/ci.yml

@@ -113,3 +113,11 @@ jobs:
         uses: ./rdme-repo/
         with:
           rdme: openapi "oas-examples-repo/3.1/json/petstore.json" --key "${{ secrets.RDME_TEST_PROJECT_API_KEY }}" --id=${{ secrets.RDME_TEST_PROJECT_API_SETTING }}
+
+      # this is a test to ensure that the rdme github action can run properly
+      # the way that our users invoke it
+      - name: E2E run of `openapi validate` on `next` branch
+        uses: readmeio/rdme@next
+        if: ${{ github.ref }} == 'refs/heads/next'
+        with:
+          rdme: openapi validate oas-examples-repo/3.1/json/petstore.json

CHANGELOG.md

@@ -1,3 +1,46 @@
+## [9.0.4-next.3](https://github.com/readmeio/rdme/compare/v9.0.4-next.2...v9.0.4-next.3) (2024-12-12)
+
+
+### Bug Fixes
+
+* openapi arg doc enhancements, refactors ([#1122](https://github.com/readmeio/rdme/issues/1122)) ([b83b233](https://github.com/readmeio/rdme/commit/b83b23337c09f053bf470bf4b41615353b1f3eae))
+
+## [9.0.4-next.2](https://github.com/readmeio/rdme/compare/v9.0.4-next.1...v9.0.4-next.2) (2024-12-11)
+
+
+### Bug Fixes
+
+* copy package.json file instead of symlinking ([1d56c21](https://github.com/readmeio/rdme/commit/1d56c21b0313fb0dcf0721294196b729eb2eaa49))
+
+## [9.0.4-next.1](https://github.com/readmeio/rdme/compare/v9.0.3...v9.0.4-next.1) (2024-12-11)
+
+
+### Bug Fixes
+
+* bring back [#1117](https://github.com/readmeio/rdme/issues/1117) without breaking everything ([#1120](https://github.com/readmeio/rdme/issues/1120)) ([d5d74c5](https://github.com/readmeio/rdme/commit/d5d74c5ac4200c1e0ceaf994f2ff71086894b2c3))
+
+## [9.0.3](https://github.com/readmeio/rdme/compare/v9.0.2...v9.0.3) (2024-12-11)
+
+
+### Bug Fixes
+
+* revert [#1117](https://github.com/readmeio/rdme/issues/1117) ([#1119](https://github.com/readmeio/rdme/issues/1119)) ([c20cc3c](https://github.com/readmeio/rdme/commit/c20cc3cf89a4e108efa485e46c26e8bfb7ba68d6))
+
+## [9.0.3-next.1](https://github.com/readmeio/rdme/compare/v9.0.2...v9.0.3-next.1) (2024-12-11)
+
+
+### Bug Fixes
+
+* revert [#1117](https://github.com/readmeio/rdme/issues/1117) ([#1119](https://github.com/readmeio/rdme/issues/1119)) ([c20cc3c](https://github.com/readmeio/rdme/commit/c20cc3cf89a4e108efa485e46c26e8bfb7ba68d6))
+
+## [9.0.2](https://github.com/readmeio/rdme/compare/v9.0.1...v9.0.2) (2024-12-11)
+
+
+### Bug Fixes
+
+* **autocomplete:** bad alias ([#1118](https://github.com/readmeio/rdme/issues/1118)) ([5b8d928](https://github.com/readmeio/rdme/commit/5b8d9286e891b1bc5cfbcfce1a1862cb8dbdf2b4))
+* remove import attributes ([#1117](https://github.com/readmeio/rdme/issues/1117)) ([e662654](https://github.com/readmeio/rdme/commit/e66265486cac80f79c79f8594b7c60862fadbe12)), closes [#1115](https://github.com/readmeio/rdme/issues/1115) [/github.com/readmeio/rdme/pull/1115#issuecomment-2532123627](https://github.com//github.com/readmeio/rdme/pull/1115/issues/issuecomment-2532123627)
+
 ## [9.0.2-next.2](https://github.com/readmeio/rdme/compare/v9.0.2-next.1...v9.0.2-next.2) (2024-12-10)
 
 

bin/dev.js

@@ -3,7 +3,7 @@
 async function main() {
   const { execute } = await import('@oclif/core');
   await execute({ development: true, dir: import.meta.url }).then(msg => {
-    if (msg) {
+    if (msg && typeof msg === 'string') {
       // eslint-disable-next-line no-console
       console.log(msg);
     }

documentation/commands/categories.md

@@ -15,9 +15,7 @@ USAGE
   $ rdme categories --key <value> [--version <value>]
 
 FLAGS
-  --key=<value>      (required) An API key for your ReadMe project. Note that API authentication is required despite
-                     being omitted from the example usage. See our docs for more information:
-                     https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>      (required) ReadMe project API key
   --version=<value>  ReadMe project version
 
 DESCRIPTION
@@ -29,13 +27,11 @@ EXAMPLES
     $ rdme categories --version={project-version}
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
 
-    ReadMe project API key
-
   --version=<value>  ReadMe project version
 
     If running command in a CI environment and this option is not passed, the main project version will be used. See our
@@ -56,9 +52,7 @@ ARGUMENTS
 FLAGS
   --categoryType=<option>  (required) Category type
                            <options: guide|reference>
-  --key=<value>            (required) An API key for your ReadMe project. Note that API authentication is required
-                           despite being omitted from the example usage. See our docs for more information:
-                           https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>            (required) ReadMe project API key
   --preventDuplicates      Prevents the creation of a new category if there is an existing category with a matching
                            `categoryType` and `title`
   --version=<value>        ReadMe project version
@@ -78,13 +72,11 @@ EXAMPLES
       --preventDuplicates
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
 
-    ReadMe project API key
-
   --version=<value>  ReadMe project version
 
     If running command in a CI environment and this option is not passed, the main project version will be used. See our

documentation/commands/changelogs.md

@@ -19,9 +19,7 @@ ARGUMENTS
 FLAGS
   --dryRun       Runs the command without creating/updating any changelogs in ReadMe. Useful for debugging.
   --github       Create a new GitHub Actions workflow for this command.
-  --key=<value>  (required) An API key for your ReadMe project. Note that API authentication is required despite being
-                 omitted from the example usage. See our docs for more information:
-                 https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>  (required) ReadMe project API key
 
 DESCRIPTION
   Sync Markdown files to your ReadMe project as Changelog posts.
@@ -42,10 +40,8 @@ EXAMPLES
     $ rdme changelogs [path] --version={project-version} --dryRun
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
-
-    ReadMe project API key
 ```

documentation/commands/custompages.md

@@ -19,9 +19,7 @@ ARGUMENTS
 FLAGS
   --dryRun       Runs the command without creating/updating any custom pages in ReadMe. Useful for debugging.
   --github       Create a new GitHub Actions workflow for this command.
-  --key=<value>  (required) An API key for your ReadMe project. Note that API authentication is required despite being
-                 omitted from the example usage. See our docs for more information:
-                 https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>  (required) ReadMe project API key
 
 DESCRIPTION
   Sync Markdown/HTML files to your ReadMe project as Custom Pages.
@@ -42,10 +40,8 @@ EXAMPLES
     $ rdme custompages [path] --version={project-version} --dryRun
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
-
-    ReadMe project API key
 ```

documentation/commands/docs.md

@@ -20,9 +20,7 @@ ARGUMENTS
 FLAGS
   --dryRun           Runs the command without creating/updating any docs in ReadMe. Useful for debugging.
   --github           Create a new GitHub Actions workflow for this command.
-  --key=<value>      (required) An API key for your ReadMe project. Note that API authentication is required despite
-                     being omitted from the example usage. See our docs for more information:
-                     https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>      (required) ReadMe project API key
   --version=<value>  ReadMe project version
 
 DESCRIPTION
@@ -47,13 +45,11 @@ EXAMPLES
     $ rdme docs [path] --version={project-version} --dryRun
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
 
-    ReadMe project API key
-
   --version=<value>  ReadMe project version
 
     If running command in a CI environment and this option is not passed, the main project version will be used. See our
@@ -75,9 +71,7 @@ FLAGS
   --confirm          Bypass the confirmation prompt. Useful for CI environments.
   --dryRun           Runs the command without deleting any docs in ReadMe. Useful for debugging.
   --github           Create a new GitHub Actions workflow for this command.
-  --key=<value>      (required) An API key for your ReadMe project. Note that API authentication is required despite
-                     being omitted from the example usage. See our docs for more information:
-                     https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>      (required) ReadMe project API key
   --version=<value>  ReadMe project version
 
 DESCRIPTION
@@ -96,13 +90,11 @@ EXAMPLES
     $ rdme docs prune [path-to-directory-of-markdown] --confirm
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
 
-    ReadMe project API key
-
   --version=<value>  ReadMe project version
 
     If running command in a CI environment and this option is not passed, the main project version will be used. See our

documentation/commands/openapi.md

@@ -19,7 +19,8 @@ USAGE
     [--workingDirectory <value>] [--github] [--dryRun] [--useSpecVersion] [--raw] [--create | --update]
 
 ARGUMENTS
-  SPEC  A file/URL to your API definition
+  SPEC  A path to your API definition — either a local file path or a URL. If your working directory and all
+        subdirectories contain a single OpenAPI file, you can omit the path.
 
 FLAGS
   --create                    Bypasses the create/update prompt and creates a new API definition in ReadMe.
@@ -28,9 +29,7 @@ FLAGS
   --github                    Create a new GitHub Actions workflow for this command.
   --id=<value>                Unique identifier for your API definition. Use this if you're re-uploading an existing API
                               definition.
-  --key=<value>               (required) An API key for your ReadMe project. Note that API authentication is required
-                              despite being omitted from the example usage. See our docs for more information:
-                              https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>               (required) ReadMe project API key
   --raw                       Return the command results as a JSON object instead of a pretty output.
   --title=<value>             An override value for the `info.title` field in the API definition
   --update                    Bypasses the create/update prompt and automatically updates an existing API definition in
@@ -99,13 +98,11 @@ EXAMPLES
     $ rdme openapi [url-or-local-path-to-file] --version={project-version} --update
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
 
-    ReadMe project API key
-
   --update  Bypasses the create/update prompt and automatically updates an existing API definition in ReadMe.
 
     Note that this flag only works if there's only one API definition associated with the current version.
@@ -125,7 +122,8 @@ USAGE
   $ rdme openapi convert [SPEC] [--out <value>] [--title <value>] [--workingDirectory <value>]
 
 ARGUMENTS
-  SPEC  A file/URL to your API definition
+  SPEC  A path to your API definition — either a local file path or a URL. If your working directory and all
+        subdirectories contain a single OpenAPI file, you can omit the path.
 
 FLAGS
   --out=<value>               Output file path to write converted file to
@@ -162,7 +160,8 @@ USAGE
     dme...] [--workingDirectory <value>]
 
 ARGUMENTS
-  SPEC  A file/URL to your API definition
+  SPEC  A path to your API definition — either a local file path or a URL. If your working directory and all
+        subdirectories contain a single OpenAPI file, you can omit the path.
 
 FLAGS
   --feature=<option>...       A specific OpenAPI or ReadMe feature you wish to see detailed information on (if it
@@ -207,7 +206,8 @@ USAGE
     <value>] [--workingDirectory <value>]
 
 ARGUMENTS
-  SPEC  A file/URL to your API definition
+  SPEC  A path to your API definition — either a local file path or a URL. If your working directory and all
+        subdirectories contain a single OpenAPI file, you can omit the path.
 
 FLAGS
   --method=<value>...         Methods to reduce by (can only be used alongside the `path` option)
@@ -247,7 +247,8 @@ USAGE
   $ rdme openapi validate [SPEC] [--github] [--workingDirectory <value>]
 
 ARGUMENTS
-  SPEC  A file/URL to your API definition
+  SPEC  A path to your API definition — either a local file path or a URL. If your working directory and all
+        subdirectories contain a single OpenAPI file, you can omit the path.
 
 FLAGS
   --github                    Create a new GitHub Actions workflow for this command.

documentation/commands/versions.md

@@ -17,9 +17,7 @@ USAGE
   $ rdme versions --key <value> [--version <value>]
 
 FLAGS
-  --key=<value>      (required) An API key for your ReadMe project. Note that API authentication is required despite
-                     being omitted from the example usage. See our docs for more information:
-                     https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>      (required) ReadMe project API key
   --version=<value>  A specific project version to view.
 
 DESCRIPTION
@@ -35,12 +33,10 @@ EXAMPLES
     $ rdme versions --version={project-version}
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
-
-    ReadMe project API key
 ```
 
 ## `rdme versions create VERSION`
@@ -64,9 +60,7 @@ FLAGS
   --fork=<value>         The semantic version which you'd like to fork from.
   --hidden=<option>      Should this version be hidden? The main version cannot be hidden.
                          <options: true|false>
-  --key=<value>          (required) An API key for your ReadMe project. Note that API authentication is required despite
-                         being omitted from the example usage. See our docs for more information:
-                         https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>          (required) ReadMe project API key
   --main=<option>        Should this be the main version for your project?
                          <options: true|false>
 
@@ -85,12 +79,10 @@ EXAMPLES
       --deprecated={true|false} --hidden={true|false}
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
-
-    ReadMe project API key
 ```
 
 ## `rdme versions delete [VERSION]`
@@ -105,9 +97,7 @@ ARGUMENTS
   VERSION  The version you'd like to delete.
 
 FLAGS
-  --key=<value>  (required) An API key for your ReadMe project. Note that API authentication is required despite being
-                 omitted from the example usage. See our docs for more information:
-                 https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>  (required) ReadMe project API key
 
 DESCRIPTION
   Delete a version associated with your ReadMe project.
@@ -118,12 +108,10 @@ EXAMPLES
     $ rdme versions delete <version>
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
-
-    ReadMe project API key
 ```
 
 ## `rdme versions update [VERSION]`
@@ -146,9 +134,7 @@ FLAGS
                          <options: true|false>
   --hidden=<option>      Should this version be hidden? The main version cannot be hidden.
                          <options: true|false>
-  --key=<value>          (required) An API key for your ReadMe project. Note that API authentication is required despite
-                         being omitted from the example usage. See our docs for more information:
-                         https://github.com/readmeio/rdme/tree/v9#authentication
+  --key=<value>          (required) ReadMe project API key
   --main=<option>        Should this be the main version for your project?
                          <options: true|false>
   --newVersion=<value>   What should the version be renamed to?
@@ -168,10 +154,8 @@ EXAMPLES
       --deprecated={true|false} --hidden={true|false}
 
 FLAG DESCRIPTIONS
-  --key=<value>
+  --key=<value>  ReadMe project API key
 
     An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
     usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
-
-    ReadMe project API key
 ```