Skip to content

Conversation

@iuwqyir
Copy link
Contributor

@iuwqyir iuwqyir commented Mar 4, 2025

TL;DR

Updated JSON field names to follow consistent snake_case convention and added backward compatibility for deprecated fields.

What changed?

  • Renamed decodedData to decoded in transaction and log responses
  • Changed indexedParams to indexed_params and nonIndexedParams to non_indexed_params
  • Added deprecated versions of the params fields to maintain backward compatibility
  • Added swagger documentation tags to mark deprecated fields

How to test?

  1. Make API requests that fetch decoded logs and transactions
  2. Verify new snake_case fields contain the expected data
  3. Confirm deprecated camelCase fields still work and contain the same data
  4. Check swagger documentation reflects the deprecated status of old fields

Why make this change?

To establish consistent snake_case naming conventions across the API while ensuring existing integrations continue to work through a deprecation period.

Copy link
Contributor Author

iuwqyir commented Mar 4, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@iuwqyir iuwqyir requested a review from a team March 4, 2025 21:13
@iuwqyir iuwqyir marked this pull request as ready for review March 4, 2025 21:13
@iuwqyir iuwqyir merged commit 5b8e1cf into main Mar 5, 2025
5 checks passed
@iuwqyir iuwqyir deleted the 03-04-remove_camelcase_from_api_responses branch March 5, 2025 12:01
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.

3 participants