Skip to content

P-2379 Correct CLI filter examples - #28

Closed
yosriady wants to merge 2 commits into
mainfrom
feat/p-2379-filter-docs
Closed

P-2379 Correct CLI filter examples#28
yosriady wants to merge 2 commits into
mainfrom
feat/p-2379-filter-docs

Conversation

@yosriady

@yosriady yosriady commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • correct segment examples to use the public field::op::value DSL
  • describe --filter-sets as the segment create-request filterSets input
  • document passing page_scope through analytics --params
  • add a page-filtered KPI example to README and generated skill guidance

Validation

  • 156 unit tests passed
  • lint passed
  • typecheck passed

Live integration tests remain skipped because no valid TEST_TOKEN is configured.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

@linear-code

linear-code Bot commented Jul 28, 2026

Copy link
Copy Markdown

P-2379

@yosriady
yosriady marked this pull request as ready for review July 29, 2026 05:46
@yosriady yosriady closed this Jul 29, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ae3363c04c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/commands/profiles.ts
orderDir?: string
expand?: string
conditions?: string
filters?: string

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Preserve --conditions as a compatibility alias

Existing scripts using the previously documented profiles search --conditions ... option no longer supply any filter after this schema key is renamed to filters; depending on incur's unknown-option handling, they either fail immediately or perform an unfiltered search. Keep conditions as a deprecated alias that is normalized to the new canonical filters request field so upgrading the CLI does not break or broaden existing searches.

Useful? React with 👍 / 👎.

Comment thread src/commands/segments.ts
Comment on lines +69 to +72
filters: z
.string()
.describe('JSON array of filter set strings defining the segment'),
.describe(
'JSON array of canonical {"field","op","value"} filter objects',

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Preserve --filter-sets as a compatibility alias

The required segment-create option was previously exposed and documented as --filter-sets; replacing it outright with --filters causes every existing formo segments create script to fail validation before making its request. Accept the legacy option as a deprecated alias and translate its DSL values, or provide an explicit migration path rather than removing the published flag in place.

Useful? React with 👍 / 👎.

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.

1 participant