REST API Refactor: Settings namespace implementation

[vaurdan]

Description

This PR is part of the effort described in #2426, and implements the settings endpoint, which is related with specific plugin settings, such as the dashboard widget settings, and the editor sidebar settings.

The endpoint implement both a /settings/{setting}/get and a /settings/{setting}/set method, but the main endpoint - /settings/{setting}/can be used as well, by changing the HTTP verb - GET to retrieve the settings and PUT/POST to update the settings.

Here's the overview of the implemented API endpoints:

/wp-parsely/v2
  ├── /settings
  │   ├── /dashboard-widget
  │   │   ├── /get
  │   │   └── /set
  │   └── /editor-sidebar
  │       ├── /get
  │       └── /set

The old tests have been migrated to new Endpoints testing, and new tests have been implemented when needed.

The UI was also updated to use these new endpoints, with all the code related with the older endpoints being removed as well.

** Note: since this work as based on the refactor/internal-api-stats branch, this PR is using that branch as the base. However, once that branch is merged (in #2734), the PR should auto-rebase to refactor/internal-api.

Motivation and context

• Implement the work described in Refactor all endpoints code #2426
• Improve the reliability of the codebase, and make it easier to maintain and improve upon.

How has this been tested?

I have validated locally that all the features using the /settings endpoint are still working as expected, and added new integration tests to test all the new classes functionalities.

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

[acicovic]

Thank you for your work! Approving and merging this!