fixes production / staging URLs - #955
Conversation
WalkthroughThe pull request updates the URL endpoints in both the production and staging configuration files by replacing the old API URLs with new ones for asynchronous requests. Additionally, it amends the README to include a link for generating API keys under the Jira Integration section. These modifications adjust the application's connectivity settings and enhance the documentation without affecting other configurations. Changes
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Coverage Report
File CoverageNo changed files found. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
readme.md (1)
152-153: Enhance documentation clarity in the Jira Integration section.The newly added link for generating API keys is a useful addition that assists users with Jira authentication. It would be beneficial to include a short note explaining when and why to use this link, to provide extra context and improve user guidance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
config/production.yaml(1 hunks)config/staging.yaml(1 hunks)readme.md(1 hunks)
🔇 Additional comments (2)
config/staging.yaml (1)
13-13: Update Staging URL Endpoint.The staging URL has been updated to
https://submit.staging.planning.data.gov.uk/, which aligns with the new endpoint conventions. Please verify that this new endpoint fulfils all integration requirements and that any related environment variables or settings expect this format.config/production.yaml (1)
13-14:Details
❓ Verification inconclusive
Review Production URL Configuration Scope.
The production configuration now includes a new top-level
urlkey set tohttps://submit.planning.data.gov.uk/. However, theasyncRequestApiblock still retains its original URL. Please confirm whether the intention is to override the asynchronous API endpoint by introducing a separate top-level URL, or if the update should be applied directly within theasyncRequestApiblock to avoid potential confusion.
Production URL Configuration Clarification
The production configuration now sets a new top-level
urlkey (https://submit.planning.data.gov.uk/), yet theasyncRequestApiblock still specifies its original URL. Could you please confirm whether this is intentional—i.e. maintaining separate endpoints—or if the asynchronous API’s URL should also be updated to reflect the new production endpoint? This clarification will help avoid any potential confusion in the configuration.
Preview Link
https://submit-pr-[PR_NUMBER].herokuapp.com/
What type of PR is this? (check all applicable)
Description
Please replace this line with a brief description of the changes made.
Related Tickets & Documents
QA Instructions, Screenshots, Recordings
Before
Before screenshot here
After
After screenshot here
Added/updated tests?
We encourage you to keep the code coverage percentage at 80% and above.
QA sign off
[optional] Are there any post-deployment tasks we need to perform?
[optional] Are there any dependencies on other PRs or Work?
Summary by CodeRabbit