-
Notifications
You must be signed in to change notification settings - Fork 388
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
Looks like your last commit is not signed. Please sign the commit and I'll merge. |
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:
FrameActionBody
object & Message TypeMESSAGE_TYPE_FRAME_ACTION
)/validateMessage
endpoint & types to support ittype
property/submitMessage
request bodyMerge Checklist
Choose all relevant options below by adding an
x
now or at any time before submitting for reviewAdditional 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:
/v1/validateMessage
to validate a signed protobuf-serialized message with the Hub.FrameActionBody
,CastEmbed
, andUrlEmbed
.MESSAGE_TYPE_FRAME_ACTION
for Farcaster Frame actions.CastAddBody
,CastRemove
,MessageDataCastAdd
,MessageDataCastRemove
,MessageDataLink
,MessageDataReaction
,MessageDataVerificationAdd
,MessageDataVerificationRemove
,MessageDataUserDataAdd
, andMessageDataFrameAction
.ValidateMessageResponse
.