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

[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 17 minutes and 4 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: d5f135da-60e2-42c0-b1b3-7e1a509dd6c4

📥 Commits

Reviewing files that changed from the base of the PR and between da6f038 and f75d24a.

📒 Files selected for processing (1)

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

Walkthrough

This PR updates OpenAPI endpoint descriptions across the Engine API specification by standardizing them with a "Module: Engine
" prefix and reformatting single-line descriptions into multiline YAML literal blocks. No functional API contracts, schemas, parameters, or operation IDs were modified—only description text formatting.

Changes

Engine API Documentation Formatting

Layer / File(s)	Summary
Endpoint description formatting and module prefixes src/main/api/engine-api.yaml	Reformatted description fields for 23 Engine API endpoints across site context, content store, navigation, search, GraphQL, monitoring, and component endpoints. Each description is converted to a YAML multiline literal block and prepended with "Module: Engine ", with existing HTML markup preserved.

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 summarizes the main change: adding module information to OpenAPI specification file descriptions.
Description check	✅ Passed	The description includes the required template section with ticket reference and a clear link to the related issue.
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

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

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: 1

🤖 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 `@src/main/api/engine-api.yaml`:
- Around line 1603-1605: The endpoint description currently says "Returns the
Crafter Engine JVM status details" but this operation actually returns
version/build/runtime metadata for the Engine; update the description block for
the version API in src/main/api/engine-api.yaml (the "Module: Engine" / version
operation description) to replace the JVM/status wording with a concise
description such as "Returns Crafter Engine version, build and runtime metadata"
(or equivalent) so generated API docs accurately reflect the response contents.

🪄 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: 823e073e-1d0f-4650-bf88-06a95ac01a29

📥 Commits

Reviewing files that changed from the base of the PR and between 8eab427 and da6f038.

📒 Files selected for processing (1)

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