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

fix: api references and docs #992

Merged
merged 8 commits into from
Dec 20, 2024
Merged

fix: api references and docs #992

merged 8 commits into from
Dec 20, 2024

Conversation

utkarsh-dixit
Copy link
Collaborator

@utkarsh-dixit utkarsh-dixit commented Dec 11, 2024

Important

This pull request updates API references, restructures endpoints, and enhances documentation generation using EJS templating.

  • API Reference Updates:
    • Restructured API endpoints in docs/api-reference for actions, apps, client, connections, and triggers.
    • Updated OpenAPI paths in composio_openapi.json to reflect new endpoint structures.
  • Documentation Generation:
    • Added generate:dev script in package.json for development environment.
    • Updated render_mint_json_template.js to dynamically generate mint.json from mint.json.ejs using EJS templating.
  • Configuration Changes:
    • Updated mint.json and mint.json.ejs to reflect new API reference structure and navigation.
  • Misc:
    • Minor changes in demo.mjs for testing purposes.

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

Copy link

vercel bot commented Dec 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
composio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 20, 2024 3:17pm

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 861cb31 in 2 minutes and 46 seconds

More details
  • Looked at 1568 lines of code in 101 files
  • Skipped 1 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/scripts/render_mint_json_template.js:19
  • Draft comment:
    Consider adding a check to ensure the directory exists and is not empty before attempting to read '.mdx' files. This will prevent potential errors if a directory is empty or missing.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The script is designed to read directories and files to generate a JSON structure. However, it assumes that all directories in 'api-reference' contain '.mdx' files, which might not always be the case. Adding a check for directory existence and handling empty directories would make the script more robust.

Workflow ID: wflow_OIuqwV6koBumuIR9


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

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.

❌ Changes requested. Incremental review on 556c51d in 1 minute and 3 seconds

More details
  • Looked at 38 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_EvsVQ7yETPUvEAbw


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.


const result = await toolset.client.actions.findActionEnumsByUseCase({
apps: ["gmail", "googledrive"],
useCase: "get repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo informationget repo information",
Copy link
Contributor

Choose a reason for hiding this comment

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

The useCase string is excessively long and repetitive. Consider replacing it with a meaningful and concise description.

@@ -1,24 +1,17 @@
import { Composio, LangchainToolSet } from "composio-core";
import { z } from "zod";

const toolset = new LangchainToolSet();
const toolset = new LangchainToolSet({
apiKey: "4q7w9q6evy2fiisjgwoc8i"
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid hardcoding API keys in the source code. Consider using environment variables or a secure configuration management system.

Copy link

github-actions bot commented Dec 17, 2024

This comment was generated by github-actions[bot]!

JS SDK Coverage Report

📊 Coverage report for JS SDK can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/coverage-12433866193/coverage/index.html

📁 Test report folder can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/html-report-12433866193/html-report/report.html

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! Incremental review on 37f3bdf in 39 seconds

More details
  • Looked at 129 lines of code in 10 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/api-reference/triggers/update-new-webhook.mdx:2
  • Draft comment:
    Consider using hyphens instead of underscores in the endpoint path to maintain consistency with other endpoints.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The new endpoint 'update-new-webhook' is added to the triggers group in the mint.json file. However, the naming convention for the endpoint is inconsistent with the other endpoints in the same group, which use hyphens instead of underscores.

Workflow ID: wflow_jzVqwLogC7VdLQ6M


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

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.

Skipped PR review on 7ee3adf because no changed files had a supported extension. If you think this was in error, please contact us and we'll fix it right away.

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.

Skipped PR review on cc2c652 because no changed files had a supported extension. If you think this was in error, please contact us and we'll fix it right away.

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! Incremental review on b1754d8 in 41 seconds

More details
  • Looked at 38 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. js/examples/e2e/demo.mjs:6
  • Draft comment:
    Consider adding error handling for asynchronous operations to ensure robustness.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The code is missing error handling for asynchronous operations, which is a best practice to ensure robustness.

Workflow ID: wflow_tDp5q9C5325i1CML


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

@utkarsh-dixit utkarsh-dixit merged commit b53cc00 into master Dec 20, 2024
11 of 13 checks passed
@utkarsh-dixit utkarsh-dixit deleted the fx-api-docs branch December 20, 2024 15:17
@utkarsh-dixit utkarsh-dixit restored the fx-api-docs branch December 20, 2024 17:06
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.

2 participants