Skip to content

Rename Email API/SMTP to Email Live Sending in descriptions - #68

Open
izikaj wants to merge 3 commits into
mainfrom
reapply-live-sending-rename
Open

izikaj wants to merge 3 commits into
mainfrom
reapply-live-sending-rename

Conversation

@izikaj

@izikaj izikaj commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

This applies the rename from #64 again. #67 rolled it back because the app did not show the new product name yet.

Merge this PR when the app shows "Email Live Sending", not before. The spec goes live on docs.mailtrap.io as soon as it merges. Merge it together with mailtrap/mailtrap-docs#14.

The first commit is a revert of #67. The later commits rename three mentions that #64 did not change.

Changes

The same changes as #64:

  • account-management.openapi.yml, "Get current billing cycle usage": the description and the 200 response say "Email Live Sending" and "Email Sandbox".
  • inbound.openapi.yml: the shared Forbidden response says "Email Live Sending is not enabled". The "Email API" mentions in the message, reply and forward schemas say "Email Live Sending".
  • email-sending.openapi.yml: the spec title is "Email Live Sending". README.md: the spec rows say "Live Sending".
  • CLAUDE.md: the naming guide uses "Email Live Sending" and lists the old names.

Added after review:

  • email-sending.openapi.yml: the Stats tag description says "Email Live Sending aggregated stats". The Stats page subtitle (x-page-description) says "Email Live Sending stats".
  • email-campaigns.openapi.yml, "Get Email Marketing stats": "Email Live Sending traffic is not included".

How to test

  • git diff a769359 HEAD on this branch shows only the three lines added after review
  • The "Get current billing cycle usage" page shows "Email Live Sending"
  • The 403 response on an inbound page says "Email Live Sending is not enabled for the organization"
  • spectral lint "specs/*.openapi.yml" reports no errors

This reverts the rollback in #67 and restores the rename from the
original PR (merge commit a769359).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1548fbd1-fe53-451b-88a3-df36d697bafe
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@izikaj
izikaj marked this pull request as ready for review November 9, 2026 15:41
@izikaj izikaj self-assigned this Nov 9, 2026

@IgorDobryn IgorDobryn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

specs/email-campaigns.openapi.yml:1862

getMarketingStats still says Email API/SMTP traffic is not included. Here it names the product, not a protocol, so under the new naming guide it should be renamed too. That also matches the "Email Marketing" set already used in this paragraph:

        Overview in the app for the same filters. Email Live Sending traffic is not included;

If you'd rather keep this PR an exact revert of #67, please open a follow-up that merges in the same window. Otherwise the docs will mix both names after the switch.

Comment thread specs/email-sending.openapi.yml Resolved
Comment thread specs/email-sending.openapi.yml Resolved
izikaj and others added 2 commits November 10, 2026 11:39
The Stats tag in email-sending.openapi.yml and getMarketingStats in
email-campaigns.openapi.yml named the product with the old name.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitBook shows x-page-description as the page subtitle, directly above
the renamed tag description.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@izikaj

izikaj commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor Author

Re the getMarketingStats note in the review: fixed in this PR (1f74dc4), so no follow-up PR is needed. It now says "Email Live Sending traffic is not included". The PR description lists all three lines that #64 did not change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants