MT-20454: Restructure batch endpoints

[mklocek]

Motivation

So that it's not required to select server for Batch sending in API docs, and so that it's consistent with Sandbox Batch API docs.

Changes

• Restructure batch endpoints (move transactional and bulk batch endpoints to respective specs)

How to test

• Both Transactional and Bulk API Sending pages should now have section about Batch endpoint.
• There should no longer be a separate Batch API page.
• (Optional) check related code samples.

Images and GIFs

None.

Summary by CodeRabbit

• New Features

  • Added batch email sending endpoint supporting up to 500 requests per operation, with detailed descriptions and multi-language code samples

• Revert

  • Removed the separate email-batch API specification documentation, consolidating batch email functionality into the primary API endpoints

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR consolidates batch email functionality by removing the standalone specs/email-batch.openapi.yml specification file and integrating its capabilities into the existing email-sending-bulk.openapi.yml and email-sending-transactional.openapi.yml files. Documentation references are updated accordingly.

Changes

Cohort / File(s)	Summary
Documentation cleanup CLAUDE.md, README.md, SUMMARY.md	Removed references to email-batch.openapi.yml from available specs table, spec listings, and generated overview documentation.
Batch spec consolidation specs/email-batch.openapi.yml	Entire OpenAPI 3.1.0 specification file deleted (556 lines), including /api/batch endpoint definition, request/response schemas, and reusable components.
Bulk email spec expansion specs/email-sending-bulk.openapi.yml	Added /api/batch POST endpoint with batch processing logic. Introduced 12 new public schemas: BatchEmail, BatchSentResponse, and Required variants of email field types (EmailSender, EmailSubject, EmailText, EmailHtml, TemplateUuid). Updated existing composite schemas (EmailWithText, EmailWithHtml, EmailWithTextAndHtml, EmailFromTemplate) to reference Required variants.
Transactional email spec expansion specs/email-sending-transactional.openapi.yml	Parallel changes to bulk spec: added /api/batch POST endpoint and 12 new public schemas with same types. Updated all composite email schemas to use Required field variants for consistency across the specification.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Updated imports and namings for Java SDK examples #6 — Modifies email batch and email-sending OpenAPI specs with overlapping schema and endpoint changes.
• MT-20326: Fix differences between old and new api docs #13 — Updates email sending specs (transactional/bulk) with batch endpoint additions and required-field variant schema shifts.
• Fix .NET code examples in OpenAPI specifications to align with mailtrap-dotnet SDK #9 — Edits the same email batch and email-sending specs with related client request shape and code example updates.

Suggested reviewers

• leonid-shevtsov
• IgorDobryn
• yanchuk

Poem

🐰 A batch of emails finds new home,
No longer specs that roam alone,
Consolidated with grace and care,
Bulk and transactional schemas share! 🐇✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'MT-20454: Restructure batch endpoints' accurately summarizes the main change: moving batch endpoints from a separate spec into their respective transactional and bulk specs.
Description check	✅ Passed	The pull request description includes all required sections with sufficient detail: motivation explains the goal, changes lists the main restructuring action, and testing steps are provided as checkboxes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

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.}