Skip to content

Commit b7e5cf1

Browse files
committed
docs: smol fix to version flag guidance
1 parent 9f1d4cf commit b7e5cf1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

documentation/migration-guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ If you're using the `rdme` GitHub Action, update your GitHub Actions workflow fi
8484

8585
- The `--dryRun` flag has been deprecated in favor of `--dry-run`.
8686

87-
- Like `openapi upload` above, there is no prompt to select your ReadMe project version if you omit the `--version` flag. It now defaults to `stable` (i.e., your main ReadMe project version).
87+
- There is no prompt to select your ReadMe project version if you omit the `--version` flag. It now defaults to `stable` (i.e., your main ReadMe project version).
8888

8989
- `rdme docs upload` will now automatically validate your frontmatter and flag any issues prior to syncing. This is particularly helpful if you're coming from `rdme@9` or earlier, since the shape of certain frontmatter attributes (e.g., `category`, `parent`) have slightly changed. If you run this command in a non-CI environment, any outdated frontmatter will be detected and you'll have the ability to update it automatically.
9090

@@ -94,7 +94,7 @@ If you're using the `rdme` GitHub Action, update your GitHub Actions workflow fi
9494

9595
If you previously uploaded API definitions to ReadMe via `rdme openapi`, the command is now `rdme openapi upload`. There are now two main updates:
9696

97-
- There is no prompt to select your ReadMe project version if you omit the `--version` flag. It now defaults to `stable` (i.e., your main ReadMe project version).
97+
- Like `docs upload` above, there is no prompt to select your ReadMe project version if you omit the `--version` flag. It now defaults to `stable` (i.e., your main ReadMe project version).
9898

9999
- The flag paradigms have been simplified based on community feedback. Previously with `openapi`, the `--id` flag was an ObjectId that required an initial upload to ReadMe, which made it difficult to upsert API definitions and manage many at scale (and workarounds were added after the fact in the form of the `--create` and `--update` flags). With `openapi upload`, the `--id` flag has been renamed to `--slug` and is now optional. The slug (i.e., the unique identifier for your API definition resource in ReadMe) is inferred from the file path or URL to your API definition.
100100

0 commit comments

Comments
 (0)