Document tags_all/tags_any/tags_none in openapi.yaml, deprecate aliases

Add the three tag-filter parameters to both listAssets and
getAssetTagHistogram parameter blocks and mark include_tags/exclude_tags
deprecated: true, keeping the spec in step with the runtime schemas so
generated clients can discover the new filters while the aliases stay
present for existing consumers.
This commit is contained in:
Simon Pinfold
2026-08-05 13:20:02 -07:00
parent e204ab9f84
commit e3ec8202e5

View File

@@ -1521,7 +1521,8 @@ paths:
Supports filtering by tags, name, metadata, and sorting options.
operationId: listAssets
parameters:
- description: Filter assets that have ALL of these tags
- deprecated: true
description: 'Deprecated alias of tags_all: filter assets that have ALL of these tags'
explode: false
in: query
name: include_tags
@@ -1530,7 +1531,8 @@ paths:
type: string
type: array
style: form
- description: Exclude assets that have ANY of these tags
- deprecated: true
description: 'Deprecated alias of tags_none: exclude assets that have ANY of these tags'
explode: false
in: query
name: exclude_tags
@@ -1539,6 +1541,33 @@ paths:
type: string
type: array
style: form
- description: Filter assets that have ALL of these tags
explode: false
in: query
name: tags_all
schema:
items:
type: string
type: array
style: form
- description: Filter assets that have AT LEAST ONE of these tags
explode: false
in: query
name: tags_any
schema:
items:
type: string
type: array
style: form
- description: Exclude assets that have ANY of these tags
explode: false
in: query
name: tags_none
schema:
items:
type: string
type: array
style: form
- description: Filter assets where name contains this substring (case-insensitive)
in: query
name: name_contains
@@ -2312,7 +2341,8 @@ paths:
Only returns tags with non-zero counts (tags that exist on matching assets).
operationId: getAssetTagHistogram
parameters:
- description: Filter assets that have ALL of these tags
- deprecated: true
description: 'Deprecated alias of tags_all: filter assets that have ALL of these tags'
explode: false
in: query
name: include_tags
@@ -2321,7 +2351,8 @@ paths:
type: string
type: array
style: form
- description: Exclude assets that have ANY of these tags
- deprecated: true
description: 'Deprecated alias of tags_none: exclude assets that have ANY of these tags'
explode: false
in: query
name: exclude_tags
@@ -2330,6 +2361,33 @@ paths:
type: string
type: array
style: form
- description: Filter assets that have ALL of these tags
explode: false
in: query
name: tags_all
schema:
items:
type: string
type: array
style: form
- description: Filter assets that have AT LEAST ONE of these tags
explode: false
in: query
name: tags_any
schema:
items:
type: string
type: array
style: form
- description: Exclude assets that have ANY of these tags
explode: false
in: query
name: tags_none
schema:
items:
type: string
type: array
style: form
- description: Filter assets where name contains this substring (case-insensitive)
in: query
name: name_contains