Update compliance statuses

[i7an]

Motivation

Compliance statuses should be updated to be more self-explanatory.

• https://github.com/railsware/falcon/pull/9964
• https://github.com/railsware/falcon/pull/9976
• Update compliance statuses #27 👈
• https://github.com/railsware/falcon/pull/9977

Changes

• Actualised the list of compliance statuses

Summary by CodeRabbit

• Updates
  • Sending domain compliance status labels have been updated with new, clearer terminology that better represents the domain verification process
  • Previous status values have been replaced with improved options that more accurately describe each stage of the compliance verification workflow
  • The "under review" compliance status now operates with automatic processing, replacing the previous manual review approach for faster user feedback

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated the OpenAPI schema enum values for SendingDomain.compliance_status by removing initial, pending, pending_cc, and exhausted while adding demo_exhausted, awaiting_questionnaire, and awaiting_card_verification. Also redefined under_review semantics.

Changes

Cohort / File(s)	Summary
OpenAPI Schema Update specs/email-sending.openapi.yml	Modified components.schemas.SendingDomain.compliance_status enum: replaced initial, pending, pending_cc, exhausted with demo_exhausted, awaiting_questionnaire, awaiting_card_verification, and updated under_review description from manual to automatic review.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Update compliance_status value descriptions #25 — Modifies the same components.schemas.SendingDomain.compliance_status enum field with overlapping enum value and description changes.

Suggested reviewers

• IgorDobryn
• VladimirTaytor
• DagonWat
• piobeny

Poem

🐰 Statuses hop and dance anew,
Old pathways fade, fresh ones emerge,
From pending dreams to queues in view,
The schema bounds with vibrant surge! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete. It lacks a 'How to test' section and the 'Images and GIFs' section, which are specified in the repository's description template.	Add 'How to test' section with testing steps and 'Images and GIFs' section showing before/after comparisons as specified in the template.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Update compliance statuses' directly and clearly summarizes the main change, which is updating the compliance status values 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 update-compliance-statuses

---

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

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

specs/email-sending.openapi.yml (1)

1517-1543: ⚠️ Potential issue | 🔴 Critical

Update the enum to match the new status vocabulary.

The description now documents demo_exhausted, awaiting_questionnaire, and awaiting_card_verification, but the schema enum still exposes initial, pending, pending_cc, and exhausted. That leaves the contract internally inconsistent and can make generated clients or validators reject valid API responses carrying the new statuses.

Suggested enum update

           enum:
-            - initial
-            - unverified_dns
             - demo
+            - demo_exhausted
+            - unverified_dns
             - missing_company_info
-            - pending
-            - pending_cc
             - under_review
-            - compliant
+            - awaiting_questionnaire
+            - awaiting_card_verification
             - non_compliant
+            - compliant
             - suspended
-            - exhausted

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@specs/email-sending.openapi.yml` around lines 1517 - 1543, The enum for the
sending domain compliance status is out of sync with the human-readable
description: update the schema enum (the values listed under the "enum" for the
sending domain status) to remove obsolete values initial, pending, pending_cc,
and exhausted and add the new statuses demo_exhausted, awaiting_questionnaire,
and awaiting_card_verification so the enum matches the documented description
text and produced client validators accept responses using the new status
vocabulary.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@specs/email-sending.openapi.yml`:
- Around line 1517-1543: The enum for the sending domain compliance status is
out of sync with the human-readable description: update the schema enum (the
values listed under the "enum" for the sending domain status) to remove obsolete
values initial, pending, pending_cc, and exhausted and add the new statuses
demo_exhausted, awaiting_questionnaire, and awaiting_card_verification so the
enum matches the documented description text and produced client validators
accept responses using the new status vocabulary.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2089080e-fb8a-4d35-954e-41514089787a

📥 Commits

Reviewing files that changed from the base of the PR and between 8cbe777 and 821b33c.

📒 Files selected for processing (1)

• specs/email-sending.openapi.yml