RDSC-5669 Publish RDI Cloud API reference by ZdravkoDonev-redis · Pull Request #3562 · redis/docs

ZdravkoDonev-redis · 2026-06-29T09:56:56Z

Summary

merge the Redis Cloud RDI workspace API into the existing Redis Cloud API reference
replace the current generic Data Integration proxy entries with detailed RDI workspace operations under Subscriptions - Pro - Data Integration
update the Redis Cloud API sync workflow to fetch both CAPI and RDI OpenAPI specs from api.redislabs.com and compose them into one reference file
remove the separate Data Integration API reference page

Jira

https://redislabs.atlassian.net/browse/RDSC-5669

Replaces

#3561

Validation

Fetched current specs from https://api.redislabs.com/v1/cloud-api-docs/capi and https://api.redislabs.com/v1/cloud-api-docs/rdi, composed them with the workflow jq logic, and regenerated content/operate/rc/api/api-reference/openapi.json.
Verified checked-in JSON with jq empty content/operate/rc/api/api-reference/openapi.json.
Verified .github/workflows/rc_api_sync.yaml parses as YAML.
Verified the composed Cloud API spec has 124 paths, 31 Data Integration workspace paths, and no old wildcard proxy paths.
Ran hugo --logLevel warn --gc; it still fails on an unrelated commands navigation template issue: layouts/partials/docs-nav.html cannot evaluate ByWeight in []interface{} while rendering content/commands/acl.md.

github-actions · 2026-06-29T09:57:12Z

Staging links:
https://redis.io/docs/staging/rdsc-5669-rdi-capi-docs/operate/rc/api/
https://redis.io/docs/staging/rdsc-5669-rdi-capi-docs/operate/rc/rdi/create-workspace/
https://redis.io/docs/staging/rdsc-5669-rdi-capi-docs/operate/rc/rdi/view-edit/

CLAassistant · 2026-06-29T09:57:13Z

All committers have signed the CLA.

jit-ci · 2026-06-29T09:58:00Z

🛡️ Jit Security Scan Results

✅ No security findings were detected in this PR

^{Security scan by Jit}

cmilesb

I already mentioned it in our Slack DMs, but it doesn't seem like there's an easy way to keep the data/api file updated. Are we just going to replace the file every time the API get changed? We call the Swagger so that we can keep the docs up to date with what's actually deployed.

@paoloredis - Can you look at the updated workflow to make sure there isn't anything broken or weird?

paoloredis

What's the reason for merging the RDI API reference into the RC API reference?

cmilesb

@paoloredis This is specifically for the Redis Cloud RDI stuff, so it should go in the Redis Cloud API reference.

paoloredis · 2026-07-08T12:58:43Z

