Skip to content

Store changes filter by start time - #204

Merged
cikasfm merged 3 commits into
mainfrom
feature/store-changes-filter-by-start-time
Oct 28, 2024
Merged

Store changes filter by start time#204
cikasfm merged 3 commits into
mainfrom
feature/store-changes-filter-by-start-time

Conversation

@cikasfm

@cikasfm cikasfm commented Oct 10, 2024

Copy link
Copy Markdown
Contributor

As a Developer, I want to be able to query the changelog based on a specific time period (start date), so that I can retrieve only the changes made after that specific point in time. This will improve the efficiency of tracking and processing changes for the user.

Why are we doing this? The changelog contains all changes made to resources over time. Providing the ability to filter these changes by a specific time ensures that developers can query only the relevant data, making the API responses lighter, faster and more efficient.

The changelog can be filtered using the start date as an additional parameter in the API, SDKs,and CLI

The start time parameter should be in the ISO 8601 format

Example: YYYY-MM-DDTHH:MM:SSZ (ISO 8601 DateTime)

Description

Added optional start_time attribute to /store/{id}/changes API to allow streaming starting the given time stamp.

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@linux-foundation-easycla

linux-foundation-easycla Bot commented Oct 10, 2024

Copy link
Copy Markdown

CLA Signed

The committers listed above are authorized under a signed CLA.

@cikasfm
cikasfm force-pushed the feature/store-changes-filter-by-start-time branch from 281b25b to 23ffb2d Compare October 14, 2024 15:33
@cikasfm cikasfm changed the title WIP: Store changes filter by start time Store changes filter by start time Oct 14, 2024
@cikasfm
cikasfm marked this pull request as ready for review October 14, 2024 16:29
@cikasfm
cikasfm requested review from a team as code owners October 14, 2024 16:29
@cikasfm
cikasfm requested review from jpadilla and rhamzeh October 14, 2024 16:29

@poovamraj poovamraj left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Just a minor clarification, or else looks good to me. I'd pull in a core member to have an extra pair of eyes.

Comment thread openfga/v1/errors_ignore.proto
@cikasfm
cikasfm force-pushed the feature/store-changes-filter-by-start-time branch from 9d5cebe to 6cb4c29 Compare October 16, 2024 18:07
@cikasfm
cikasfm force-pushed the feature/store-changes-filter-by-start-time branch from 6cb4c29 to ebd592f Compare October 23, 2024 23:29
@cikasfm cikasfm self-assigned this Oct 23, 2024
@cikasfm
cikasfm requested a review from poovamraj October 24, 2024 13:23
Comment thread openfga/v1/openfga_service.proto Outdated
…long side start_time, the continuation_token will take precedence over start_time.
@cikasfm
cikasfm merged commit 7c098f1 into main Oct 28, 2024
@cikasfm
cikasfm deleted the feature/store-changes-filter-by-start-time branch October 28, 2024 14:50
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.

4 participants