extensions icon indicating copy to clipboard operation
extensions copied to clipboard

Add faraday-api-reference-docs extension

Open zebapy opened this issue 1 month ago • 4 comments

Description

Add extension to search https://faraday.ai/docs/reference

Screencast

Checklist

zebapy avatar Dec 07 '25 14:12 zebapy

Congratulations on your new Raycast extension! :rocket:

You can expect an initial review within five business days.

Once the PR is approved and merged, the extension will be available on our Store.

raycastbot avatar Dec 07 '25 14:12 raycastbot

Greptile Summary

This PR introduces a new Raycast extension for browsing Faraday API reference documentation. The extension fetches an OpenAPI schema from Faraday's API endpoint and displays all operations grouped by tags with color-coded HTTP methods. Users can search operations, open documentation in a browser, copy URLs, or ask Claude and ChatGPT questions about specific API endpoints.

The implementation follows Raycast extension standards with proper TypeScript configuration, ESLint setup, and Prettier formatting. All configuration files are correctly formatted and dependencies are up-to-date. The extension includes a metadata screenshot for the store listing.

Key observations:

  • All Raycast extension guidelines are followed
  • Configuration files conform to Raycast standards (Prettier, ESLint, TypeScript)
  • Changelog uses the correct {PR_MERGE_DATE} placeholder
  • README could be more detailed about features and usage
  • Code is clean and handles errors appropriately

Confidence Score: 4/5

  • This PR is safe to merge with minor recommendations for README enhancement
  • The extension is well-structured and follows all Raycast standards. All configuration files are correct, dependencies are properly specified, and the main code logic is sound. The primary concern is the minimal README documentation, which is a style/documentation issue rather than a functional problem. The dynamic URL generation for LLM prompts during render is slightly inefficient but not a critical issue for typical use cases.
  • README.md could benefit from expansion with more feature details and usage instructions

Important Files Changed

Filename Overview
extensions/faraday-api-reference-docs/package.json Package configuration follows Raycast standards. Dependencies are up-to-date and all required metadata is present with title in title case.
extensions/faraday-api-reference-docs/src/search.tsx Main command implementation fetches OpenAPI schema and displays API operations with methods color-coded. Includes actions for opening docs, copying URLs, and asking LLMs. LLM URLs are generated dynamically at render time, which may cause performance issues with large operation counts.
extensions/faraday-api-reference-docs/.prettierrc Prettier configuration correctly uses Raycast standard settings with printWidth 120 and singleQuote false.
extensions/faraday-api-reference-docs/CHANGELOG.md Changelog follows Raycast standards with {PR_MERGE_DATE} placeholder and clear entry describing initial release.
extensions/faraday-api-reference-docs/README.md README is very minimal and lacks important information about usage, features, installation requirements, and what the extension does beyond a one-liner.

greptile-apps[bot] avatar Dec 07 '25 14:12 greptile-apps[bot]

This pull request has been automatically marked as stale because it did not have any recent activity.

It will be closed if no further activity occurs in the next 7 days to keep our backlog clean 😊

raycastbot avatar Dec 22 '25 14:12 raycastbot

Could use review still. Not stale.

zebapy avatar Dec 22 '25 16:12 zebapy

@greptileai can you do a fresh review here?

pernielsentikaer avatar Jan 06 '26 12:01 pernielsentikaer

@pernielsentikaer you want me to do those changes from greptile?

zebapy avatar Jan 06 '26 12:01 zebapy

@zebapy if you could add a few lines, then I don't mind 😀

pernielsentikaer avatar Jan 06 '26 13:01 pernielsentikaer

I converted this PR into a draft until it's ready for the review, please press the button Ready for review when it's ready and we'll have a look 😊

pernielsentikaer avatar Jan 06 '26 13:01 pernielsentikaer