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

Don't default to including store.Tables logs in /api/logs response #3386

Open
alvrs opened this issue Dec 2, 2024 · 0 comments · May be fixed by #3475
Open

Don't default to including store.Tables logs in /api/logs response #3386

alvrs opened this issue Dec 2, 2024 · 0 comments · May be fixed by #3475

Comments

@alvrs
Copy link
Member

alvrs commented Dec 2, 2024

Currently the indexer adds the store.Tables table to the API response by default. This was previously used to allow the sync stack to process the logs without separately fetching the table schema.

options.filters = options.filters.length > 0 ? [...options.filters, { tableId: schemasTable.tableId }] : [];

However, this behavior is not really intuitive - i just stumbled over it when trying to use the /api/logs API to fetch the records of a specific table. It also seems reasonable to assume that a consumer requesting records from a specific table already knows the table's schema.

Unfortunately old clients might depend on the current behavior, so I see two options:

  1. a new API version (ie /api/2/logs) that removes this behavior and updating the client libraries to use the new API
  2. a new option for the existing API to skip the store.Tables table. Less preferred option because it doesn't fix the intuitiveness of the API.
@alvrs alvrs changed the title Add option to indexer API to not include store.Tables logs in /api/logs response Don't default to including store.Tables logs in /api/logs response Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

1 participant