Add module to description in OAS file #8694

[alhambrav]

Ticket reference or full description of what's in the PR

Add module to description in OAS file craftercms/craftercms#8694
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

[coderabbitai]

Warning

Review limit reached

@alhambrav, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 28 minutes and 45 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5bcfd105-cff2-4001-a24e-5bf6cd91388f

📥 Commits

Reviewing files that changed from the base of the PR and between 1eb2563 and 2171dab.

📒 Files selected for processing (1)

• server/src/main/api/social-api.yaml

Walkthrough

This PR standardizes OpenAPI endpoint descriptions across the Social API specification file by prepending a consistent Module: Social <br> label to operation descriptions and converting them to multi-line YAML blocks. The pattern is applied uniformly across all social endpoints spanning security actions, context management, comment operations, voting, attachments, subscriptions, monitoring, and error responses.

Changes

Social API Endpoint Documentation

Layer / File(s)	Summary
System Actions and Context Management server/src/main/api/social-api.yaml	Security action endpoints ("Get Current Actions", "Update Actions") and context/profile management endpoints ("Create/Get/Modify Social Context", "Get/Update Email Configuration", "Get/Update/Delete Context Preferences") updated with module labeling in multi-line description format.
Comment Operations and Management server/src/main/api/social-api.yaml	Cache clearing and comment CRUD/search/attribute endpoints, plus moderation and flagging operations ("Create/Update/Delete Comment", "Search Comments", "Update Comment Attributes", "Get/Delete Comment Flags", "Moderate Comment", "Get Comments By Moderation Status", "Get Flagged Comments") converted to multi-line descriptions with module labeling.
Voting, Attachments, and Subscriptions server/src/main/api/social-api.yaml	Attachment management endpoints ("Get/Create/Delete Attachment", "Get Attachment Content", "Update Attachment Content"), voting endpoints ("Vote Up", "Vote Down", "Remove Votes"), thread operations ("Get Thread Comments", "Get Comment Children"), and subscription endpoints ("Subscribe", "Update Subscription", "Unsubscribe") updated with standardized module labeling.
Monitoring and Error Response Documentation server/src/main/api/social-api.yaml	Monitoring endpoints ("Get Memory Stats", "Get Status", "Get Version") descriptions updated with module labeling; InternalServerError example text adjusted on a single line.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• sumerjabri

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding module information to descriptions in the OpenAPI Specification file, with a direct reference to the related issue.
Description check	✅ Passed	The description includes the required template section with ticket reference (issue #8694) and explains the change, though it could provide slightly more detail about the scope or impact.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[alhambrav]

@CodeRabbit review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@server/src/main/api/social-api.yaml`:
- Around line 1645-1647: The description for the endpoint is inconsistent with
its operation (summary/operationId indicate deletion of comment attributes);
update the YAML description under the operation (referencing the operationId and
the summary for this path) to state that it deletes/removes the specified
comment attributes rather than "Updates the attributes" so the description
accurately reflects the delete behavior.
- Around line 2608-2612: The OpenAPI operation block has inconsistent metadata:
the summary says "Update Attachment Content", description says "Deletes a given
attachment", and the operationId is incorrectly set to deleteAttachmentP
(duplicate). Update the operation block so summary and description both describe
the update action, and rename operationId to a unique, descriptive identifier
like updateAttachmentContent or updateAttachmentContentP to reflect the update
operation (ensure it does not duplicate deleteAttachmentP or any other
operationId).

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: af7ab650-e6f9-42a1-ad70-762bf03088b4

📥 Commits

Reviewing files that changed from the base of the PR and between f0c06dc and 1eb2563.

📒 Files selected for processing (1)

• server/src/main/api/social-api.yaml