+            def enrich_rdi_workspace_docs:
+              .components.schemas.WorkspaceCreateRequest.description //= "Request to provision a data integration workspace for a Redis Cloud subscription."
+              | .components.schemas.WorkspaceCreateRequest.properties.cidr.description //= "CIDR block for the workspace deployment network."
+              | .components.schemas.WorkspacesResponse.description //= "Response containing data integration workspaces in the Redis Cloud account."
+              | .components.schemas.WorkspacesResponse.properties.workspaces.description //= "Data integration workspaces."
+              | .components.schemas.WorkspaceTasksResponse.description //= "Response containing asynchronous workspace tasks."
+              | .components.schemas.WorkspaceTasksResponse.properties.tasks.description //= "Workspace tasks."
+              | .components.schemas.WorkspaceTaskResponse.description //= "Asynchronous task created by a workspace operation."
+              | .components.schemas.WorkspaceTaskResponse.properties.taskId.description //= "Workspace task ID."
+              | .components.schemas.WorkspaceTaskResponse.properties.commandType.description //= "Workspace operation that created the task."
+              | .components.schemas.WorkspaceTaskResponse.properties.status.description //= "Current task status."
+              | .components.schemas.WorkspaceTaskResponse.properties.description.description //= "Human-readable task status or failure details."
+              | .components.schemas.WorkspaceTaskResponse.properties.timestamp.description //= "Time when the task status was recorded."
+              | .components.schemas.WorkspaceTaskResponse.properties.response.description //= "Task result payload. Completed workspace tasks can include the current workspace response."
+              | .components.schemas.WorkspaceTaskResponse.properties._links.description //= "Links to the task and affected workspace resource."
+              | .components.schemas.TaskLinks.description //= "Links related to a workspace task."
+              | .components.schemas.TaskLinks.properties.task.description //= "Link to the workspace task."
+              | .components.schemas.TaskLinks.properties.resource.description //= "Link to the affected workspace resource."
+              | .components.schemas.TaskLink.description //= "Hypermedia link."
+              | .components.schemas.TaskLink.properties.href.description //= "Link URL."
+              | .components.schemas.TaskLink.properties.type.description //= "Linked resource type."
+              | .components.schemas.WorkspaceResponse.description //= "Current data integration workspace state for a subscription."
+              | .components.schemas.WorkspaceResponse.properties.subscriptionId.description //= "Redis Cloud subscription ID."
+              | .components.schemas.WorkspaceResponse.properties.bdbId.description //= "Redis database ID associated with the workspace."
+              | .components.schemas.WorkspaceResponse.properties.rcpClusterId.description //= "RCP cluster ID that hosts workspace resources."
+              | .components.schemas.WorkspaceResponse.properties.region.description //= "Cloud provider region where the workspace is deployed."
+              | .components.schemas.WorkspaceResponse.properties.vpcId.description //= "VPC ID used by the workspace."
+              | .components.schemas.WorkspaceResponse.properties.createdAt.description //= "Time when the workspace record was created."
+              | .components.schemas.WorkspaceResponse.properties.infrastructure.description //= "Provisioned infrastructure state and connection details."
+              | .components.schemas.WorkspaceResponse.properties.capabilities.description //= "Workspace features available in the current state."
+              | .components.schemas.InfrastructureResponse.description //= "Provisioned infrastructure state for a data integration workspace."
+              | .components.schemas.InfrastructureResponse.properties.state.description //= "Workspace infrastructure state."
+              | .components.schemas.InfrastructureResponse.properties.cidr.description //= "CIDR block assigned to the workspace deployment network."
+              | .components.schemas.InfrastructureResponse.properties.timestamps.description //= "Infrastructure lifecycle timestamps."
+              | .components.schemas.InfrastructureResponse.properties.iam.description //= "IAM values used by workspace integrations."
+              | .components.schemas.InfrastructureResponse.properties.networking.description //= "Workspace networking outputs."
+              | .components.schemas.InfrastructureResponse.properties.monitoring.description //= "Workspace monitoring endpoints."
+              | .components.schemas.InfrastructureResponse.properties.error.description //= "Infrastructure error details when the workspace is in a failed state."
+              | .components.schemas.InfrastructureTimestamps.description //= "Workspace infrastructure lifecycle timestamps."
+              | .components.schemas.InfrastructureTimestamps.properties.startedAt.description //= "Time when infrastructure provisioning started."
+              | .components.schemas.InfrastructureTimestamps.properties.updatedAt.description //= "Time when infrastructure state was last updated."
+              | .components.schemas.InfrastructureIam.description //= "IAM values produced for workspace integrations."
+              | .components.schemas.InfrastructureIam.properties.privateLinkAllowedPrincipal.description //= "AWS principal allowed to connect to the workspace PrivateLink endpoint service."
+              | .components.schemas.InfrastructureIam.properties.secretsRoleArn.description //= "AWS IAM role ARN used to read workspace secrets."
+              | .components.schemas.NetworkingOutput.description //= "Workspace networking outputs."
+              | .components.schemas.NetworkingOutput.properties.egressIps.description //= "Outbound IP addresses used by workspace components."
+              | .components.schemas.NetworkingOutput.properties.availabilityZones.description //= "Availability zones used by workspace infrastructure."
+              | .components.schemas.MonitoringOutput.description //= "Workspace monitoring outputs."
+              | .components.schemas.MonitoringOutput.properties.metricsUrls.description //= "Metrics endpoint URLs for workspace components."
+              | .components.schemas.MetricsUrls.description //= "Metrics endpoint URLs for RDI workspace components."
+              | .components.schemas.MetricsUrls.properties.rdiOperatorUrl.description //= "Metrics endpoint URL for the RDI operator."
+              | .components.schemas.MetricsUrls.properties.rdiProcessorUrl.description //= "Metrics endpoint URL for the RDI processor."
+              | .components.schemas.MetricsUrls.properties.collectorSourceUrls.description //= "Metrics endpoint URLs for deployed collector sources, keyed by source name."
+              | .components.schemas.InfrastructureError.description //= "Infrastructure failure details."
+              | .components.schemas.InfrastructureError.properties.code.description //= "Machine-readable error code."
+              | .components.schemas.InfrastructureError.properties.message.description //= "Human-readable error message."
+              | .components.schemas.InfrastructureError.properties.timestamp.description //= "Time when the error was recorded."
+              | .components.schemas.InfrastructureError.properties.details.description //= "Additional structured error details."
+              | .components.schemas.Capabilities.description //= "Workspace capabilities available in the current state."
+              | .components.schemas.Capabilities.properties.validateSecrets.description //= "Whether the workspace can validate secret ARNs."
+              | .components.schemas.Capabilities.properties.validatePrivateLink.description //= "Whether the workspace can validate PrivateLink endpoint service names."
+              | .components.schemas.Capabilities.properties.readyForPipeline.description //= "Whether the workspace is ready to create and deploy RDI pipelines."
+              | .components.schemas.Capabilities.properties.createPrivateLink.description //= "Whether the workspace can create PrivateLink endpoints.";


