Skip to content

Conversation

@jpadilla
Copy link
Member

@jpadilla jpadilla commented Jan 22, 2026

Description

What problem is being solved?

Failures validating openapi swagger file https://github.com/openfga/api/actions/runs/21225752933/job/61082841107?pr=241

How is it being solved?

Switched github action used for that step.

What changes are made to solve it?

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Chores
    • Enhanced API validation process in development workflows to improve overall quality assurance.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2026

Walkthrough

The PR updates the GitHub Actions workflow to replace the swagger-editor-validate action with apidom-validate. The change includes updating the action reference, modifying the definition-file parameter format to use single quotes, and adding a fails-on threshold parameter set to 1 to trigger failure on any validation error.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow
.github/workflows/review.yaml
Replaced swagger-editor-validate action with apidom-validate in the validate-openapi job; updated definition-file parameter to single-quoted string format; added fails-on: 1 parameter to fail on validation errors

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ 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 clearly and specifically describes the main change: swapping the GitHub Action used for validating OpenAPI/Swagger files from swagger-editor-validate to apidom-validate.
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.


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.

@jpadilla jpadilla force-pushed the gha-validate-openapi branch from 25ab9f9 to c25358d Compare January 22, 2026 15:46
Signed-off-by: José Padilla <jose.padilla@okta.com>
@jpadilla jpadilla force-pushed the gha-validate-openapi branch from c25358d to 7ec00de Compare January 22, 2026 15:50
@jpadilla jpadilla marked this pull request as ready for review January 22, 2026 15:51
@jpadilla jpadilla requested a review from a team as a code owner January 22, 2026 15:51
Copilot AI review requested due to automatic review settings January 22, 2026 15:51
@dosubot
Copy link

dosubot bot commented Jan 22, 2026

Related Documentation

Checked 5 published document(s) in 0 knowledge base(s). No updates required.

How did I do? Any feedback?  Join Discord

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a failing OpenAPI/Swagger validation step in the GitHub Actions workflow by switching to a different validation action.

Changes:

  • Replaced swaggerexpert/swagger-editor-validate with swaggerexpert/apidom-validate action
  • Added fails-on: 1 parameter to configure failure behavior
  • Updated definition file path to use single quotes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.github/workflows/review.yaml:
- Around line 44-47: Replace the non-existent action reference and invalid
input: change the action name
"swaggerexpert/apidom-validate@e5f5f23a9258709b041cf2b8d7040858057fface" to the
correct "swaggerexpert/swagger-editor-validate" (or, if you need ApiDOM
specifically, use "char0n/apidom-validate") and replace the unsupported
"fails-on" parameter with the correct input name "ignore-error" for
swagger-editor-validate; update the action invocation that uses definition-file
and its inputs accordingly so the workflow calls a valid action and uses valid
input keys.

@jpadilla jpadilla merged commit 2bde21e into main Jan 22, 2026
16 checks passed
@jpadilla jpadilla deleted the gha-validate-openapi branch January 22, 2026 16:26
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.

4 participants