Update Code to Match GetDocuments API Request Specifications

[kokodak]

What this PR does / why we need it:

This PR updates the code to comply with the GetDocuments API request specifications, due to the request specification for the GetDocuments API in Admin Server has changed through yorkie-team/yorkie#931.

Which issue(s) this PR fixes:

Fixes #240

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• New Features
  • Introduced an option to exclude snapshots in document requests, enhancing performance and data handling.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

The recent changes to the WorkspaceDocumentsService class enhance the API request for retrieving documents by introducing a new property, include_snapshot. This property allows clients to specify whether snapshots should be included in the request, defaulting to false. This enhancement aligns with updates in the Admin Server's API specification, ensuring better performance and more precise data handling.

Changes

Files	Change Summary
backend/src/workspace-documents/workspace-documents.service.ts	Added include_snapshot property to the API request body, defaulting to false, for better control over snapshot inclusion.

Assessment against linked issues

Objective	Addressed	Explanation
Update GetDocuments API request specification (###240)	✅

🐰 In the fields where shadows play,
A new option hops into the fray.
include_snapshot, set to false,
Keeps our requests light, not morose.
With seamless ties, our code will flow,
As we chase documents, to and fro! 🌼

---

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cd36e26 and 418d106.

Files selected for processing (1)

• backend/src/workspace-documents/workspace-documents.service.ts (1 hunks)

Additional comments not posted (1)

backend/src/workspace-documents/workspace-documents.service.ts (1)

176-176: Verify the correctness of the new property include_snapshot.

The addition of the include_snapshot property to the request body aligns with the updated API specifications. Ensure that this property is correctly handled by the Yorkie API.

[devleejb]

Thank you for your contribution.