chore: update API reference for 2.10.2 (#13499)

2025-09-15 12:30:09 +03:00
parent 2657f9c196
commit b35b1b41a4
31 changed files with 838 additions and 0 deletions
@@ -511,6 +511,135 @@
 *       type: boolean
 *       title: with_deleted
 *       description: Whether to include deleted records in the result.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     description: Filter by a promotion's ID.
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: Filter by a promotion's ID.
+ *         - type: array
+ *           description: Filter by promotion IDs.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The promotion's ID.
+ *         - type: object
+ *           description: Filter by a promotion's ID.
+ *           properties:
+ *             $and:
+ *               type: array
+ *               description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
+ *               items:
+ *                 type: object
+ *               title: $and
+ *             $or:
+ *               type: array
+ *               description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
+ *               items:
+ *                 type: object
+ *               title: $or
+ *             $eq:
+ *               oneOf:
+ *                 - type: string
+ *                   title: $eq
+ *                   description: Filter by an exact match.
+ *                 - type: array
+ *                   description: Filter by an exact match.
+ *                   items:
+ *                     type: string
+ *                     title: $eq
+ *                     description: Filter by an exact match.
+ *             $ne:
+ *               type: string
+ *               title: $ne
+ *               description: Filter by values not equal to this parameter.
+ *             $in:
+ *               type: array
+ *               description: Filter by values in this array.
+ *               items:
+ *                 type: string
+ *                 title: $in
+ *                 description: Filter by values in this array.
+ *             $nin:
+ *               type: array
+ *               description: Filter by values not in this array.
+ *               items:
+ *                 type: string
+ *                 title: $nin
+ *                 description: Filter by values not in this array.
+ *             $not:
+ *               oneOf:
+ *                 - type: string
+ *                   title: $not
+ *                   description: Filter by values not matching the conditions in this parameter.
+ *                 - type: object
+ *                   description: Filter by values not matching the conditions in this parameter.
+ *                 - type: array
+ *                   description: Filter by values not matching the conditions in this parameter.
+ *                   items:
+ *                     type: string
+ *                     title: $not
+ *                     description: Filter by values not matching the conditions in this parameter.
+ *             $gt:
+ *               type: string
+ *               title: $gt
+ *               description: Filter by values greater than this parameter. Useful for numbers and dates only.
+ *             $gte:
+ *               type: string
+ *               title: $gte
+ *               description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
+ *             $lt:
+ *               type: string
+ *               title: $lt
+ *               description: Filter by values less than this parameter. Useful for numbers and dates only.
+ *             $lte:
+ *               type: string
+ *               title: $lte
+ *               description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
+ *             $like:
+ *               type: string
+ *               title: $like
+ *               description: Apply a `like` filter. Useful for strings only.
+ *             $re:
+ *               type: string
+ *               title: $re
+ *               description: Apply a regex filter. Useful for strings only.
+ *             $ilike:
+ *               type: string
+ *               title: $ilike
+ *               description: Apply a case-insensitive `like` filter. Useful for strings only.
+ *             $fulltext:
+ *               type: string
+ *               title: $fulltext
+ *               description: Filter to apply on full-text properties.
+ *             $overlap:
+ *               type: array
+ *               description: Filter arrays that have overlapping values with this parameter.
+ *               items:
+ *                 type: string
+ *                 title: $overlap
+ *                 description: Filter arrays that have overlapping values with this parameter.
+ *             $contains:
+ *               type: array
+ *               description: Filter arrays that contain some of the values of this parameter.
+ *               items:
+ *                 type: string
+ *                 title: $contains
+ *                 description: Filter arrays that contain some of the values of this parameter.
+ *             $contained:
+ *               type: array
+ *               description: Filter arrays that contain all values of this parameter.
+ *               items:
+ *                 type: string
+ *                 title: $contained
+ *                 description: Filter arrays that contain all values of this parameter.
+ *             $exists:
+ *               type: boolean
+ *               title: $exists
+ *               description: Filter by whether a value for this parameter exists (not `null`).
 * security:
 *   - api_token: []
 *   - cookie_auth: []