Skip to content

Conversation

@spicy-sauce
Copy link
Contributor

No description provided.

…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
@github-actions
Copy link
Contributor

Staging links:
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/api-reference
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-add-context
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-configure-rdi
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-create
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-delete-all-contexts
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-delete-context
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-deploy
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-describe-job
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-dump-support-package
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-get-rejected
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-install
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-list-contexts
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-list-jobs
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-monitor
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-reset
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-scaffold
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-set-context
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-set-secret
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-start
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-status
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-stop
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-trace
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di-upgrade
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/cli/redis-di
https://redis.io/docs/staging/RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs/integrate/redis-data-integration/reference/config-yaml-reference

@spicy-sauce spicy-sauce self-assigned this Feb 27, 2025
@spicy-sauce spicy-sauce requested a review from yaronp68 February 27, 2025 12:06
@spicy-sauce spicy-sauce changed the title Rdsc 2986 generate and publish a swagger api web page to be used as reference from clients of the rdi api update autogenerated docs RDSC-2986 generate and publish a swagger api web page to be used as reference from clients of the rdi api update autogenerated docs Feb 27, 2025
@spicy-sauce spicy-sauce changed the title RDSC-2986 generate and publish a swagger api web page to be used as reference from clients of the rdi api update autogenerated docs RDSC-2986 API reference for RDI 1.6.0 | Update the rest of RDI reference Feb 27, 2025
Copy link
Contributor

@andy-stark-redis andy-stark-redis left a 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Contributor Author

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Force operation. skips verification prompts
Force operation. Skips verification prompts

Copy link
Contributor Author

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
Copy link
Contributor

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.

Copy link
Contributor Author

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.

@spicy-sauce
Copy link
Contributor Author

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.

@andy-stark-redis
Copy link
Contributor

@spicy-sauce Are you OK for me to merge right now, then, or is there anything else you need to add to this?

@spicy-sauce
Copy link
Contributor Author

No, let's merge. I'm adding a CI that opens that PRs automatically when we publish a new release, but it's unrelated.
I'll also address the stuff you pointed here, thanks for that.

@andy-stark-redis andy-stark-redis merged commit 4126fd7 into main Feb 27, 2025
6 checks passed
@andy-stark-redis andy-stark-redis deleted the RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs branch February 27, 2025 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants