Conversation
acicovic
added
the
Maintenance & Fixes
📝 WalkthroughWalkthroughThe changes remove outdated API documentation links from class docblocks across multiple Suggestions API service and endpoint classes. The base URL in the Suggestions API service class is updated to a new domain. Additionally, a new HTTP header Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant SuggestionsAPIService
participant SuggestionsAPIBaseEndpoint
participant ExternalSuggestionsAPI
Client->>SuggestionsAPIService: get_base_url()
SuggestionsAPIService-->>Client: https://suggestions-api.parsely.com
Client->>SuggestionsAPIBaseEndpoint: get_request_options()
SuggestionsAPIBaseEndpoint-->>Client: Headers (Content-Type, X-INTERNAL-SERVICE)
Client->>ExternalSuggestionsAPI: API Request (with updated base URL and headers)
ExternalSuggestionsAPI-->>Client: API Response
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (7)
💤 Files with no reviewable changes (5)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (21)
✨ Finishing Touches
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
src/services/suggestions-api/endpoints/class-endpoint-suggest-brief.php (1)
20-20: Ensure docblock lines end with a period.
The@linkannotation should conclude with a trailing period to adhere to WordPress PHPDoc standards.src/services/suggestions-api/endpoints/class-endpoint-suggest-headline.php (1)
20-20: Ensure docblock lines end with a period.
The@linkannotation should conclude with a trailing period to adhere to WordPress PHPDoc standards.src/services/suggestions-api/endpoints/class-endpoint-suggest-inbound-links.php (1)
21-21: Ensure docblock lines end with a period.
The@linkannotation should conclude with a trailing period to adhere to WordPress PHPDoc standards.src/services/suggestions-api/endpoints/class-endpoint-suggest-linked-reference.php (1)
21-21: Ensure docblock lines end with a period.
The@linkannotation should conclude with a trailing period to adhere to WordPress PHPDoc standards.src/services/suggestions-api/endpoints/class-endpoint-suggest-inbound-link-positions.php (1)
22-22: Ensure docblock lines end with a period.
The@linkannotation should conclude with a trailing period to adhere to WordPress PHPDoc standards.src/services/suggestions-api/endpoints/class-suggestions-api-base-endpoint.php (2)
21-21: Ensure docblock consistency: Add trailing period to @link tag.Per WordPress coding standards, each annotation line should end with a period. Please append a period after the URL.
49-52: Document new internal service header.The
X-INTERNAL-SERVICE: content-helperheader enables internal routing. Consider updating theget_request_options()PHPDoc to mention this additional header for clarity.src/services/suggestions-api/class-suggestions-api-service.php (1)
22-22: Ensure docblock consistency: Add trailing period to @link tag.The
@linkannotation should conclude with a period to comply with PHPDoc conventions. Add a period at the end of the URL.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
src/services/suggestions-api/class-suggestions-api-service.php(2 hunks)src/services/suggestions-api/endpoints/class-endpoint-suggest-brief.php(1 hunks)src/services/suggestions-api/endpoints/class-endpoint-suggest-headline.php(1 hunks)src/services/suggestions-api/endpoints/class-endpoint-suggest-inbound-link-positions.php(1 hunks)src/services/suggestions-api/endpoints/class-endpoint-suggest-inbound-links.php(1 hunks)src/services/suggestions-api/endpoints/class-endpoint-suggest-linked-reference.php(1 hunks)src/services/suggestions-api/endpoints/class-suggestions-api-base-endpoint.php(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{html,php}`: "Perform a detailed review of the provided code with following key aspects in mind: - Review the HTML and PHP code to ensure it is well-structured and adheres ...
**/*.{html,php}: "Perform a detailed review of the provided code with following key aspects in mind:
- Review the HTML and PHP code to ensure it is well-structured and adheres to best practices.
- Ensure the code follows WordPress coding standards and is well-documented.
- Confirm the code is secure and free from vulnerabilities.
- Optimize the code for performance, removing any unnecessary elements.
- Validate comments for accuracy, currency, and adherence to WordPress coding standards.
- Ensure each line comment concludes with a period.
- Verify code compatibility with the latest version of WordPress, avoiding deprecated functions or features."
src/services/suggestions-api/endpoints/class-endpoint-suggest-linked-reference.phpsrc/services/suggestions-api/endpoints/class-endpoint-suggest-inbound-links.phpsrc/services/suggestions-api/endpoints/class-endpoint-suggest-headline.phpsrc/services/suggestions-api/endpoints/class-endpoint-suggest-brief.phpsrc/services/suggestions-api/endpoints/class-suggestions-api-base-endpoint.phpsrc/services/suggestions-api/endpoints/class-endpoint-suggest-inbound-link-positions.phpsrc/services/suggestions-api/class-suggestions-api-service.php
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: E2E against WordPress latest
🔇 Additional comments (1)
src/services/suggestions-api/class-suggestions-api-service.php (1)
39-39:Details
✅ Verification successful
Verify removal of old API endpoints.
The updated
get_base_url()aligns with the new domain. Please confirm there are no lingering references to the oldcontent-suggestions-api.parsely.netby running:
🏁 Script executed:
#!/bin/bash # Search for any remaining references to the old suggestions API URL. rg -n 'content-suggestions-api\.parsely\.net'Length of output: 47
No lingering references to the old API domain found
I ran a repository-wide search for
content-suggestions-api.parsely.netand confirmed there are zero matches. The update tohttps://suggestions-api.parsely.comis consistent across the codebase. No further changes needed.
alecgeatches
left a comment
alecgeatches
left a comment
There was a problem hiding this comment.
Tested Traffic Boost with a post with no prior suggestions, and also by manually adding a post via the "+ Add Source Post" button. Both work, seems all good!
|
@alecgeatches, thanks for the additional testing! |
2 participants
Description
With this PR, we're migrating to the new Suggestions API URL inside our codebase.
How has this been tested?
Manually checked that the affected features still work as expected.
Summary by CodeRabbit
Documentation
New Features
Bug Fixes