Skip to content

Conversation

@vaurdan
Copy link
Contributor

@vaurdan vaurdan commented Sep 27, 2024

Description

This PR applies the suggestions that have been added to both #2731 and #2735

#2731

  • Changed the REST API description fields to be more descriptive of what they meant to do.

#2735

  • Converted get_endpoint_name and get_route_prefix to static methods
  • Replaced editor-sidebar and dashboard-widget strings with the correct call to the static get_endpoint_name method.

Motivation and context

How has this been tested?

Tested locally and validated that the tests still passing.

@vaurdan vaurdan added the Maintenance & Fixes Ticket/PR related to codebase maintenance tasks label Sep 27, 2024
@vaurdan vaurdan added this to the 3.17.0 milestone Sep 27, 2024
@vaurdan vaurdan self-assigned this Sep 27, 2024
@vaurdan vaurdan requested a review from a team as a code owner September 27, 2024 17:05
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (4)
  • develop
  • add/.*
  • fix/.*
  • update/.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vaurdan
Copy link
Contributor Author

vaurdan commented Oct 2, 2024

@acicovic added one last commit that was not pushed by mistake. Care to take a quick look before merging?

Copy link
Collaborator

@acicovic acicovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@vaurdan vaurdan merged commit 3e1efb7 into refactor/internal-api Oct 2, 2024
@vaurdan vaurdan deleted the refactor/internal-api-fixes branch October 2, 2024 12:59
@vaurdan vaurdan linked an issue Oct 25, 2024 that may be closed by this pull request
vaurdan added a commit that referenced this pull request Oct 25, 2024
* Add new Rest API base classes

* Implement the Content Helper API namespace

* Add tests for the new REST API classes

* Update UI providers to use the new API endpoints

* Remove unused code and initializations

* Fix sonarcloud issues

* Refactor to avoid consts and use getters instead

* Fix minor docblock issues per code review

* Apply code review suggestions by @acicovic

* Rename API parameter `content` to `text`

* Add `stats` endpoint

* Update the UI to use the new API endpoints

* Delete the old endpoints

* Add tests

* Apply code review suggestions by @acicovic

* Add `stats` endpoint

* Update the UI to use the new API endpoints

* Delete the old endpoints

* Add tests

* Fix E2E test

* Add `settings` endpoints

* Update UI to use the new settings API

* Add tests

* Remove old code

* Improve comments and whitespace

* class-base-endpoint.php: Fix incorrect whitespace

* Endpoints/class-base-endpoint.php: Fix incorrect whitespace

* Improve comments and whitespace

* Improve comments and whitespace

* REST API Refactor: Apply fixes/suggestions from the other PRs (#2812)

* Apply suggestions from #2731

* Apply suggestions from #2735

* Add dynamic settings endpoint calls

* PCH Refactor: Refactor the external services (#2873)

* Implement the new Content API service, and remove old RemoteAPI code

* Implement caching mechanism for service endpoints

* Implement the Suggestions API service

* Address PHPCS & PHPStan errors and warnings

* Fix post-merge issues and namespaces

* Add condition when validate api credentials returns false.

* Address code review feedback

* Adjust some DocBlocks and whitespace

* Make the services base URL static, and remove the old consts

* Fix PHPStan (not including tests)

* Fix misplaced `@since` tag

---------

Co-authored-by: Alex Cicovic <23142906+acicovic@users.noreply.github.com>

* PCH Refactor: Update integration tests (#2885)

* Implement and update integration tests

* Adjust some DocBlocks and whitespace

* Adjust some DocBlocks and whitespace

* Fix tests

* Fix leaking tests

* Apply code review suggestions

* Remove backticks from function summary

* Improve code formatting consistency between 2 tests

---------

Co-authored-by: Alex Cicovic <23142906+acicovic@users.noreply.github.com>

* Rebuild assets

---------

Co-authored-by: Alex Cicovic <23142906+acicovic@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintenance & Fixes Ticket/PR related to codebase maintenance tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor all endpoints code

3 participants