Skip to content

Conversation

Copy link

Copilot AI commented Nov 11, 2025

Purpose

Resolves issue regarding invalid Redocly CDN URL across all product API documentation pages preventing Redoc library from loading.

Goals

Update all API documentation files to use the current Redocly CDN URL for proper rendering of OpenAPI specifications.

Approach

Replaced deprecated jsDelivr URL with official Redocly CDN across 7 API documentation files:

  • Old: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js
  • New: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js

Files updated:

  • Admin API v4
  • DevPortal API v3
  • Governance API v1
  • DevOps API v0
  • Publisher API v4
  • Gateway API v2
  • Service Catalog API v1

User stories

N/A - Infrastructure fix for documentation rendering

Release note

Fixed broken Redoc library loading in API reference documentation by updating CDN URL to current official source.

Documentation

N/A - This PR fixes the documentation infrastructure itself. No additional documentation required.

Training

N/A - No training content impact

Certification

N/A - Documentation infrastructure change only, no product functionality affected

Marketing

N/A - Internal documentation fix

Automation tests

N/A - Markdown documentation changes only

Security checks

Samples

N/A

Related PRs

This fix should be applied to all active version branches (3.1.0, 3.2.0, 4.0.0, 4.1.0, 4.2.0, 4.3.0, 4.4.0, 4.5.0, 4.6.0) as noted in the issue.

Migrations (if applicable)

N/A

Test environment

N/A - Documentation URL update only

Learning

Referenced official Redoc documentation at https://github.com/Redocly/redoc for current CDN URL.

Original prompt

This section details on the original issue you should resolve

<issue_title>Outdated Redocly Url</issue_title>
<issue_description>### Description

In all the branches, the redocly url provided is invalid now. New URL has to be used instead.

Suggested Fix

Replace the current URL with the latest

Version(s)

3.1.0, 3.2.0, 4.0.0, 4.1.0, 4.2.0, 4.3.0, 4.4.0, 4.5.0, 4.6.0</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@coderabbitai
Copy link

coderabbitai bot commented Nov 11, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI changed the title [WIP] Fix outdated Redocly URL in all branches Fix outdated Redocly CDN URL in API documentation Nov 11, 2025
Copilot finished work on behalf of CrowleyRajapakse November 11, 2025 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants