Fix readme

[VirajSalaka]

Purpose

Explain why this feature or fix is required. Describe the underlying problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

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

Summary by CodeRabbit

• Documentation
  • Updated storage type configuration documentation to clarify supported options.

[coderabbitai]

Walkthrough

The README documentation for the gateway-controller was updated to reflect the supported storage types, removing memory from the inline comment and keeping only sqlite and postgres as documented configuration options.

Changes

Cohort / File(s)	Summary
Documentation Update gateway/gateway-controller/README.md	Removed memory from the storage.type options comment, leaving "sqlite" and "postgres" as the documented supported values.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📝 A tiny doc tweak, so neat and so small,

Memory's removed from the storage hall,

Now sqlite and postgres shine bright,

The documentation is perfectly right! 🐰✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is an unfilled template with placeholder text and no actual implementation details, goals, or rationale provided for the README change.	Fill in the template sections with specific details about why the memory option was removed, what the change achieves, and how it was implemented.
Title check	❓ Inconclusive	The title 'Fix readme' is vague and generic, using non-descriptive language that doesn't convey what specific aspect of the README was fixed.	Replace with a more specific title describing the change, e.g., 'Remove memory option from storage.type documentation' or 'Update storage configuration options in README'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
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.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@gateway/gateway-controller/README.md`:
- Line 100: README still lists "memory" as a supported storage type which
conflicts with the code (factory/validation only accept "sqlite" and
"postgres"); remove all remaining `memory` references and example blocks that
show `type: memory` (update the examples under storage, the config examples list
that mentions `config-memory-only.yaml`, and any code sample lines at the noted
locations) and replace with the correct supported types or a note that only
`sqlite` and `postgres` are supported so the docs match the behavior of the
storage factory/validation.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fe83e2a8-f17c-4a35-9cc2-da81213b0984

📥 Commits

Reviewing files that changed from the base of the PR and between 9f931fb and a581117.

📒 Files selected for processing (1)

• gateway/gateway-controller/README.md

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Remove remaining memory references to keep storage docs consistent.

Line 100 is correct, but the README still documents memory as supported (Line 146, Lines 205-211, Line 258). That conflicts with actual validation/factory behavior (sqlite/postgres only) and will mislead users into invalid configs.

Suggested README cleanup

-# Set storage type to memory
-export APIP_GW_GATEWAY__CONTROLLER_STORAGE_TYPE=memory
-
-#### Memory-Only Mode
-No persistent storage (useful for testing):
-
-```yaml
-storage:
-  type: memory
-```
-
-See `config/` directory for examples:
-- `config.yaml` - Default production configuration
-- `config-memory-only.yaml` - Testing/development configuration
+See `config/` directory for examples:
+- `config.yaml` - Default production configuration

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@gateway/gateway-controller/README.md` at line 100, README still lists
"memory" as a supported storage type which conflicts with the code
(factory/validation only accept "sqlite" and "postgres"); remove all remaining
`memory` references and example blocks that show `type: memory` (update the
examples under storage, the config examples list that mentions
`config-memory-only.yaml`, and any code sample lines at the noted locations) and
replace with the correct supported types or a note that only `sqlite` and
`postgres` are supported so the docs match the behavior of the storage
factory/validation.