Skip to content

Conversation

@alexluong
Copy link
Collaborator

@alexluong alexluong commented Dec 16, 2025

Filter Syntax Guide Documentation Update

Summary

Updated the Filter Syntax Guide to accurately document all filterable event properties.

Changes

Event Structure

Previously, the guide only documented two top-level properties:

  • data
  • metadata

Updated to document all five filterable properties:

  • id — The event ID
  • topic — The event topic
  • time — Event timestamp (RFC3339 format)
  • metadata — Additional event information
  • data — The event payload

New Examples

Added time range filtering example:

{
  "time": {
    "$gte": "2025-01-01T00:00:00Z",
    "$lt": "2025-02-01T00:00:00Z"
  }
}

Reference

The filter input structure is defined in internal/models/destination.go:161-167:

filterInput := map[string]any{
    "id":       event.ID,
    "topic":    event.Topic,
    "time":     event.Time.Format("2006-01-02T15:04:05Z07:00"),
    "metadata": map[string]any{},
    "data":     map[string]any{},
}

@vercel
Copy link

vercel bot commented Dec 16, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
outpost-docs Ready Ready Preview, Comment Dec 17, 2025 7:51am
outpost-website Ready Ready Preview, Comment Dec 17, 2025 7:51am

@alexluong alexluong merged commit 6cdea65 into v0.10.0 Dec 17, 2025
2 of 4 checks passed
@alexluong alexluong deleted the portal-filter-schema branch December 17, 2025 07:50
alexluong added a commit that referenced this pull request Dec 17, 2025
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.

2 participants