Skip to content

fix: fix openapi.yaml #5841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 29, 2025
Merged

fix: fix openapi.yaml #5841

merged 9 commits into from
May 29, 2025

Conversation

pyranota
Copy link
Contributor

@pyranota pyranota commented May 29, 2025

Important

Fixes OpenAPI spec validation by adding GitHub Action, updating openapi.yaml, and modifying TypeScript files for type consistency.

  • OpenAPI Validation:
    • Adds validate-openapi.yml GitHub Action to validate OpenAPI specs on push and pull request events.
    • Validates openapi.yaml and openapi-deref.json using openapi-generator-cli.
  • OpenAPI Specification:
    • Removes required: false from several application/json content types in openapi.yaml.
    • Corrects parameter type definitions for version in openapi.yaml.
    • Inlines schema references in openapi.yaml for better compatibility.
  • Nix Flake:
    • Adds openapi-generator-cli to flake.nix under devShells.default.
  • TypeScript Updates:
    • Changes kind: string to kind: HubScriptKind in FlowBuilder.svelte and flow.ts.

This description was created by Ellipsis for 008406f. You can customize this summary. It will automatically update as commits are pushed.

Copy link

cloudflare-workers-and-pages bot commented May 29, 2025

Deploying windmill with  Cloudflare Pages  Cloudflare Pages

Latest commit: 008406f
Status: ✅  Deploy successful!
Preview URL: https://2b82b3ad.windmill.pages.dev
Branch Preview URL: https://oapi-fix-n-validator.windmill.pages.dev

View logs

@pyranota pyranota marked this pull request as ready for review May 29, 2025 19:17
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Important

Looks good to me! 👍

Reviewed everything up to 008406f in 2 minutes and 23 seconds. Click for details.
  • Reviewed 243 lines of code in 5 files
  • Skipped 2 files when reviewing.
  • Skipped posting 5 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. flake.nix:228
  • Draft comment:
    The CFLAGS comment references a hardcoded GCC version (14.2.1). Consider parameterizing this version to improve maintainability.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
2. frontend/src/lib/components/FlowBuilder.svelte:15
  • Draft comment:
    Good use of importing 'type HubScriptKind'. Ensure that all places where hub completions are handled use this type consistently.
  • Reason this comment was not posted:
    Comment was on unchanged code.
3. frontend/src/lib/components/copilot/flow.ts:32
  • Draft comment:
    In the definition of 'selectedCompletion', the 'kind' property is typed as string. Consider using 'HubScriptKind' for consistency with hubCompletions.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
4. frontend/src/lib/components/copilot/flow.ts:362
  • Draft comment:
    The regex in glueCopilot uses matchAll(/([a-zA-Z_0-9.]+): (.+)/g). If inputs or expressions can include colons, this may produce unexpected results.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
5. backend/windmill-api/openapi.yaml:13170
  • Draft comment:
    Typographical suggestion: Instead of "inline each of schemas for better compat", perhaps consider revising to "inline each schema for better compatibility".
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While the suggested change would make the comment more grammatically correct and clearer, this is a very minor documentation change that doesn't affect functionality. The original comment is still understandable. According to the rules, we should not make purely informative comments or comments that are obvious/unimportant. This seems to fall into that category. The change would technically improve the documentation quality. Documentation clarity can be important for maintainability. While documentation quality matters, this is an extremely minor stylistic change that doesn't meaningfully impact understanding. The rules explicitly say not to make purely informative comments or comments about obvious/unimportant things. This comment should be deleted as it is purely about documentation style and is too minor to be worth keeping, per the rules about not making purely informative or unimportant comments.

Workflow ID: wflow_FrU5rogDMup2XQJf

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@rubenfiszel rubenfiszel merged commit 75fa9e4 into main May 29, 2025
13 of 15 checks passed
@rubenfiszel rubenfiszel deleted the oapi-fix-n-validator branch May 29, 2025 19:58
@github-actions github-actions bot locked and limited conversation to collaborators May 29, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants