Skip to content

Fix prototype-api docs path issues after structure update #11391

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.

Sign up for GitHub

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

Closed
PabasaraIlankoon wants to merge 5 commits into from
+9 −9
Closed

Fix prototype-api docs path issues after structure update #11391

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8b12ca2
Fix broken image paths in backend-url-prototype-api.md
PabasaraIlankoon May 20, 2026
fefbd7c
Remove accidentally created pip3 file
PabasaraIlankoon May 20, 2026
bba2d8c
update
PabasaraIlankoon May 20, 2026
5eca952
test commit
PabasaraIlankoon May 20, 2026
be9cb1a
remove test file
PabasaraIlankoon May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/docs/administer/advanced-configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section covers how to change and configure several features related to the

1. Change the relevant configuration accordingly and click **Save**.

<a href="{{base_path}}/assets/img/administer/advanced-config-save.png"><img src="{{base_path}}/assets/img/administer/advanced-config-save.png"/></a>
<a href="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"><img src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/></a>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 20, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add alt text for the image.

Line 16 image markup is missing an alt attribute. Please add concise alt text for accessibility.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 16-16: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@en/docs/administer/advanced-configurations.md` at line 16, The image tag in
en/docs/administer/advanced-configurations.md (<img
src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/>)
is missing an alt attribute; add a concise alt text such as alt="Advanced
configurations save dialog screenshot" to the <img> element so the anchor's
image has accessible descriptive text.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix the image URL to a resolvable docs path.

Line 16 uses a placeholder host and a malformed path (.../learn/.../assets/...), so this screenshot link will not render correctly in published docs. Use the same path pattern already used in this file (for example, {{base_path}}/assets/img/administer/advanced-config-save.png) for both href and src.

Proposed fix 
-    <a href="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"><img src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/></a>
+    <a href="{{base_path}}/assets/img/administer/advanced-config-save.png"><img src="{{base_path}}/assets/img/administer/advanced-config-save.png" alt="Advanced configuration save action"/></a>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<a href="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"><img src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/></a>
<a href="{{base_path}}/assets/img/administer/advanced-config-save.png"><img src="{{base_path}}/assets/img/administer/advanced-config-save.png" alt="Advanced configuration save action"/></a>
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 16-16: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@en/docs/administer/advanced-configurations.md` at line 16, Replace the
placeholder/malformed image URL in the anchor and img tag (the href and src in
the existing <a> and <img> elements referencing advanced-config-save.png) with
the resolvable docs path using the same pattern used elsewhere in this file: use
{{base_path}}/assets/img/administer/advanced-config-save.png for both href and
src so the screenshot renders correctly.


??? tip "Setting custom Linter rules"
You can add your custom rules in JSON with the key “LinterCustomRules”.
Expand Down
6 changes: 3 additions & 3 deletions en/docs/ai-gateway/ai-backend-security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The first step is to obtain an **API Key** from the AI Service Provider you sele

You can do so for OpenAI by following the steps mentioned below:

