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.

Sign up for GitHub

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

Jump to bottom

feat: endpoint to get metrics of casts matching a query #271

Merged
merged 5 commits into from
Dec 24, 2024
Merged

feat: endpoint to get metrics of casts matching a query #271

merged 5 commits into from
Dec 24, 2024

Conversation

valerierose
Copy link
Contributor

@valerierose valerierose commented Dec 23, 2024 •
edited
Loading

Description of the Change

Documents the new /v2/farcaster/cast/metrics endpoint, which returns counts of casts matching a query per unit time.

OAS Change Summary

New Endpoints

  • GET /v2/farcaster/cast/metrics - Get the number of casts matching a query over time.

New/Updated Schemas

  • CastsMetrics - Object defining one datapoint in time
  • CastsMetricsResponse - Response type of the new endpoint, contains an array of CastsMetrics

Checklist

  • I have validated that all new/updated endpoints conform to OAS standards.
  • I have updated or added necessary schema definitions.
  • I have ensured that the new schema I have added doesn't exist.
  • I have added description wherever necessary.
  • I have ensured that endpoint's responses are correct.
  • I have considered backward compatibility with previous versions of the API.
  • I have communicated any breaking changes to the appropriate stakeholders.
  • I have tested the OAS changes using a tool like Swagger editor

@valerierose valerierose marked this pull request as ready for review December 23, 2024 23:09
@valerierose valerierose requested a review from manan19 December 23, 2024 23:09
manan19
manan19 reviewed Dec 24, 2024
View reviewed changes
Copy link
Contributor

@manan19 manan19 left a comment

Choose a reason for hiding this comment

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

need to bump the version number

@valerierose valerierose merged commit 0ecc397 into main Dec 24, 2024
1 check passed
@valerierose valerierose deleted the val/neyn-4031-add-castmetrics-endpoint-to-oas branch December 24, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@manan19 manan19 manan19 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@valerierose @manan19