RED-174158: Add Redis Cluster API in docs #2418
Conversation
|
Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset. In case there are security findings, they will be communicated to you as a comment inside the PR. Hope you’ll enjoy using Jit. Questions? Comments? Want to learn more? Get in touch with us. |
|
|
rrelledge
left a comment
There was a problem hiding this comment.
Thanks, @sonya-spasova! This looks great so far. I have a couple of initial questions and requested changes.
Can you move this API reference location underneath the existing API reference directory (https://redis.io/docs/latest/operate/rs/references/rest-api/)?
Ideally, I would like to eventually remove https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ and https://redis.io/docs/latest/operate/rs/references/rest-api/objects/ and redirect readers to the new API reference at https://redis.io/docs/latest/operate/rs/references/rest-api/api-reference instead of the current URL https://redis.io/docs/latest/operate/rs/api/api-reference/.
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "http://localhost:3346" |
There was a problem hiding this comment.
Is 3346 an internal API port? We've been using examples like https://localhost:9443/v1/users in our public docs.
There was a problem hiding this comment.
Yes it is an internal port for the service, but was fixed to present the external 9443 port which client should use connecting to our rest api
There was a problem hiding this comment.
@sonya-spasova Thank you for moving the reference location and fixing the example port number.
Can you also change the example URLs to use https instead of http?
| "openapi": "3.0.3", | ||
| "info": { | ||
| "title": "Authentication Service REST API", | ||
| "description": "REST API for the Authentication Service, primarily used for exposing SSO related endpoints.", |
There was a problem hiding this comment.
@sonya-spasova, if there's not a good way to add a work-in-progress banner to the new API reference page, maybe just adding something like this to the description will be good enough? I tested this change in my local env and was able to see the message under the page title.
| "description": "REST API for the Authentication Service, primarily used for exposing SSO related endpoints.", | |
| "description": "Redis Enterprise Software REST API reference. This API reference is still a work in progress. For more API paths, see the [REST API requests](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/) reference pages.", |
| { | ||
| "openapi": "3.0.3", | ||
| "info": { | ||
| "title": "Authentication Service REST API", |
There was a problem hiding this comment.
| "title": "Authentication Service REST API", | |
| "title": "Redis Enterprise Software REST API", |
No description provided.