Why is all of this stuff added here and is not part of the rdi json file in the first place?

The goal was that CAPI exposes functionality not just of the cloud database but all applications as well. So for example, the RDI API is accessible under the CAPI Pro subscriptions path, so on one side it makes sense to document the RDI API in the same place.

If you think we should separate the docs reference, we can also discuss that approach.

TBH I don't have a strong opinion.

ZdravkoDonev-redis mentioned this pull request Jun 29, 2026

RDSC-5669 Publish RDI Cloud API reference #3561

Closed

ZdravkoDonev-redis self-assigned this Jul 1, 2026

ZdravkoDonev-redis added the rdi label Jul 1, 2026

ZdravkoDonev-redis added 3 commits July 2, 2026 09:01

RDSC-5669 publish RDI Cloud API reference

3c25bf9

RDSC-5669 refresh RDI API reference

8c0a01d

RDSC-5669 merge RDI API into Cloud reference

be6f28d

ZdravkoDonev-redis force-pushed the rdsc-5669-rdi-capi-docs branch from a347f6b to be6f28d Compare July 2, 2026 06:05

ZdravkoDonev-redis marked this pull request as ready for review July 2, 2026 06:11

ZdravkoDonev-redis added 6 commits July 2, 2026 09:15

RDSC-5669 link Cloud RDI docs to API reference

86d3d10

RDSC-5669 move RDI API links to contextual pages

40737bc

RDSC-5669 add RDI pipeline payload example

26e52a3

RDSC-5669 refresh RDI API reference

5125139

RDSC-5669 document RDI workspace schemas

f3a46cb

RDSC-5669 make RDI API reference reproducible

58a3a8b

ZdravkoDonev-redis requested a review from cmilesb July 3, 2026 05:37

cmilesb requested changes Jul 6, 2026

View reviewed changes

cmilesb requested a review from paoloredis July 6, 2026 18:36

RDSC-5669 fetch RDI OpenAPI from docs endpoint

63e664e

paoloredis requested changes Jul 7, 2026

View reviewed changes

cmilesb approved these changes Jul 7, 2026

View reviewed changes

paoloredis reviewed Jul 8, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

RDSC-5669 Publish RDI Cloud API reference#3562

RDSC-5669 Publish RDI Cloud API reference#3562
ZdravkoDonev-redis wants to merge 10 commits into
mainfrom
rdsc-5669-rdi-capi-docs

ZdravkoDonev-redis commented Jun 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 29, 2026 •

edited

Loading

Uh oh!

CLAassistant commented Jun 29, 2026 •

edited

Loading

Uh oh!

jit-ci Bot commented Jun 29, 2026

Uh oh!

cmilesb left a comment

Uh oh!

paoloredis left a comment •

edited

Loading

Uh oh!

cmilesb left a comment

Uh oh!

paoloredis Jul 8, 2026

Uh oh!

ZdravkoDonev-redis Jul 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

ZdravkoDonev-redis commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Jira

Replaces

Validation

Uh oh!

github-actions Bot commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jit-ci Bot commented Jun 29, 2026

🛡️ Jit Security Scan Results

Uh oh!

cmilesb left a comment

Choose a reason for hiding this comment

Uh oh!

paoloredis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cmilesb left a comment

Choose a reason for hiding this comment

Uh oh!

paoloredis Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

ZdravkoDonev-redis Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ZdravkoDonev-redis commented Jun 29, 2026 •

edited

Loading

github-actions Bot commented Jun 29, 2026 •

edited

Loading

CLAassistant commented Jun 29, 2026 •

edited

Loading

paoloredis left a comment •

edited

Loading