Fix header name and curl command example #10297
Conversation
Corrected header name from 'MTSL_Header_name' to 'MTLS_Header_name' and fixed a typo in the example curl command.
|
|
WalkthroughDocumentation edits: fixed MTLS header name and an Accept header typo; replaced internal link/image references with HTTPS-hosted assets; merged and reworded steps in the REST API creation guide. No code or runtime behavior changed. Changes
Sequence Diagram(s)(Changes are documentation-only and do not modify control flow; no sequence diagram provided.) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (3)
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. Comment |
Updated links in the documentation to use absolute URLs instead of relative paths for images and resources.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md(9 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md
48-48: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (2)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md (2)
3-3: Internal anchor link is correctly formatted and resolvable.The verification confirms that the relative path
../../../get-started/apim-architecture/#api-publishercorrectly resolves to the target fileen/docs/get-started/apim-architecture.mdand theapi-publisheranchor exists within it. No issues found.
3-3: All external image URLs are accessible and functioning correctly.Verification confirms all 15 image URLs migrated to
https://apim.docs.wso2.com/en/latest/assets/img/return HTTP 200 responses. No broken links or inaccessible resources detected.
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md
Outdated
Show resolved
Hide resolved
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md(8 hunks)
🔇 Additional comments (3)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md (3)
46-47: ✓ Accessibility improvement applied.The
altattribute has been properly added to the image element, addressing the prior WCAG accessibility requirement. The alt text "Click Basic Info button location" is descriptive and appropriate.
1-1:⚠️ PR objective mismatch—expected file content not found.The PR description states the objective is to fix a header name from 'MTSL_Header_name' to 'MTLS_Header_name' and correct a curl command typo. However, this file contains no MTLS header references or curl command examples. The AI-generated summary indicates these changes are in "a separate file within this PR." Confirm that the correct files were provided for review, as the MTLS header and curl command fixes appear to be in different documentation.
32-32: The original review comment is incorrect—mixed URL reference types are intentional and appropriate.The file correctly uses:
- Absolute HTTPS URLs for images and assets (lines 46–47, 163–164, 172–173)
- {{base_path}} template syntax for internal documentation links (line 55)
These serve distinct purposes: images require absolute URLs for external static file hosting, while internal navigation links use templates for deployment flexibility. This pattern is standard practice and confirmed by the project's header documentation, which also uses
{{base_path}}. No changes are needed.Likely an incorrect or invalid review comment.
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md
Outdated
Show resolved
Hide resolved
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md(7 hunks)
🔇 Additional comments (6)
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md (6)
19-20: Step consolidation is correct.The combined step "Select REST API from the options available and click Start from Scratch" correctly reflects the WSO2 API Manager UI flow as a single step 2, addressing prior review concerns.
29-29: Image links successfully normalized to external HTTPS URLs with accessibility fixes.All image references have been converted to external stable URLs (https://apim.docs.wso2.com/en/latest/assets/img/...), improving portability. Alt text has been properly added to images on lines 44, 161, and 170. This addresses the prior accessibility compliance concern (MD045).
Also applies to: 35-35, 39-39, 43-44, 48-48, 90-90, 102-102, 108-108, 112-112, 116-116, 125-125, 129-129, 146-146, 160-161, 169-170
11-11: Sign-in endpoint is correct.Line 11 correctly shows
https://localhost:9443/publisheras the Publisher entry URL, addressing the prior endpoint verification concern.
31-31: Step numbering is correct and sequential.All step numbers (4 through 8) are properly sequenced following the consolidated steps 1–3, maintaining logical flow.
Also applies to: 41-41, 84-84, 96-96, 140-140
76-76: Version management guidance is clear.The rewording on line 76 improves clarity on creating new API versions while keeping previous versions as default, enhancing the instructional value.
1-175: File scope note: MTLS and curl command fixes mentioned in PR objectives not present in this file.The PR description references fixes to MTLS header names and curl command typos; however, this file contains only REST API creation documentation updates (link normalization, image asset hosting, step restructuring). Per the AI summary, these security-related fixes appear to be in
en/docs/manage-apis/design/api-security/api-authentication/securing-apis-using-certificate-bound-access-tokens.md, which is not included in the current review.Confirm whether the security documentation file should also be reviewed as part of this PR.
en/docs/manage-apis/design/create-api/create-rest-api/create-a-rest-api.md
Outdated
Show resolved
Hide resolved
2 participants
Corrected header name from 'MTSL_Header_name' to 'MTLS_Header_name' and fixed a typo in the example curl command.
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit