Conversation
📝 WalkthroughWalkthroughAdded Ruby code samples and runtime print statements across multiple OpenAPI spec files; no changes to endpoint definitions, schemas, or API behavior. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
specs/sandbox.openapi.yml (1)
941-941: Unify placeholder naming in Ruby samples for copy/paste clarity.Line 941 uses
PROJECT_ID, while other placeholders use theYOUR_*style (e.g.,YOUR_ACCOUNT_ID). The same mixed pattern appears in other new snippets (INBOX_ID,MESSAGE_ID,ATTACHMENT_ID). Consider standardizing toYOUR_PROJECT_ID,YOUR_INBOX_ID, etc.Based on learnings "replace actual environment variable references with clear placeholders (e.g., YOUR_API_KEY, YOUR_ACCOUNT_ID) to avoid leaking secrets in documentation."
Also applies to: 1067-1067, 1178-1178, 1324-1324, 1453-1453, 1570-1570, 1687-1687, 2066-2066, 2308-2308, 2524-2524, 2749-2751, 2941-2941, 3112-3112, 3295-3295, 3427-3427, 3603-3603, 3754-3754, 3909-3909, 4085-4085, 4212-4212, 4374-4375, 4535-4535
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@specs/sandbox.openapi.yml` at line 941, The Ruby sample uses inconsistent placeholder names (e.g., inboxes.create(... project_id: PROJECT_ID)) which should be standardized to the YOUR_* style; update PROJECT_ID → YOUR_PROJECT_ID and similarly replace INBOX_ID, MESSAGE_ID, ATTACHMENT_ID, ACCOUNT_ID, API_KEY, etc. in the affected snippets (look for calls like inboxes.create(name: 'My Test Inbox', project_id: PROJECT_ID), messages.get(INBOX_ID, MESSAGE_ID), attachments.upload(ATTACHMENT_ID), and any other occurrences listed in the comment) so all placeholders read like YOUR_PROJECT_ID, YOUR_INBOX_ID, YOUR_MESSAGE_ID, YOUR_ATTACHMENT_ID, YOUR_ACCOUNT_ID, YOUR_API_KEY for consistent copy/paste safety.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@specs/email-sending.openapi.yml`:
- Around line 124-135: The Ruby examples that create a sending domain use the
wrong field name: replace domain.name with domain.domain_name in every Ruby
snippet that instantiates Mailtrap::Client and uses
Mailtrap::SendingDomainsAPI#create (look for the snippets that call
Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client) and assign the result
to domain); update all three occurrences so the output prints domain.domain_name
instead of domain.name.
---
Nitpick comments:
In `@specs/sandbox.openapi.yml`:
- Line 941: The Ruby sample uses inconsistent placeholder names (e.g.,
inboxes.create(... project_id: PROJECT_ID)) which should be standardized to the
YOUR_* style; update PROJECT_ID → YOUR_PROJECT_ID and similarly replace
INBOX_ID, MESSAGE_ID, ATTACHMENT_ID, ACCOUNT_ID, API_KEY, etc. in the affected
snippets (look for calls like inboxes.create(name: 'My Test Inbox', project_id:
PROJECT_ID), messages.get(INBOX_ID, MESSAGE_ID),
attachments.upload(ATTACHMENT_ID), and any other occurrences listed in the
comment) so all placeholders read like YOUR_PROJECT_ID, YOUR_INBOX_ID,
YOUR_MESSAGE_ID, YOUR_ATTACHMENT_ID, YOUR_ACCOUNT_ID, YOUR_API_KEY for
consistent copy/paste safety.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 20b70e43-b3da-46c6-8837-d85879f618d3
📒 Files selected for processing (3)
specs/account-management.openapi.ymlspecs/email-sending.openapi.ymlspecs/sandbox.openapi.yml
| - lang: ruby | ||
| label: Ruby | ||
| source: | | ||
| require 'mailtrap' | ||
|
|
||
| client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY']) | ||
| sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client) | ||
|
|
||
| domain = sending_domains.create(domain_name: 'example.com') | ||
|
|
||
| puts "Created domain: #{domain.name}" | ||
| - lang: csharp |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Verify Mailtrap Ruby SendingDomain fields from the official SDK source.
curl -fsSL https://raw.githubusercontent.com/mailtrap/mailtrap-ruby/main/lib/mailtrap/sending_domain.rb | sed -n '1,120p'Repository: mailtrap/mailtrap-openapi
Length of output: 1900
Use domain.domain_name instead of domain.name in Ruby sending-domain samples.
The Ruby Mailtrap::SendingDomain struct defines the field as domain_name, not name. Update the three code samples at lines 124-135, 267-277, and 385-395.
Required changes
- puts "Created domain: #{domain.name}"
+ puts "Created domain: #{domain.domain_name}"- puts "Domain: #{domain.name}"
+ puts "Domain: #{domain.domain_name}"- puts "Domain: #{domain.name}"
+ puts "Domain: #{domain.domain_name}"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - lang: ruby | |
| label: Ruby | |
| source: | | |
| require 'mailtrap' | |
| client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY']) | |
| sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client) | |
| domain = sending_domains.create(domain_name: 'example.com') | |
| puts "Created domain: #{domain.name}" | |
| - lang: csharp | |
| - lang: ruby | |
| label: Ruby | |
| source: | | |
| require 'mailtrap' | |
| client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY']) | |
| sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client) | |
| domain = sending_domains.create(domain_name: 'example.com') | |
| puts "Created domain: #{domain.domain_name}" | |
| - lang: csharp |
🤖 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 124 - 135, The Ruby examples
that create a sending domain use the wrong field name: replace domain.name with
domain.domain_name in every Ruby snippet that instantiates Mailtrap::Client and
uses Mailtrap::SendingDomainsAPI#create (look for the snippets that call
Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client) and assign the result
to domain); update all three occurrences so the output prints domain.domain_name
instead of domain.name.
specs/account-management.openapi.yml
Outdated
| client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY']) | ||
| billing = Mailtrap::BillingAPI.new(YOUR_ACCOUNT_ID, client) | ||
|
|
||
| billing.usage |
There was a problem hiding this comment.
It's just an expression, maybe we should print it? I see we do that in some examples and in some not, there's no consistency.
piobeny
left a comment
piobeny
left a comment
There was a problem hiding this comment.
I think we should be consistent with the examples, either leave just statement at the end:
messages.html_source(MESSAGE_ID)
or print it:
domain = sending_domains.get(DOMAIN_ID)
puts "Domain: #{domain.name}"
|
Hi @piobeny you are absolutely right, I tried making this task with AI to automate the documentation update based on Ruby SDK updates. I now updated and added |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
specs/email-sending.openapi.yml (1)
124-134:⚠️ Potential issue | 🟠 MajorUse
domain.domain_nameinstead ofdomain.namein Ruby sending-domain samples.These three Ruby examples access a non-matching field and should print
domain.domain_namefor consistency with the Ruby SDK model.Proposed fix
- puts "Created domain: #{domain.name}" + puts "Created domain: #{domain.domain_name}"- puts "Domain: #{domain.name}" + puts "Domain: #{domain.domain_name}"- puts "Domain: #{domain.name}" + puts "Domain: #{domain.domain_name}"#!/bin/bash set -euo pipefail # Verify fields in the official Mailtrap Ruby sending domain model. curl -fsSL https://raw.githubusercontent.com/mailtrap/mailtrap-ruby/main/lib/mailtrap/sending_domain.rb | sed -n '1,200p'Based on learnings: Use official Mailtrap SDKs for language-specific code examples in x-codeSamples; if SDK doesn't support a method, use GitBook generation or add a comment noting SDK limitations.
Also applies to: 267-277, 385-395
🤖 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 124 - 134, Replace the incorrect `domain.name` property with `domain.domain_name` in the Ruby sending-domain samples: update the usage on the `domain` variable returned by `Mailtrap::SendingDomainsAPI#create` so the examples print `domain.domain_name`; apply the same change to the other Ruby examples that construct a `Mailtrap::SendingDomainsAPI` client and reference `domain` (the other occurrences noted in the review).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@specs/sandbox.openapi.yml`:
- Around line 123-133: Ruby sample placeholders like YOUR_ACCOUNT_ID, INBOX_ID,
MESSAGE_ID, PROJECT_ID, and ATTACHMENT_ID are unquoted constants and will raise
NameError when executed; update every Ruby snippet that uses these bare
identifiers (e.g., Mailtrap::InboxesAPI.new(YOUR_ACCOUNT_ID, client),
inbox.messages.get(INBOX_ID, MESSAGE_ID), Mailtrap::ProjectsAPI.new(PROJECT_ID,
client), attachments.get(PROJECT_ID, ATTACHMENT_ID), etc.) to use quoted strings
(e.g., 'YOUR_ACCOUNT_ID', 'INBOX_ID', 'MESSAGE_ID', 'PROJECT_ID',
'ATTACHMENT_ID') so the examples run as-is. Ensure you replace all occurrences
of those placeholder symbols throughout the Ruby code blocks in the file.
---
Duplicate comments:
In `@specs/email-sending.openapi.yml`:
- Around line 124-134: Replace the incorrect `domain.name` property with
`domain.domain_name` in the Ruby sending-domain samples: update the usage on the
`domain` variable returned by `Mailtrap::SendingDomainsAPI#create` so the
examples print `domain.domain_name`; apply the same change to the other Ruby
examples that construct a `Mailtrap::SendingDomainsAPI` client and reference
`domain` (the other occurrences noted in the review).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a508af22-286d-4d8e-bf6d-19b7263f0971
📒 Files selected for processing (5)
specs/account-management.openapi.ymlspecs/contacts.openapi.ymlspecs/email-sending.openapi.ymlspecs/sandbox.openapi.ymlspecs/templates.openapi.yml
| - lang: ruby | ||
| label: Ruby | ||
| source: | | ||
| require 'mailtrap' | ||
|
|
||
| client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY']) | ||
| inboxes = Mailtrap::InboxesAPI.new(YOUR_ACCOUNT_ID, client) | ||
|
|
||
| inboxes.list.each do |inbox| | ||
| puts "Inbox: #{inbox.name} (ID: #{inbox.id})" | ||
| end |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Detect bare placeholder constants in Ruby sample lines.
python - <<'PY'
from pathlib import Path
p = Path("specs/sandbox.openapi.yml")
tokens = ["YOUR_ACCOUNT_ID", "PROJECT_ID", "INBOX_ID", "MESSAGE_ID", "ATTACHMENT_ID"]
for i, line in enumerate(p.read_text().splitlines(), 1):
if "source: |" in line:
continue
for t in tokens:
if t in line and f"'{t}'" not in line and f'"{t}"' not in line:
print(f"{i}: {line.rstrip()}")
break
PYRepository: mailtrap/mailtrap-openapi
Length of output: 7460
Quote placeholder IDs in Ruby samples to prevent NameError when examples are executed.
Ruby code samples use bare constants (e.g., YOUR_ACCOUNT_ID, INBOX_ID, MESSAGE_ID, PROJECT_ID, ATTACHMENT_ID) without quotes. In valid Ruby, these are treated as constants and will raise NameError if undefined when the code is run. Placeholder IDs must be quoted strings to match Mailtrap's documentation standards.
Fix pattern
- inboxes = Mailtrap::InboxesAPI.new(YOUR_ACCOUNT_ID, client)
+ inboxes = Mailtrap::InboxesAPI.new('YOUR_ACCOUNT_ID', client)
- inbox = inboxes.get(INBOX_ID)
+ inbox = inboxes.get('INBOX_ID')
- message = messages.get(MESSAGE_ID)
+ message = messages.get('MESSAGE_ID')Affects all Ruby samples in this file: lines 129, 939, 941, 1067, 1179, 1325, 1454, 1571, 1688, 2065, 2067, 2308, 2310, 2524, 2526, 2744, 2941, 2943, 3112, 3114, 3295, 3297, 3427, 3429, 3603, 3605, 3754, 3756, 3909, 3911, 4085, 4087, 4212, 4214, 4376, 4534, 4537.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@specs/sandbox.openapi.yml` around lines 123 - 133, Ruby sample placeholders
like YOUR_ACCOUNT_ID, INBOX_ID, MESSAGE_ID, PROJECT_ID, and ATTACHMENT_ID are
unquoted constants and will raise NameError when executed; update every Ruby
snippet that uses these bare identifiers (e.g.,
Mailtrap::InboxesAPI.new(YOUR_ACCOUNT_ID, client), inbox.messages.get(INBOX_ID,
MESSAGE_ID), Mailtrap::ProjectsAPI.new(PROJECT_ID, client),
attachments.get(PROJECT_ID, ATTACHMENT_ID), etc.) to use quoted strings (e.g.,
'YOUR_ACCOUNT_ID', 'INBOX_ID', 'MESSAGE_ID', 'PROJECT_ID', 'ATTACHMENT_ID') so
the examples run as-is. Ensure you replace all occurrences of those placeholder
symbols throughout the Ruby code blocks in the file.
DagonWat
deleted the
MT-20050-add-new-ruby-code-examples-to-open-api-specs
branch
3 participants
Motivation
https://railsware.atlassian.net/browse/MT-20050
Changes
Summary by CodeRabbit