Add module name to description in OAS file #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
  • Updated OpenAPI specification documentation throughout the Deployer API module by adding module identification metadata to multiple endpoint operations including target management (create, get, delete, deploy operations), deployment query endpoints, unlock/recreate/duplicate operations, and monitoring endpoints. Request body example documentation was also enhanced 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: 21ef8054-51b4-4715-bcfc-e37fcaa1267d

📥 Commits

Reviewing files that changed from the base of the PR and between 5710f61 and 4c9549b.

📒 Files selected for processing (1)

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

---

Walkthrough

The OpenAPI specification file adds module identification descriptions to all Deployer API operations across target management, deployment queries, and monitoring endpoints. No request/response schemas, parameters, or operation identifiers are modified.

Changes

OpenAPI Deployer module documentation

Layer / File(s)	Summary
Target creation operation and examples src/main/api/deployer-api.yaml	POST /api/1/target/create operation and its request body examples receive description: "Module: Deployer" metadata.
Target retrieval and deployment queries src/main/api/deployer-api.yaml	GET /api/1/target/get, get-all, and deployment query endpoints receive module description at the operation level.
Target mutation and lifecycle operations src/main/api/deployer-api.yaml	POST /api/1/target/delete, delete-if-exists, deploy, deploy-all, unlock, recreate, and duplicate endpoints receive module description metadata.
Monitoring and health check endpoints src/main/api/deployer-api.yaml	GET /api/1/monitoring/version, status, and memory endpoints receive module description at the operation level.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• craftercms/deployer#541: Both PRs modify the same OpenAPI operations and request body examples to add/standardize description: "Module: Deployer" fields.

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 name descriptions to the OpenAPI Specification file, with a reference to the issue number.
Description check	✅ Passed	The description includes the required ticket reference (issue #8694) and explains what's in the PR (adding module name to description fields in OAS file).
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.}