Skip to content

Fix formatting in Python example for Mailtrap client#40

Merged
IgorDobryn merged 3 commits into
mainfrom
trigger-update
Jun 1, 2026
Merged

Fix formatting in Python example for Mailtrap client#40
IgorDobryn merged 3 commits into
mainfrom
trigger-update

Conversation

@IgorDobryn

@IgorDobryn IgorDobryn commented May 27, 2026

Copy link
Copy Markdown
Contributor

Motivation

Trigger update for gitbook

Summary by CodeRabbit

  • Documentation

    • Improved formatting in the create contact export Python code example for clearer readability.
  • Chores

    • Updated the OpenAPI linting CI workflow (internal tooling adjustments).

Review Change Stack

@IgorDobryn IgorDobryn requested a review from Rabsztok May 27, 2026 08:31
@coderabbitai

coderabbitai Bot commented May 27, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44cf90a5-e6a6-442e-888c-77e4e672df0d

📥 Commits

Reviewing files that changed from the base of the PR and between a36b899 and ba2dd34.

📒 Files selected for processing (2)
  • .github/workflows/openapi-lint.yml
  • specs/contacts.openapi.yml
✅ Files skipped from review due to trivial changes (1)
  • specs/contacts.openapi.yml

📝 Walkthrough

Walkthrough

Two independent edits: a blank line was added inside the Python example for the contact export POST in the OpenAPI spec, and the OpenAPI lint GitHub Actions workflow's node-version was changed from 20 to 24.

Changes

OpenAPI Specification Documentation

Layer / File(s) Summary
Python code sample formatting in contact export endpoint
specs/contacts.openapi.yml
A blank line is inserted after the code-block start marker (`source:

CI Workflow

Layer / File(s) Summary
GitHub Actions Node.js version bump for OpenAPI lint
.github/workflows/openapi-lint.yml
The workflow’s setup-node step updates node-version from 20 to 24 before running @stoplight/spectral-cli.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • yanchuk
  • VladimirTaytor

Poem

🐰 A tiny hop, a tidy line,
YAML breathes and looks divine,
Actions stepping up to twenty-four,
Linting hums and samples pour,
I nibble whitespace — peace once more.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete and lacks detail. Required sections (Changes, How to test) are missing entirely. Add a Changes section listing the specific formatting fix, and include How to test section with verification steps.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately describes the main change: formatting fix in Python example for the Mailtrap client.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch trigger-update

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@IgorDobryn IgorDobryn requested a review from DagonWat June 1, 2026 10:15
@IgorDobryn IgorDobryn merged commit 5e0d655 into main Jun 1, 2026
2 checks passed
@IgorDobryn IgorDobryn deleted the trigger-update branch June 1, 2026 13:49
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