Add webbroker_apis table in schema.sql

[senthuran16]

Purpose

$Subject, continuation of #1992. Resolves #1975

Goals

Describe what solutions this feature or fix introduces to address the problems outlined above.

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI. Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Automation tests

• Unit tests

  Code coverage information

• Integration tests

  Details about the test cases and coverage

Security checks

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

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

[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: 5fdccf89-93f4-4540-9087-25aa62d58e7e

📥 Commits

Reviewing files that changed from the base of the PR and between bf0e4ea and 5fcc28c.

📒 Files selected for processing (1)

• platform-api/src/internal/database/schema.sql

---

📝 Walkthrough

Database Schema Enhancement

A new webbroker_apis table has been added to the database schema to support Web Broker API management within projects. The table structure includes:

• Primary identifier and project linkage: UUID-based primary key with a project UUID foreign key
• API metadata: Fields for description, lifecycle status (default: CREATED), transport configuration, and configuration details
• Referential integrity: Foreign key constraints linking to both the artifacts table (with cascade delete) and the projects table (with cascade delete)
• Performance optimization: An index on the project UUID field for efficient query performance

The new table follows the same structural pattern as the existing websub_apis table, providing consistency with other API type definitions in the platform.

Walkthrough

This PR adds a new webbroker_apis database table to the platform schema. The table mirrors the existing websub_apis pattern and includes columns for UUID identification, project association, transport configuration, lifecycle status, and metadata. Foreign key constraints enforce referential integrity with the artifacts and projects tables. A project-indexed query index is added to optimize lookups by project_uuid, establishing the foundational schema for web broker API persistence.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description follows the template structure but most sections contain only template placeholders without substantive information about goals, approach, testing, security, or samples.	Complete the empty sections with concrete details about the implementation approach, test coverage, security review, and other relevant information from the template.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: adding a webbroker_apis table to the database schema.
Linked Issues check	✅ Passed	The PR adds the webbroker_apis table as required by issue #1975 for Web Broker API creation platform API support, meeting the stated objective.
Out of Scope Changes check	✅ Passed	The changes are limited to adding the webbroker_apis table and index to the schema, which are directly aligned with the linked issue objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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

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