Skip to content

chore: renamed JACKSON_API_KEYS to API_KEYS#2513

Open
deepakprabhakara wants to merge 2 commits intomasterfrom
polis/api-keys
Open

chore: renamed JACKSON_API_KEYS to API_KEYS#2513
deepakprabhakara wants to merge 2 commits intomasterfrom
polis/api-keys

Conversation

@deepakprabhakara
Copy link
Copy Markdown
Contributor

@deepakprabhakara deepakprabhakara commented Apr 16, 2026

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

Summary by CodeRabbit

  • Documentation
    • Updated deployment guides to use the new API key environment variable name across examples and quickstart instructions.
    • Added a deprecation notice for the legacy API key variable; existing configurations remain supported while encouraging migration to the new name.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: de6923cf-3d4f-49a7-87c4-d907270d3d58

📥 Commits

Reviewing files that changed from the base of the PR and between 5abad45 and d42168f.

📒 Files selected for processing (1)
  • docs/polis/deploy/env-variables.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/polis/deploy/env-variables.mdx

📝 Walkthrough

Walkthrough

Documentation updated to rename the API key environment variable from JACKSON_API_KEYS to API_KEYS across deployment guides and Docker quickstart examples. A deprecation note was added stating JACKSON_API_KEYS remains supported but is deprecated.

Changes

Cohort / File(s) Summary
Environment Variable Documentation
docs/polis/deploy/env-variables.mdx, docs/polis/guides/service.mdx
Replaced JACKSON_API_KEYS with API_KEYS in headings, examples, and Docker docker run command samples; added deprecation notice for JACKSON_API_KEYS.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is entirely a template with no actual content filled in. All sections remain as template comments with no substantive information about why the change is being made or its impact. Provide a meaningful description explaining the purpose of the rename (e.g., API standardization), note that this includes a deprecation period for backward compatibility, and clarify any impact on users or deployment configurations.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: renaming the environment variable from JACKSON_API_KEYS to API_KEYS across documentation files.
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
  • Commit unit tests in branch polis/api-keys

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.

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 `@docs/polis/deploy/env-variables.mdx`:
- Around line 46-50: The phrase "comma separated" in the "### API_KEYS" section
should be hyphenated to "comma-separated"; update the text under the API_KEYS
heading (the sentence describing the list of API keys) to use "comma-separated"
so the compound adjective is grammatically correct while keeping the rest of the
example ("API_KEYS=key1,key2,key3") unchanged.
🪄 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 Plus

Run ID: 5d003a4d-b0a8-452c-aef0-3301d1c8f077

📥 Commits

Reviewing files that changed from the base of the PR and between 8daf6aa and 5abad45.

📒 Files selected for processing (2)
  • docs/polis/deploy/env-variables.mdx
  • docs/polis/guides/service.mdx

Comment thread docs/polis/deploy/env-variables.mdx
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