i18n(ko-KR): create `restapi.mdx` by jsparkdev · Pull Request #92 · withstudiocms/docs

jsparkdev · 2025-04-18T13:48:27Z

Description

create restapi.mdx

Summary by CodeRabbit

Documentation
- Added a new Korean-language guide detailing the StudioCMS REST API, including authentication methods and descriptions of public and protected endpoints.

coderabbitai · 2025-04-18T13:48:36Z

Walkthrough

A new documentation file, restapi.mdx, has been introduced in the Korean documentation section. This file provides an overview of the StudioCMS REST API, including its purpose, authentication via API tokens, and a categorization of available API endpoints into public and protected groups. The document specifies endpoint paths, their access requirements, and the type of data they return, serving as a comprehensive reference for interacting with StudioCMS content programmatically.

Changes

File(s)	Change Summary
src/content/docs/ko/how-it-works/restapi.mdx	Added a new Korean documentation file detailing StudioCMS REST API overview, authentication, and endpoints.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    User ->> Documentation: Accesses REST API docs
    Documentation ->> User: Provides API overview, authentication, endpoint details
    User ->> Documentation: Reads public/protected endpoint info
    Documentation ->> User: Returns endpoint paths and usage instructions

Possibly related PRs

i18n(ko-KR): create sdk.mdx #89: Adds Korean documentation for the StudioCMS SDK, including REST API token management, which complements the REST API usage documentation provided in this PR.

Suggested reviewers

Adammatthiesen

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

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.

❤️ 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 generate docstrings to generate docstrings for this 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.

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.

studiocms-no-reply · 2025-04-18T13:48:51Z

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File	Note
ko/how-it-works/restapi.mdx	Localization added, will be marked as complete.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/content/docs/ko/how-it-works/restapi.mdx (3)
1-7: Align frontmatter indentation.

In the YAML frontmatter, the order under sidebar is indented by 3 spaces. For consistency and adherence to typical YAML style, it’s better to use 2 spaces:
 sidebar:
-   order: 4
+  order: 4
15-18: Clarify UI label translation.

The term "API Tokens" is in English within Korean text. If that’s the exact dashboard label, you may want to wrap it in backticks or add a Korean translation in parentheses for clarity, e.g.:
사용자 프로필의 `API Tokens`(API 토큰) 섹션에서…
32-42: Document HTTP verbs for protected endpoints.

For the protected endpoints list, you’ve enumerated the paths but haven’t specified which HTTP methods each supports. To make this reference more actionable, consider adding the allowed verbs (e.g., GET, POST, PUT, DELETE) next to each endpoint.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~34-~34: Loose punctuation mark.
Context: ... - /studiocms_api/rest/v1/folders/: StudioCMS 콘텐츠 트리의 모든 폴더 목록을 제공합니다. - **...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...*/studiocms_api/rest/v1/folders/[id]**: StudioCMS 콘텐츠 트리의 특정 폴더에 대한 세부 정보를 제공합니...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...다. - /studiocms_api/rest/v1/pages/: StudioCMS 콘텐츠 트리의 모든 페이지 목록을 제공합니다. - *...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... /studiocms_api/rest/v1/pages/[id]: StudioCMS 콘텐츠 트리의 특정 페이지에 대한 세부 정보를 제공합...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...iocms_api/rest/v1/pages/[id]/history/`**: StudioCMS 콘텐츠 트리의 특정 페이지의 모든 변경 이력 항목 목...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...s_api/rest/v1/pages/[id]/history/[id]`**: StudioCMS 콘텐츠 트리의 특정 페이지 변경 이력 항목에 대한 세...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...- /studiocms_api/rest/v1/settings/: 현재 프로젝트의 StudioCMS 설정을 제공합니다. - **`/stu...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...다. - /studiocms_api/rest/v1/users/: StudioCMS 프로젝트의 모든 사용자 목록을 제공합니다. - **`...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~42-~42: Loose punctuation mark.
Context: ... /studiocms_api/rest/v1/users/[id]: StudioCMS 프로젝트의 특정 사용자에 대한 세부 정보를 제공합니다...

(UNLIKELY_OPENING_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f18827c and 6ba69df.

📒 Files selected for processing (1)

src/content/docs/ko/how-it-works/restapi.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

src/content/docs/ko/how-it-works/restapi.mdx

[uncategorized] ~27-~27: Loose punctuation mark.
Context: ...studiocms_api/rest/v1/public/folders/`**: StudioCMS 콘텐츠 트리의 모든 공개 폴더 목록을 제공합니다. -...