Update compliance_status value descriptions

[i7an]

Motivation

Provide detailed description for each compliance status to make it easier to finish the compliance process.

Changes

• Added descriptions

Images and GIFs

Summary by CodeRabbit

• Documentation
  • Expanded API documentation for domain compliance status with a detailed description of the verification workflow and meanings for each status.
  • Added and clarified status values (including pending_cc, compliant, non_compliant, suspended) and adjusted status ordering for clearer interpretation.

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated the OpenAPI schema for components/schemas/SendingDomain → compliance_status: added a multi-line description detailing compliance states and updated the enum to include pending_cc and reorder existing values.

Changes

Cohort / File(s)	Summary
OpenAPI Schema specs/email-sending.openapi.yml	Added a detailed multi-line description for components/schemas/SendingDomain → compliance_status. Updated the enum to include pending_cc and reordered values (compliant, non_compliant, suspended, exhausted).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through YAML, tidy and quick,
Added a note and a new status pick,
States neatly ordered, clear to see,
Domains behaving, happy as me,
Nibbles of docs — a tiny rewrite trick!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete and does not follow the required template structure. While motivation is provided, the 'How to test' section is missing entirely, and 'Changes' lacks detailed specificity.	Complete the description by: (1) filling in the 'How to test' section with specific test cases, (2) expanding 'Changes' with detailed bullet points of what was modified, and (3) removing placeholder template content from 'Images and GIFs'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: updating compliance_status field descriptions in the OpenAPI schema.
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.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch compliance-status-descriptions

---

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