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

docs: update spec.yaml to support Frames & validateMessage #1634

Merged
merged 2 commits into from
Feb 16, 2024

Conversation

piratekev
Copy link
Contributor

@piratekev piratekev commented Jan 30, 2024

Motivation

Describe why this issue should be fixed and link to any relevant design docs, issues or other relevant items.
This PR updates the openAPI spec to support Frames.

Helpful UI for viewing spec: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/standard-crypto/farcaster-js/develop/packages/farcaster-js-hub-rest/src/openapi/spec.yaml

Change Summary

Updates the openAPI spec with the following changes:

  • Add the Frames types (FrameActionBody object & Message Type MESSAGE_TYPE_FRAME_ACTION)
  • Add the /validateMessage endpoint & types to support it
  • Changes some message body types to add type property
  • Fixes /submitMessage request body
  • Fixes the embed schema to support urls and casts

Merge Checklist

Choose all relevant options below by adding an x now or at any time before submitting for review

Additional Context

If this is a relatively large or complex change, provide more details here that will help reviewers


PR-Codex overview

Focus of this PR:

Update the documentation links in the spec file of the Farcaster hub-nodejs package.

Detailed summary:

  • Updated the documentation link for the REST API of the Farcaster hub.
  • Added a new endpoint /v1/validateMessage to validate a signed protobuf-serialized message with the Hub.
  • Added new schemas for FrameActionBody, CastEmbed, and UrlEmbed.
  • Added a new message type MESSAGE_TYPE_FRAME_ACTION for Farcaster Frame actions.
  • Updated the schemas for CastAddBody, CastRemove, MessageDataCastAdd, MessageDataCastRemove, MessageDataLink, MessageDataReaction, MessageDataVerificationAdd, MessageDataVerificationRemove, MessageDataUserDataAdd, and MessageDataFrameAction.
  • Added a new response schema ValidateMessageResponse.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Jan 30, 2024

⚠️ No Changeset found

Latest commit: 905155a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 30, 2024

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

Name Status Preview Comments Updated (UTC)
hub-monorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 16, 2024 1:08am

@piratekev piratekev changed the title feat: update spec.yaml to support Frames & validateMessage docs: update spec.yaml to support Frames & validateMessage Jan 30, 2024
@piratekev
Copy link
Contributor Author

cc @sanjayprabhu

Copy link
Contributor

@sanjayprabhu sanjayprabhu left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link

codecov bot commented Feb 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (80c8f7d) 73.75% compared to head (905155a) 74.61%.
Report is 51 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1634      +/-   ##
==========================================
+ Coverage   73.75%   74.61%   +0.85%     
==========================================
  Files          99       99              
  Lines        9000     9308     +308     
  Branches     1998     2090      +92     
==========================================
+ Hits         6638     6945     +307     
- Misses       2244     2251       +7     
+ Partials      118      112       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sanjayprabhu
Copy link
Contributor

Looks like your last commit is not signed. Please sign the commit and I'll merge.

@sanjayprabhu sanjayprabhu merged commit 592bbb2 into farcasterxyz:main Feb 16, 2024
10 checks passed
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