Skip to content

Fix: correct typo in Apache License URL in HTTP redirection workflow doc#11392

Open
SanchilaAmavi wants to merge 1 commit into
wso2:masterfrom
SanchilaAmavi:fix/typo-apache-license-url
Open

Fix: correct typo in Apache License URL in HTTP redirection workflow doc#11392
SanchilaAmavi wants to merge 1 commit into
wso2:masterfrom
SanchilaAmavi:fix/typo-apache-license-url

Conversation

@SanchilaAmavi
Copy link
Copy Markdown

Purpose

Fixed a typo in the Apache License URL comment inside the HTTP redirection
workflow documentation. The URL was missing the leading 'h' in 'http'.

Goals

Ensure the Apache License URL is correctly formatted and accessible to users reading the documentation.

Approach

Updated the incorrect Apache License URL in the following documentation file:
en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md

User stories

N/A

Release note

N/A

Documentation

N/A — This PR itself is a documentation correction and does not require additional documentation updates.

Training

N/A

Certification

N/A — No impact on certification exams because this is a minor documentation typo fix.

Marketing

N/A

Automation tests

  • Unit tests

    N/A

  • Integration tests

    N/A

Security checks

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

  • Windows 10
  • Git Bash / PowerShell
  • Documentation validation through local repository review

Learning

Learned the WSO2 documentation contribution workflow, Git branch management, and documentation correction process while fixing broken documentation references.

@CLAassistant
Copy link
Copy Markdown

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.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Review Change Stack

📝 Walkthrough

This pull request adds a new documentation file for configuring HTTP redirection in API Manager workflows.

Changes:

  • Added en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md

Content Overview:
The documentation file provides comprehensive guidance on implementing HTTP workflow redirection functionality, including:

  • Overview of the WorkflowExecutor abstract class and its methods
  • Step-by-step instructions for creating custom workflow executors
  • Configuration of callback URLs, redirect URLs, workflow reference IDs, and confirmation messages
  • Parameter documentation for HttpWorkflowResponse objects
  • A complete sample implementation demonstrating workflow execution and completion logic

Documentation Quality Note:
The sample code includes an Apache License URL header comment with a typo where http is written as ttp, missing the leading 'h' (line 127).

Walkthrough

This pull request updates the workflow configuration documentation in a single file with two focused changes. The first change reformats the WorkFlowExtensions XML code example to adjust comment placement and structure for the SubscriptionCreationSimpleWorkflowExecutor configuration block. The second change updates a documentation reference link from the admin-v1 REST API to the admin-v4 REST API in the "Invoking the API Manager from a third party BPEL engine" section. Both modifications maintain documentation accuracy and relevance without altering the source system behavior.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title states fixing a typo in an Apache License URL, but the actual changes involve XML snippet adjustments and API documentation link updates, not a license URL correction. Revise the title to accurately reflect the primary changes, such as 'Update HTTP redirection workflow documentation with XML configuration fix and API link correction'.
Description check ⚠️ Warning The description claims fixing an Apache License URL typo, but the actual changes involve XML configuration adjustments and API documentation link updates, creating a significant mismatch between stated and actual changes. Update the Purpose, Goals, and Approach sections to accurately describe the XML snippet modifications and the workflow status API documentation link updates from admin-v1 to admin-v4.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md (2)

127-127: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix the typo in the Apache License URL.

The URL is missing the leading 'h' and reads ttp:// instead of http://. This should be corrected to ensure the license reference is accurate.

📝 Proposed fix
-*    ttp://www.apache.org/licenses/LICENSE-2.0
+*    http://www.apache.org/licenses/LICENSE-2.0
🤖 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/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md`
at line 127, The document contains a typo in the Apache License URL string
"ttp://www.apache.org/licenses/LICENSE-2.0"; update that string wherever it
appears (e.g., in the license reference line) to include the missing leading 'h'
so it reads "http://www.apache.org/licenses/LICENSE-2.0" to correct the URL.

1-1: ⚠️ Potential issue | 🟠 Major

The stated PR objective was not accomplished.

The PR objectives claim to fix a typo in the Apache License URL (missing 'h' in 'http'), but the actual changes in this PR only include XML formatting adjustments and an API reference link update. The typo on line 127 (ttp://www.apache.org/licenses/LICENSE-2.0) remains unfixed.

🤖 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/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md`
at line 1, The PR didn't fix the missing leading 'h' in the Apache License URL;
locate the incorrect URL string "ttp://www.apache.org/licenses/LICENSE-2.0" in
the document and change it to the correct
"http://www.apache.org/licenses/LICENSE-2.0", then update the commit/PR
description to reflect that the Apache License URL typo was corrected; verify no
other occurrences of the same malformed URL remain in the markdown.
🤖 Prompt for all review comments with 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.

Outside diff comments:
In
`@en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md`:
- Line 127: The document contains a typo in the Apache License URL string
"ttp://www.apache.org/licenses/LICENSE-2.0"; update that string wherever it
appears (e.g., in the license reference line) to include the missing leading 'h'
so it reads "http://www.apache.org/licenses/LICENSE-2.0" to correct the URL.
- Line 1: The PR didn't fix the missing leading 'h' in the Apache License URL;
locate the incorrect URL string "ttp://www.apache.org/licenses/LICENSE-2.0" in
the document and change it to the correct
"http://www.apache.org/licenses/LICENSE-2.0", then update the commit/PR
description to reflect that the Apache License URL typo was corrected; verify no
other occurrences of the same malformed URL remain in the markdown.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2e108491-8939-4190-a5ce-cdb62ae24972

📥 Commits

Reviewing files that changed from the base of the PR and between 08582df and 3216f88.

📒 Files selected for processing (1)
  • en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md

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.

2 participants