1. Login to OpenAI and go to <a href='https://platform.openai.com/api-keys'>OpenAI Dashboard.</a>
1. Login to OpenAI and go to [OpenAI Dashboard](https://platform.openai.com/api-keys)
2. Navigate to **API keys** section from the left menu. Then, click on **Create new secret key**. Provide a name for the key and click on **Create secret key**.

[![Get OpenAI API Key]({{base_path}}/assets/img/learn/ai-gateway/openai-api-key-generation.png){: style="width:90%"}]({{base_path}}/assets/img/learn/ai-gateway/openai-api-key-generation.png)
Expand All @@ -20,7 +20,7 @@ You can do so for OpenAI by following the steps mentioned below:
2. Notice the **API Key Required** warning against the `Default Production Endpoint` and `Default Sandbox Endpoint`. Click on **Edit** icon and fill in the API Key value which you obtained from Step 1 above and click on **Update** to save the changes.

!!! Note
API Manager supports below AI Service Providers by default. The authorization approach of each is mentioned below:
API Manager supports below AI Service Providers by default.The authorization approach for each provider is listed below.:
- **Anthropic**: `x-api-key` header
- **AWSBedrock**: Requires both an AWS Access Key and AWS Secret Key for authentication.
- **AzureAIFoundry**: `api-key` header
Expand All @@ -29,6 +29,6 @@ You can do so for OpenAI by following the steps mentioned below:
- **MistralAI**: `Authorization` header
- **OpenAI**: `Authorization` header

Note that we prepend "Bearer " to the header value that you provide when it comes to MistralAI and OpenAI since they are expecting an Authorization header.
Note that We prepend "Bearer " to the header value. that you provide when it comes to MistralAI and OpenAI since they are expecting an Authorization header.

[![API Key Configuration]({{base_path}}/assets/img/learn/ai-gateway/ai-api-configure-backend-security.png){: style="width:90%"}]({{base_path}}/assets/img/learn/ai-gateway/ai-api-configure-backend-security.png)
6 changes: 3 additions & 3 deletions en/docs/includes/design/deploy-revision.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Follow the instructions below to deploy a new revision for an API:

The Deployments page appears as follows when you do not have any existing revisions.

[![New revision](../../../../assets/img/design/revision/deploy-first-revision.png){: style="width:80%"}](../../../../assets/img/design/revision/deploy-first-revision.png)
[![New revision](../../../assets/img/design/revision/deploy-first-revision.png){: style="width:80%"}](../../../assets/img/design/revision/deploy-first-revision.png)

The Deployments page appears as follows when you have at least one revision.

Expand All @@ -25,12 +25,12 @@ Follow the instructions below to deploy a new revision for an API:
!!! warning
You cannot deploy more than 5 revisions. If you want to deploy a new revision after the maximum allowed number of revisions are reached, you need to delete one of the existing revisions.

[![Delete revision if max count is reached](../../../../assets/img/design/revision/delete-and-deploy-revision.png){: style="width:60%"}](../../../../assets/img/design/revision/delete-and-deploy-revision.png)
[![Delete revision if max count is reached](../../../assets/img/design/revision/delete-and-deploy-revision.png){: style="width:60%"}](../../../assets/img/design/revision/delete-and-deploy-revision.png)

4. Optionally, provide a description for the revision.
5. Select the API Gateways in which you want to deploy the API.
6. Click **Deploy**.
!!! note
If your API is deployed successfully to the Gateways, the deployment status will be updated in the status column. You can view more information by hovering over the deployment status icon.

[![Deployment status acknowledgement](../../../../assets/img/design/revision/revision-deployment-acknowledgement.png)](../../../../assets/img/design/revision/revision-deployment-acknowledgement.png)
[![Deployment status acknowledgement](../../../assets/img/design/revision/revision-deployment-acknowledgement.png)](../../../assets/img/design/revision/revision-deployment-acknowledgement.png)
4 changes: 2 additions & 2 deletions en/docs/includes/design/invoke-prerelease-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ Once deployed to the Gateway, you can [test the REST type APIs via the Publisher

2. Select the required Business Plans and click **Save**.

[![Select Prototype API Business Plans](../../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png)](../../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png)
[![Select Prototype API Business Plans](../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png)](../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png)

Follow the instructions below to publish the API to the Developer Portal as a Prototype:

1. Navigate to the **Lifecycle** page listed under **Publish**.

For both options, **When creating an API with the Mock Implementation** and **When creating an API with an actual backend URL**, you will have the option to either promote your API to the **PRE-RELEASED** state or to the **PUBLISHED** state in the API lifecycle.

[![Publish as Pre-Released API when using backend URL](../../../../assets/img/learn/prototype-api/backend-url-lifecycle.png)](../../../../assets/img/learn/prototype-api/backend-url-lifecycle.png)
[![Publish as Pre-Released API when using backend URL](../../../assets/img/learn/prototype-api/backend-url-lifecycle.png)](../../../assets/img/learn/prototype-api/backend-url-lifecycle.png)

2. Click **Pre-Release** to publish the API as a Prototype API to the Developer Portal.