Skip to content

Revert "Readme: replace OpenAPI badge"#3083

Merged
RobinTail merged 1 commit intomasterfrom
revert-3077-RobinTail-patch-3
Nov 23, 2025
Merged

Revert "Readme: replace OpenAPI badge"#3083
RobinTail merged 1 commit intomasterfrom
revert-3077-RobinTail-patch-3

Conversation

@RobinTail
Copy link
Copy Markdown
Owner

@RobinTail RobinTail commented Nov 23, 2025

Reverts #3077
Seems to be fixed

Summary by CodeRabbit

  • Documentation
    • Updated OpenAPI badge references in documentation.

✏️ Tip: You can customize this high-level summary in your review settings.

@RobinTail RobinTail added the external bug it's a bug, but in a dependency label Nov 23, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 23, 2025

Walkthrough

The README.md file was updated to replace the OpenAPI validator badge. The old validator.swagger.io badge was removed and a new OpenAPI badge line was added to the documentation.

Changes

Cohort / File(s) Summary
Documentation badge updates
README.md
Replaced validator.swagger.io OpenAPI badge with a new OpenAPI badge

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • No logic or functionality changes; purely documentation/badge update

Possibly related PRs

Suggested labels

documentation

Poem

🐰 A badge so shiny, fresh and new,
Replaces the old one, goodbye to you!
The README gleams with OpenAPI pride,
While version shields go for a ride! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change—reverting a previous commit that replaced the OpenAPI badge in the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch revert-3077-RobinTail-patch-3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 591fb37 and e1039dc.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📚 Learning: 2025-06-02T21:11:20.768Z
Learnt from: RobinTail
Repo: RobinTail/express-zod-api PR: 2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:11:20.768Z
Learning: In the express-zod-api repository, RobinTail follows a release workflow where package.json version is only updated on the master branch after merging all planned release changes. Changelog entries may show future version numbers while package.json remains at the previous version during feature development, and this is intentional workflow, not a version inconsistency that needs to be flagged.

Applied to files:

  • README.md
📚 Learning: 2025-05-27T20:03:34.213Z
Learnt from: RobinTail
Repo: RobinTail/express-zod-api PR: 2546
File: example/factories.ts:35-42
Timestamp: 2025-05-27T20:03:34.213Z
Learning: The `./example` directory in the express-zod-api repository contains demonstration code for educational purposes only, not intended for production use. Example code can make simplified assumptions for brevity and clarity, and should not be flagged for missing production-level error handling, security measures, or edge case handling.

Applied to files:

  • README.md
📚 Learning: 2025-05-27T19:35:57.357Z
Learnt from: RobinTail
Repo: RobinTail/express-zod-api PR: 2546
File: express-zod-api/tests/buffer-schema.spec.ts:32-37
Timestamp: 2025-05-27T19:35:57.357Z
Learning: In the express-zod-api project, tests are run from the `express-zod-api` workspace directory, and the project uses an ESM-first environment without `__dirname`. Relative paths like `../logo.svg` in test files correctly resolve to the repository root due to this test execution context.

Applied to files:

  • README.md
📚 Learning: 2025-08-05T14:43:24.702Z
Learnt from: RobinTail
Repo: RobinTail/express-zod-api PR: 2869
File: zod-plugin/package.json:42-44
Timestamp: 2025-08-05T14:43:24.702Z
Learning: Zod version 4 has been officially released and is stable. As of August 2025, the latest published version is 4.0.14 (published July 30, 2025). Zod v4 is available on npm and can be used in peer dependencies with version constraints like "^4.0.0".

Applied to files:

  • README.md
📚 Learning: 2025-09-29T03:35:55.561Z
Learnt from: RobinTail
Repo: RobinTail/express-zod-api PR: 0
File: :0-0
Timestamp: 2025-09-29T03:35:55.561Z
Learning: In the express-zod-api repository, packages are built using tsdown before publishing. Source code with .ts extensions is not published - only the built JavaScript bundles and declaration files in the dist/ directory are published to npm. This means .ts extensions in source imports don't affect consumers.

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build (20.x)
  • GitHub Check: build (22.x)
🔇 Additional comments (1)
README.md (1)

6-6: Revert is safe—OpenAPI spec is valid and badge will display correctly.

Verification confirms that example/example.documentation.yaml exists and contains a valid OpenAPI 3.1.0 specification. The shields.io badge validator will render successfully. The YAML linting warnings (missing document start, line length) are style issues that don't affect the OpenAPI spec validity or badge functionality.


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.

@RobinTail RobinTail merged commit e1069ed into master Nov 23, 2025
13 checks passed
@RobinTail RobinTail deleted the revert-3077-RobinTail-patch-3 branch November 23, 2025 10:54
@coveralls-official
Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same
when pulling e1039dc on revert-3077-RobinTail-patch-3
into 591fb37 on master.

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

Labels

external bug it's a bug, but in a dependency

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant