diff --git a/doc/compiled.json b/doc/compiled.json index bf255f734..26c652326 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -3121,6 +3121,11 @@ } } }, + "translation_query": { + "type": "string", + "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of translation ids\n* `key.id:key_id,...` for queries on a comma-separated list of translation key ids\n* `key.name:key_name,...` for queries on a comma-separated list of translation key names\n* `locale.id:locale_id,...` for queries on a comma-separated list of locale ids\n* `locale.name:locale_name,...` for queries on a comma-separated list of locale names\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n* `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp\n\nFind more examples [here](/en/api/strings/usage-examples).\n", + "example": "key.name:home.title,home.subtitle locale.name:de-DE tags:feature" + }, "translation_version": { "type": "object", "title": "translation_version", @@ -5821,6 +5826,33 @@ "type": "string" } }, + "translations_q": { + "in": "query", + "name": "q", + "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of translation ids\n* `key.id:key_id,...` for queries on a comma-separated list of translation key ids\n* `key.name:key_name,...` for queries on a comma-separated list of translation key names\n* `locale.id:locale_id,...` for queries on a comma-separated list of locale ids\n* `locale.name:locale_name,...` for queries on a comma-separated list of locale names\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n* `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp\n\nFind more examples [here](/en/api/strings/usage-examples).\n", + "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center", + "schema": { + "type": "string" + } + }, + "translations_locale_q": { + "in": "query", + "name": "q", + "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of translation ids\n* `key.id:key_id,...` for queries on a comma-separated list of translation key ids\n* `key.name:key_name,...` for queries on a comma-separated list of translation key names\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n* `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp\n\nFind more examples [here](/en/api/strings/usage-examples).\n", + "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center", + "schema": { + "type": "string" + } + }, + "translations_key_q": { + "in": "query", + "name": "q", + "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of translation ids\n* `locale.id:locale_id,...` for queries on a comma-separated list of locale ids\n* `locale.name:locale_name,...` for queries on a comma-separated list of locale names\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n* `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp\n\nFind more examples [here](/en/api/strings/usage-examples).\n", + "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center", + "schema": { + "type": "string" + } + }, "job_owner": { "description": "filter by user owning job", "example": "abcd1234cdef1234abcd1234cdef1234", @@ -28258,13 +28290,7 @@ } }, { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n* `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center", - "name": "q", - "in": "query", - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/translations_q" } ], "responses": { @@ -28512,13 +28538,7 @@ } }, { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n- `id:translation_id,...` for queries on a comma-separated list of ids\n- `unverified:{true|false}` for verification status\n- `tags:XYZ` for tags on the translation\n- `excluded:{true|false}` for exclusion status\n- `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center", - "name": "q", - "in": "query", - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/translations_locale_q" } ], "responses": { @@ -28634,13 +28654,7 @@ } }, { - "description": "Specify a query to find translations by content (including wildcards).\n\nThe following qualifiers are supported in the query:\n\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `unverified:{true|false}` for verification status\n* `tags:XYZ` for tags on the translation\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center", - "name": "q", - "in": "query", - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/translations_key_q" } ], "responses": { @@ -28805,9 +28819,7 @@ "example": "desc" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n\n- `id:translation_id,...` for queries on a comma-separated list of ids\n- `tags:XYZ` for tags on the translation\n- `unverified:{true|false}` for verification status\n- `excluded:{true|false}` for exclusion status\n- `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" } } } @@ -29661,9 +29673,7 @@ "example": "fc2f11dd6a658fa9652f6f0a9ebee688" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%20unverified:true%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" } } } @@ -29676,7 +29686,7 @@ "/projects/{project_id}/translations/unverify": { "patch": { "summary": "Unverify translations by query", - "description": "Mark translations matching query as unverified.", + "description": "Mark translations matching query as unverified.\n\nTo unverify the translations of specific keys, filter by key id (and optionally locale) directly, for example `key.id:KEY_ID_1,KEY_ID_2 locale.id:LOCALE_ID`. There is no need to look up translation ids first.\n", "operationId": "translations/unverify-collection", "tags": [ "Translations" @@ -29755,9 +29765,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%20verified:true%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" }, "sort": { "description": "Sort criteria. Can be one of: key_name, created_at, updated_at.", @@ -29859,9 +29867,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%reviewed:false%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" } } } @@ -29953,9 +29959,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%reviewed:true%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" } } } @@ -30044,9 +30048,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n\n* `id:translation_id,...` for queries on a comma-separated list of ids\n* `tags:XYZ` for tags on the translation\n* `unverified:{true|false}` for verification status\n* `excluded:{true|false}` for exclusion status\n* `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%20verified:true%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" }, "sort": { "description": "Sort criteria. Can be one of: key_name, created_at, updated_at.", @@ -30145,9 +30147,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to find translations by content (including wildcards).\n\n*Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*\n\nThe following qualifiers are supported in the query:\n- `id:translation_id,...` for queries on a comma-separated list of ids\n- `tags:XYZ` for tags on the translation\n- `unverified:{true|false}` for verification status\n- `excluded:{true|false}` for exclusion status\n- `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries\n\nFind more examples [here](/en/api/strings/usage-examples).\n", - "type": "string", - "example": "PhraseApp*%20verified:true%20tags:feature,center" + "$ref": "#/components/schemas/translation_query" }, "sort": { "description": "Sort criteria. Can be one of: key_name, created_at, updated_at.", diff --git a/parameters.yaml b/parameters.yaml index 048cd2972..027224435 100644 --- a/parameters.yaml +++ b/parameters.yaml @@ -286,6 +286,74 @@ q: in: query schema: type: string +translations_q: + in: query + name: q + description: | + Specify a query to find translations by content (including wildcards). + + *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* + + The following qualifiers are supported in the query: + * `id:translation_id,...` for queries on a comma-separated list of translation ids + * `key.id:key_id,...` for queries on a comma-separated list of translation key ids + * `key.name:key_name,...` for queries on a comma-separated list of translation key names + * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids + * `locale.name:locale_name,...` for queries on a comma-separated list of locale names + * `tags:XYZ` for tags on the translation + * `unverified:{true|false}` for verification status + * `excluded:{true|false}` for exclusion status + * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries + * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp + + Find more examples [here](/en/api/strings/usage-examples). + example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center + schema: + type: string +translations_locale_q: + in: query + name: q + description: | + Specify a query to find translations by content (including wildcards). + + *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* + + The following qualifiers are supported in the query: + * `id:translation_id,...` for queries on a comma-separated list of translation ids + * `key.id:key_id,...` for queries on a comma-separated list of translation key ids + * `key.name:key_name,...` for queries on a comma-separated list of translation key names + * `tags:XYZ` for tags on the translation + * `unverified:{true|false}` for verification status + * `excluded:{true|false}` for exclusion status + * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries + * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp + + Find more examples [here](/en/api/strings/usage-examples). + example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center + schema: + type: string +translations_key_q: + in: query + name: q + description: | + Specify a query to find translations by content (including wildcards). + + *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* + + The following qualifiers are supported in the query: + * `id:translation_id,...` for queries on a comma-separated list of translation ids + * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids + * `locale.name:locale_name,...` for queries on a comma-separated list of locale names + * `tags:XYZ` for tags on the translation + * `unverified:{true|false}` for verification status + * `excluded:{true|false}` for exclusion status + * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries + * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp + + Find more examples [here](/en/api/strings/usage-examples). + example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center + schema: + type: string job_owner: description: filter by user owning job example: abcd1234cdef1234abcd1234cdef1234 diff --git a/paths/translations/batch_exclude.yaml b/paths/translations/batch_exclude.yaml index 6623c35a4..63a1464a6 100644 --- a/paths/translations/batch_exclude.yaml +++ b/paths/translations/batch_exclude.yaml @@ -59,22 +59,7 @@ requestBody: type: string example: my-feature-branch q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - - * `id:translation_id,...` for queries on a comma-separated list of ids - * `tags:XYZ` for tags on the translation - * `unverified:{true|false}` for verification status - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%20verified:true%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" sort: description: 'Sort criteria. Can be one of: key_name, created_at, updated_at.' type: string diff --git a/paths/translations/batch_include.yaml b/paths/translations/batch_include.yaml index 1d83f0249..41debfe64 100644 --- a/paths/translations/batch_include.yaml +++ b/paths/translations/batch_include.yaml @@ -59,21 +59,7 @@ requestBody: type: string example: my-feature-branch q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - - `id:translation_id,...` for queries on a comma-separated list of ids - - `tags:XYZ` for tags on the translation - - `unverified:{true|false}` for verification status - - `excluded:{true|false}` for exclusion status - - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%20verified:true%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" sort: description: 'Sort criteria. Can be one of: key_name, created_at, updated_at.' type: string diff --git a/paths/translations/batch_review.yaml b/paths/translations/batch_review.yaml index 39d9a8a19..cc0cac965 100644 --- a/paths/translations/batch_review.yaml +++ b/paths/translations/batch_review.yaml @@ -61,20 +61,5 @@ requestBody: type: string example: my-feature-branch q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - - * `id:translation_id,...` for queries on a comma-separated list of ids - * `tags:XYZ` for tags on the translation - * `unverified:{true|false}` for verification status - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%reviewed:false%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" x-cli-version: '2.5' diff --git a/paths/translations/batch_unreview.yaml b/paths/translations/batch_unreview.yaml index 62558d80a..24297c3db 100644 --- a/paths/translations/batch_unreview.yaml +++ b/paths/translations/batch_unreview.yaml @@ -60,19 +60,5 @@ requestBody: type: string example: my-feature-branch q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - * `id:translation_id,...` for queries on a comma-separated list of ids - * `tags:XYZ` for tags on the translation - * `unverified:{true|false}` for verification status - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%reviewed:true%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" x-cli-version: '2.41' diff --git a/paths/translations/batch_unverify.yaml b/paths/translations/batch_unverify.yaml index c33a527b2..5eca131f5 100644 --- a/paths/translations/batch_unverify.yaml +++ b/paths/translations/batch_unverify.yaml @@ -1,6 +1,9 @@ --- summary: Unverify translations by query -description: Mark translations matching query as unverified. +description: | + Mark translations matching query as unverified. + + To unverify the translations of specific keys, filter by key id (and optionally locale) directly, for example `key.id:KEY_ID_1,KEY_ID_2 locale.id:LOCALE_ID`. There is no need to look up translation ids first. operationId: translations/unverify-collection tags: - Translations @@ -61,21 +64,7 @@ requestBody: type: string example: my-feature-branch q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - * `id:translation_id,...` for queries on a comma-separated list of ids - * `tags:XYZ` for tags on the translation - * `unverified:{true|false}` for verification status - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%20verified:true%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" sort: description: 'Sort criteria. Can be one of: key_name, created_at, updated_at.' type: string diff --git a/paths/translations/batch_verify.yaml b/paths/translations/batch_verify.yaml index 8fc68d363..bc624c8ef 100644 --- a/paths/translations/batch_verify.yaml +++ b/paths/translations/batch_verify.yaml @@ -65,19 +65,5 @@ requestBody: type: string example: fc2f11dd6a658fa9652f6f0a9ebee688 q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - * `id:translation_id,...` for queries on a comma-separated list of ids - * `tags:XYZ` for tags on the translation - * `unverified:{true|false}` for verification status - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%20unverified:true%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" x-cli-version: '2.5' diff --git a/paths/translations/index.yaml b/paths/translations/index.yaml index e3eccfc6c..34d84f60c 100644 --- a/paths/translations/index.yaml +++ b/paths/translations/index.yaml @@ -44,26 +44,7 @@ parameters: in: query schema: type: string -- description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - - * `id:translation_id,...` for queries on a comma-separated list of ids - * `tags:XYZ` for tags on the translation - * `unverified:{true|false}` for verification status - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp - - Find more examples [here](/en/api/strings/usage-examples). - example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center - name: q - in: query - schema: - type: string +- "$ref": "../../parameters.yaml#/translations_q" responses: '200': description: OK diff --git a/paths/translations/index_keys.yaml b/paths/translations/index_keys.yaml index 1828c2467..e8a35f19e 100644 --- a/paths/translations/index_keys.yaml +++ b/paths/translations/index_keys.yaml @@ -28,23 +28,7 @@ parameters: in: query schema: type: string -- description: | - Specify a query to find translations by content (including wildcards). - - The following qualifiers are supported in the query: - - * `id:translation_id,...` for queries on a comma-separated list of ids - * `unverified:{true|false}` for verification status - * `tags:XYZ` for tags on the translation - * `excluded:{true|false}` for exclusion status - * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center - name: q - in: query - schema: - type: string +- "$ref": "../../parameters.yaml#/translations_key_q" responses: '200': description: OK diff --git a/paths/translations/index_locale.yaml b/paths/translations/index_locale.yaml index dbc7d821e..6ba3c1778 100644 --- a/paths/translations/index_locale.yaml +++ b/paths/translations/index_locale.yaml @@ -29,24 +29,7 @@ parameters: in: query schema: type: string -- description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - - `id:translation_id,...` for queries on a comma-separated list of ids - - `unverified:{true|false}` for verification status - - `tags:XYZ` for tags on the translation - - `excluded:{true|false}` for exclusion status - - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center - name: q - in: query - schema: - type: string +- "$ref": "../../parameters.yaml#/translations_locale_q" responses: '200': description: OK diff --git a/paths/translations/search.yaml b/paths/translations/search.yaml index 3a589237d..8ff46801d 100644 --- a/paths/translations/search.yaml +++ b/paths/translations/search.yaml @@ -73,20 +73,5 @@ requestBody: type: string example: desc q: - description: | - Specify a query to find translations by content (including wildcards). - - *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* - - The following qualifiers are supported in the query: - - - `id:translation_id,...` for queries on a comma-separated list of ids - - `tags:XYZ` for tags on the translation - - `unverified:{true|false}` for verification status - - `excluded:{true|false}` for exclusion status - - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - - Find more examples [here](/en/api/strings/usage-examples). - type: string - example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center + "$ref": "../../schemas/translation_query.yaml#/translation_query" x-cli-version: '2.5' diff --git a/schemas.yaml b/schemas.yaml index 10dd2a2bb..7765a2245 100644 --- a/schemas.yaml +++ b/schemas.yaml @@ -102,6 +102,8 @@ schemas: "$ref": schemas/translation_order.yaml#/translation_order pre_translation: "$ref": schemas/pre_translation.yaml#/pre_translation + translation_query: + "$ref": schemas/translation_query.yaml#/translation_query translation_version: "$ref": schemas/translation_version.yaml#/translation_version translation_version_with_user: diff --git a/schemas/translation_query.yaml b/schemas/translation_query.yaml new file mode 100644 index 000000000..107056503 --- /dev/null +++ b/schemas/translation_query.yaml @@ -0,0 +1,22 @@ +--- +translation_query: + type: string + description: | + Specify a query to find translations by content (including wildcards). + + *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* + + The following qualifiers are supported in the query: + * `id:translation_id,...` for queries on a comma-separated list of translation ids + * `key.id:key_id,...` for queries on a comma-separated list of translation key ids + * `key.name:key_name,...` for queries on a comma-separated list of translation key names + * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids + * `locale.name:locale_name,...` for queries on a comma-separated list of locale names + * `tags:XYZ` for tags on the translation + * `unverified:{true|false}` for verification status + * `excluded:{true|false}` for exclusion status + * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries + * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp + + Find more examples [here](/en/api/strings/usage-examples). + example: key.name:home.title,home.subtitle locale.name:de-DE tags:feature