Add missing step for publishing API in the Developer Portal

[ShenalSen]

Purpose

Adds the missing API publishing step in the reusable include file (create-publish-api.md) that is referenced across multiple API authentication and security documentation pages. This resolves a critical workflow gap where users complete the deployment steps but cannot see their API in the Developer Portal because the publishing step is not documented in this foundational sub-step template.

Goals

Complete the foundational API creation workflow in the shared include file by adding the API publishing step, which will automatically improve documentation consistency across all pages that reference this template. Ensure that users following any API authentication tutorial (API keys, OAuth2, mutual SSL, etc.) understand that both deployment and publishing are required steps before an API becomes available in the Developer Portal for subscription and testing.

Approach

Issue Identified:
While reviewing the "Secure APIs with API Keys" documentation, I discovered that only documented the deployment steps but omitted the critical publishing step in the lifecycle management. For new users unfamiliar with WSO2 APIM workflows, this creates confusion:

1. Users follow the steps to create, configure API key security, and deploy the API to the gateway
2. Users then try to find the API in the Developer Portal to test subscription and key generation
3. The API doesn't appear because it hasn't been published to the Developer Portal yet
4. Users are left wondering where the API is or what step they missed

Solution Implemented:
Added Step 6 to the create-publish-api.md include file with clear instructions about publishing the API:

• Explicitly states that the API must be published to the Developer Portal
• Directs users to the Lifecycle section in the Publisher
• Explains that publishing makes the API visible to subscribers
• Bridges the gap between deployment and Developer Portal visibility

User stories

• As a new APIM user following the API key authentication tutorial, I want to understand all required steps to make my API available for subscription so that I can successfully test API key generation and invocation
• As a developer deploying my first API with API-bound keys, I need clear guidance on the complete workflow so that I don't miss critical steps between deployment and testing in the Developer Portal

Release note

Enhanced "Create publish api" documentation to include explicit instructions for publishing the API to the Developer Portal after deployment, clarifying the complete workflow and preventing user confusion when APIs don't appear in the Developer Portal.

Documentation

Modified: /en/docs/includes/design/create-publish-api.md

The include file is referenced in:

• /en/docs/api-security/runtime/api-authentication/secure-apis-using-api-keys.md (Step 1)

This change will automatically propagate to all documentation pages that reference this include file, ensuring consistent guidance across the documentation.

Training

N/A - This is a documentation clarification that aligns with existing training content

Certification

N/A - This change does not introduce new features or alter existing functionality; it clarifies existing processes in the documentation.

Marketing

N/A - This is an internal documentation improvement for user guidance

Automation tests

• Unit tests

  N/A - Documentation change only

• Integration tests

  N/A - Documentation change only

Security checks

• Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? N/A (Documentation)
• Ran FindSecurityBugs plugin and verified report? N/A (Documentation)
• Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? Yes

Samples

N/A - No code samples added; documentation clarification only

Related PRs

None

Migrations (if applicable)

N/A - No migration steps required

Test environment

Documentation review and validation across all browsers and devices. Content verified for accuracy against WSO2 API Manager 4.7.0+ behavior.

Learning

During the documentation review process, I identified a common onboarding friction point where new users were confused about why their newly created and deployed API wasn't visible in the Developer Portal. Through research of user feedback and APIM workflow documentation, I determined that the missing explicit publishing step in the include file was the root cause. The solution adds a clear, concise step that bridges the deployment and Developer Portal visibility gap, improving the overall user experience for API Manager newcomers.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d7bf9e31-1f6b-4ee5-9aef-03711cb63258

📥 Commits

Reviewing files that changed from the base of the PR and between 14aca26 and 1206496.

📒 Files selected for processing (1)

• en/docs/includes/design/create-publish-api.md

---

📝 Walkthrough

Overview

Adds a missing instruction step to the shared API creation include file to ensure users complete the API publishing workflow after deployment.

Changes

• File modified: en/docs/includes/design/create-publish-api.md
• Change: Added Step 6 instructing users to publish the API from the Publisher's Lifecycle section
• Impact: Clarifies that publishing is required to make the API visible to subscribers in the Developer Portal

Details

The include file is referenced by multiple API security and authentication documentation pages. The addition ensures users understand the complete workflow: after deploying an API, they must also publish it through the Lifecycle section for it to become available in the Developer Portal to end users.

Scope

• Lines changed: +2/-0
• Affects documentation pages covering API authentication methods (API Keys, OAuth2, mutual SSL, etc.)
• Validated against WSO2 API Manager 4.7.0+ behavior

Walkthrough

This change adds a sixth step to API publication documentation. The new instruction directs users to publish an API from the Lifecycle section, clarifying that this action makes the API available in the Developer Portal and enables subscribers to access it following publication. The update consists of two lines added to the guide without modifications to existing content.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change—adding a missing publishing step to API documentation.
Description check	✅ Passed	The description comprehensively addresses all relevant template sections with clear purpose, goals, approach, and justification for a documentation change.
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

• X
• Mastodon
• Reddit
• LinkedIn

_{Review rate limit: 0/1 reviews remaining, refill in 60 minutes.}

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