Skip to content
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

suchintan.openapi spec #1682

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

suchintan.openapi spec #1682

wants to merge 2 commits into from

Conversation

suchintan
Copy link
Contributor

@suchintan suchintan commented Jan 30, 2025

  • OpenAPI Spec
  • OpenAPI Spec

Important

Adds a detailed OpenAPI specification for Skyvern API and configures TypeScript SDK generation.

  • OpenAPI Specification:
    • Adds skyvern_openapi.yml with detailed API paths, operations, parameters, and response schemas.
    • Includes endpoints for tasks, workflows, organizations, browser sessions, and more.
  • Configuration:
    • Adds generators.yml to configure TypeScript SDK generation using fernapi/fern-typescript-node-sdk.
    • Updates docs.yml to include API Reference in navigation.

This description was created by Ellipsis for 2684730. It will automatically update as commits are pushed.

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.

👍 Looks good to me! Reviewed everything up to 2684730 in 2 minutes and 6 seconds

More details
  • Looked at 9548 lines of code in 3 files
  • Skipped 1 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. fern/openapi/skyvern_openapi.yml:30
  • Draft comment:
    Using anyOf with null for optional parameters is not a best practice. Consider using nullable: true instead for better clarity and compatibility with OpenAPI tools. This issue is present in multiple places, such as x-skyvern-signature, x-skyvern-timestamp, and others.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    While the suggestion is technically valid from an OpenAPI best practices perspective, it's not critical. The current approach using anyOf with null is functionally correct and widely supported. The change would be purely stylistic and would require modifying many parameters throughout the file.
    The comment points out a legitimate OpenAPI best practice. Some tools might handle nullable: true better than anyOf with null.
    However, the current approach is functionally correct and widely supported. The suggested change would require significant refactoring for minimal benefit.
    Delete the comment as it suggests a non-critical style change that would require significant refactoring for minimal benefit.

Workflow ID: wflow_5n3YsUKE4Wpz8Q4g


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

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.

1 participant