Canonical filter operators: terse tokens + isEmpty/notEmpty (long-form aliases deprecated on /v0/profiles)#114
Merged
Conversation
…s retirement) The Formo API retired the legacy operator aliases (eq/neq/gt/gte/lt/lte/ nin/contains) on POST /v0/profiles filters — they now return 400. Bring the docs in line with the canonical vocabulary: - api/openapi.json: synced from the backend spec — FilterCondition (and the analytics/step/retention filter schemas) now use canonical tokens and add the value-less existence ops notEmpty / isEmpty; value optional. - api/profiles/search.mdx: operator table rewritten to canonical (equals/notEquals/greater/greaterOrEqual/less/lessOrEqual/in/notIn/ includes) + notEmpty/isEmpty rows and a compatibility note; all JSON examples canonicalized; social presence checks now use `notEmpty` instead of the old `equals ""` idiom. - cli/profiles.mdx: canonicalized the example op tokens.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…profiles The backend flipped canonical filter operators to the terse set (eq, neq, in, nin, gt, gte, lt, lte, contains, startsWith, endsWith, notEmpty, isEmpty). Sync openapi.json from the backend spec (semantically identical), rewrite the profiles operator tables/examples, and correct the earlier "aliases return 400" framing: the 8 long-form spellings remain accepted on /v0/profiles as deprecated aliases folded at the boundary (retirement deferred to P-2373 Phase B). Also sweeps create-chart, analytics CLI, event-timeseries, funnel, and idempotency pages that disagreed with the terse-only analytics endpoints. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Formo API's canonical filter-operator vocabulary is now the terse set:
eq, neq, in, nin, gt, gte, lt, lte, contains, startsWith, endsWith, notEmpty, isEmpty. This PR brings the docs in line:FilterCondition(POST /v0/profiles) additionally accepts the long-form spellings (equals,notEquals,greater,greaterOrEqual,less,lessOrEqual,notIn,includes) as deprecated aliases folded to canonical at the boundary — the flip is non-breaking on /v0/profiles. Other /v0 analytics filter schemas are terse-only. Adds the value-less existence opsnotEmpty/isEmptythroughout.{operand, operator}query dialect keeps its long-form tokens per the spec.Validated with
mintlify validate; openapi.json verified semantically identical to the backend spec.🤖 Generated with Claude Code