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]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 131477c3-70bf-401f-9d7e-0b46651b30b7

📥 Commits

Reviewing files that changed from the base of the PR and between 44d505e and 77c4e9d.

📒 Files selected for processing (1)

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

---

Summary by CodeRabbit

• Documentation
  • Updated API endpoint descriptions with improved formatting and module identification across multiple profile-related routes.

Walkthrough

This PR updates endpoint descriptions in the Profile API OpenAPI specification (profile-api.yaml) from single-line text to multiline block-scalar format. All descriptions are consistently reformatted with a Module: Profile <br> prefix and HTML line breaks for improved readability, affecting access token, tenant, profile, authentication, and monitoring endpoints across the specification.

Changes

Profile API Endpoint Documentation Standardization

Layer / File(s)	Summary
Access Token Endpoint Descriptions api/src/main/api/profile-api.yaml	Access token operation descriptions are converted to block-scalar format with Module: Profile <br> prefix and <br> line breaks for consistent formatting.
Tenant Operations Endpoint Descriptions api/src/main/api/profile-api.yaml	Tenant CRUD, role, and attribute endpoint descriptions are standardized to block-scalar multiline format across create, read, update, delete, role management, and attribute management operations.
Profile Operations Endpoint Descriptions api/src/main/api/profile-api.yaml	Profile management, query, password, verification token, and attachment endpoint descriptions are converted to block-scalar format, covering CRUD, enable/disable, role/attribute manipulation, and query operations.
Authentication, Persistent Login, and Monitoring Endpoint Descriptions api/src/main/api/profile-api.yaml	Authentication, persistent login, and system monitoring endpoint descriptions are standardized to block-scalar multiline format with consistent Module: Profile prefix and <br> formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• craftercms/profile#279: Both PRs modify the same OpenAPI file api/src/main/api/profile-api.yaml, updating endpoint description formatting and API versioning at the specification level.

Suggested reviewers

• sumerjabri

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely summarizes the main change: adding module information to description fields in the OpenAPI specification file.
Description check	✅ Passed	The description includes the required ticket reference (#8694) and explains what's in the PR, meeting the template requirements.
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.}