0xPlaygrounds / 0xPlaygrounds/kg-node

feat(api): Entity version filtering

Open
#31 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
10
Forks
5
PR merge metrics
No merged PRs in 30d

Description

#### Motivation
Allow users to reduce the number of versions returned by the API in cases where only a subset of versions is of interest.
#### Implementation
Add the following filter object to the GraphQL API
```graphql
input VersionFilter {
proposedAt: String
proposedAt_gt: String
proposedAt_gte: String
proposedAt_lt: String
proposedAt_lte: String
proposedAt_not: String

publishedAt: String
publishedAt_gt: String
publishedAt_gte: String
publishedAt_lt: String
publishedAt_lte: String
publishedAt_not: String

author: String
author_not: String
author_in: [String!]
author_not_in: [String!]

updatedAttributes_contains: [String!]
updatedAttributes_not_contains: [String!]
}
```
Note: Many of these filters relate to new entity version fields spec-ed out in #30

This filter would be used when selecting the versions of an entity, e.g.:
```graphql
# Schema
type Entity {
versions(where: VersionFilter): [EntityVersion!]!
}

# Query
query {
entity(entityId: "Foo", spaceId: "MySpace") {
# Get versions proposed by Byron since the start of the month
versions(where: {
author: "Byron",
proposedAt_gte: "2025-02-01T00:00:00",
}) {
id
name
}
}
}
```
Note: argument values not accurate

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue specifies adding a VersionFilter input type to the GraphQL API for filtering entity versions. Start by examining the GraphQL schema definitions in the codebase, likely in a schema.graphql or similar file, and the corresponding resolver logic for the Entity.versions field. Look for existing filter patterns in the project to understand the implementation approach. The filter fields relate to new entity version fields from issue #30, so review that issue for context. Implement the filter input type and integrate it into the versions field resolver, ensuring it can handle the proposed filter conditions like author and proposedAt_gte.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, rust
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.