-
Notifications
You must be signed in to change notification settings - Fork 288
RDSC-2986 API reference for RDI 1.6.0 | Update the rest of RDI reference #1230
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…o-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs' of https://github.com/redis/docs into RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs
…o-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs' of https://github.com/redis/docs into RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs
…uthentication details
andy-stark-redis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor suggestions, but I can fix them manually after you merge, if that's easier.
I've also asked Paolo to review and he's happy with the REST API stuff. He's also offered to help create a way to generate a docs PR automatically when the REST API gets updated on the RDI repo, if that is useful.
Anyway, basically LGTM.
| -o` | ||
|
|
||
| Displays the oldest rejected records. If omitted, most recent records will be retrieved | ||
| Displays the oldest rejected records. If omitted, most resent records will be retrieved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Displays the oldest rejected records. If omitted, most resent records will be retrieved | |
| Displays the oldest rejected records. If omitted, most recent records will be retrieved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed here, will backport to 1.6 as well:
https://github.com/RedisLabs/redis-data-integration/pull/1909
| - Usage: `--force | ||
| -f` | ||
|
|
||
| Force operation. skips verification prompts |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Force operation. skips verification prompts | |
| Force operation. Skips verification prompts |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed here, will backport to 1.6 as well:
https://github.com/RedisLabs/redis-data-integration/pull/1909
| aliases: | ||
| --- | ||
|
|
||
| Adds a new context |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally, if we can remove these lines from the files automatically then that would be great. If they are left in place then the reader will see "Adds a new context" twice in succession (once from the description metadata and once from this line.) I deleted these lines manually last time for speed but it would save a bit of work if we could generate the reference files without them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will take care of it.
|
Yes, let's do that, because the changes are in RDI CLI, I'll change after, but better to merge to have the REST API available and also have everything up to date. |
|
@spicy-sauce Are you OK for me to merge right now, then, or is there anything else you need to add to this? |
|
No, let's merge. I'm adding a CI that opens that PRs automatically when we publish a new release, but it's unrelated. |
No description provided.