Add module name to description in OAS files #8694

[alhambrav]

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

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

Summary by CodeRabbit

• Documentation
  • Standardized and expanded API endpoint descriptions across access token, tenant, profile, authentication, and monitoring endpoints by converting single-line descriptions to multi-line format and prefixing with module information ("Module: Profile").
  • Preserved existing behavior; one endpoint description was corrected for clarity.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e89b96fe-b2cb-4e66-a7e0-f365ac8ac568

📥 Commits

Reviewing files that changed from the base of the PR and between 0b39877 and cf3eef1.

📒 Files selected for processing (1)

• api/src/main/api/profile-api.yaml

✅ Files skipped from review due to trivial changes (1)

• api/src/main/api/profile-api.yaml

---

Walkthrough

This PR standardizes OpenAPI operation descriptions in the Profile API by converting single-line descriptions to multi-line block scalars and prefixing them with "Module: Profile
" across access token, tenant, profile, authentication, and monitoring endpoints.

Changes

OpenAPI Profile API Documentation Formatting

Layer / File(s)	Summary
Access Token operation descriptions api/src/main/api/profile-api.yaml	Access token create, get, get-all, and delete operation descriptions are reformatted to multi-line markdown blocks and prefixed with "Module: Profile ".
Tenant operation descriptions api/src/main/api/profile-api.yaml	Tenant create, get, update, delete, count, get-all, verify_new_profiles, and roles add/remove operations descriptions are updated to block scalar format with module prefix.
Profile operation descriptions api/src/main/api/profile-api.yaml	Profile attribute definition management, profile CRUD, role/attribute operations, password/verification flows, and attachment operations descriptions are converted to multi-line markdown blocks with module prefix.
Authentication operation descriptions api/src/main/api/profile-api.yaml	Authenticate, ticket, and persistent login create/get/refresh/delete operations descriptions are reformatted to block scalar format with module prefix.
Monitoring operation descriptions api/src/main/api/profile-api.yaml	Memory, status, and version monitoring operations descriptions are updated to multi-line block scalar format with module prefix.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

• craftercms/profile#280: Both PRs modify the same OpenAPI specification file by converting and standardizing operation descriptions with the Module: Profile <br> prefix across multiple endpoints.

Suggested reviewers

• sumerjabri

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding module names to descriptions in OpenAPI Specification (OAS) files, with a reference to the issue number.
Description check	✅ Passed	The description matches the required template and includes both a ticket reference (#8694) and context about the changes, though it could be more detailed about the implementation.
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.}

[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 `@api/src/main/api/profile-api.yaml`:
- Around line 889-891: Fix the grammatical error in the OpenAPI operation
description under the Profile module: update the description string that
currently reads "Removes the given roles to the specified tenant." to "Removes
the given roles from the specified tenant." Make the change in the description
block that starts with "Module: Profile" so the operation wording correctly
reflects removal of roles from a tenant.
- Around line 2841-2843: Fix the grammatical error in the OpenAPI description
for the Profile module by changing the phrase "Upload a attachment to the
specified profile." to "Upload an attachment to the specified profile." — locate
the description block in api/src/main/api/profile-api.yaml (the Profile module
description string shown in the diff) and update that sentence while keeping the
rest of the multi-line description intact.

🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4270bd90-6818-455b-9460-576c3d477ff3

📥 Commits

Reviewing files that changed from the base of the PR and between a9aa401 and 0b39877.

📒 Files selected for processing (1)

• api/src/main/api/profile-api.yaml