From fc6270e7017cc7e99082729140cc156999ed9aef Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Thu, 6 Feb 2025 09:05:56 +0100 Subject: [PATCH] doc(API): unmentioned_in multiple uploads works too #STRINGS-1379 --- doc/compiled.json | 35 ++++++++++++++---------------- parameters.yaml | 22 +++++++++++++++++++ paths/keys/destroy-collection.yaml | 21 +----------------- paths/keys/exclude.yaml | 2 +- paths/keys/include.yaml | 2 +- paths/keys/index.yaml | 20 +---------------- paths/keys/search.yaml | 2 +- paths/keys/tag.yaml | 2 +- paths/keys/untag.yaml | 2 +- 9 files changed, 45 insertions(+), 63 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index 0cb78d3e7..3b484325c 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -4694,6 +4694,15 @@ "schema": { "type": "string" } + }, + "q": { + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\n
\n

Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

\n
\nFind more examples here.\n", + "example": "mykey* translated:true", + "name": "q", + "in": "query", + "schema": { + "type": "string" + } } }, "responses": { @@ -19950,13 +19959,7 @@ } }, { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", - "example": "mykey* translated:true", - "name": "q", - "in": "query", - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/q" }, { "description": "Locale used to determine the translation state of a key when filtering for untranslated or translated keys.", @@ -20216,13 +20219,7 @@ } }, { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\n
\n

Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

\n
\nFind more examples here.\n", - "example": "mykey* translated:true", - "name": "q", - "in": "query", - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/q" }, { "description": "Locale used to determine the translation state of a key when filtering for untranslated or translated keys.", @@ -20373,7 +20370,7 @@ "example": "desc" }, "q": { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\nPlease note: If tags are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.\n", + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\nPlease note: If tags are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.\n", "type": "string", "example": "mykey* translated:true" }, @@ -20749,7 +20746,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", "type": "string", "example": "mykey* translated:true" }, @@ -20843,7 +20840,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", "type": "string", "example": "mykey* translated:true" }, @@ -20937,7 +20934,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", "type": "string", "example": "mykey* translated:true" }, @@ -21031,7 +21028,7 @@ "example": "my-feature-branch" }, "q": { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n\nFind more examples here.\n", "type": "string", "example": "mykey* translated:true" }, diff --git a/parameters.yaml b/parameters.yaml index 143807527..13715ca5e 100644 --- a/parameters.yaml +++ b/parameters.yaml @@ -239,3 +239,25 @@ response_status_codes: required: false schema: type: string +q: + description: | + Specify a query to do broad search for keys by name (including wildcards).

+ The following qualifiers are also supported in the search term:
+ +
+

Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

+
+ Find more examples here. + example: mykey* translated:true + name: q + in: query + schema: + type: string + diff --git a/paths/keys/destroy-collection.yaml b/paths/keys/destroy-collection.yaml index 7d4fa4ae4..408739e7f 100644 --- a/paths/keys/destroy-collection.yaml +++ b/paths/keys/destroy-collection.yaml @@ -13,26 +13,7 @@ parameters: in: query schema: type: string -- description: | - Specify a query to do broad search for keys by name (including wildcards).

- The following qualifiers are also supported in the search term:
- -
-

Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

-
- Find more examples here. - example: mykey* translated:true - name: q - in: query - schema: - type: string +- "$ref": "../../parameters.yaml#/q" - description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys. example: abcd1234abcd1234abcd1234abcd1234 name: locale_id diff --git a/paths/keys/exclude.yaml b/paths/keys/exclude.yaml index 9c373f87a..4fd69ffae 100644 --- a/paths/keys/exclude.yaml +++ b/paths/keys/exclude.yaml @@ -63,7 +63,7 @@ requestBody:
  • tags:tag_name to filter for keys with certain tags
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • -
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • +
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads
    • Find more examples here. type: string diff --git a/paths/keys/include.yaml b/paths/keys/include.yaml index 89830765c..54fd2ef0c 100644 --- a/paths/keys/include.yaml +++ b/paths/keys/include.yaml @@ -63,7 +63,7 @@ requestBody:
  • tags:tag_name to filter for keys with certain tags
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • -
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • +
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads
    • Find more examples here. type: string diff --git a/paths/keys/index.yaml b/paths/keys/index.yaml index 882632424..eb020162e 100644 --- a/paths/keys/index.yaml +++ b/paths/keys/index.yaml @@ -27,25 +27,7 @@ parameters: in: query schema: type: string -- description: | - Specify a query to do broad search for keys by name (including wildcards).

    - The following qualifiers are also supported in the search term:
    - - Find more examples here. - example: mykey* translated:true - name: q - in: query - schema: - type: string +- "$ref": "../../parameters.yaml#/q" - description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys. example: abcd1234abcd1234abcd1234abcd1234 name: locale_id diff --git a/paths/keys/search.yaml b/paths/keys/search.yaml index 9807363a0..cc36276ee 100644 --- a/paths/keys/search.yaml +++ b/paths/keys/search.yaml @@ -79,7 +79,7 @@ requestBody:
  • job:{true|false} to filter for keys mentioned in an active job
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • -
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • +
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads
    • Find more examples here. Please note: If tags are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. diff --git a/paths/keys/tag.yaml b/paths/keys/tag.yaml index f7f93dac3..208f9fc3b 100644 --- a/paths/keys/tag.yaml +++ b/paths/keys/tag.yaml @@ -63,7 +63,7 @@ requestBody:
  • tags:tag_name to filter for keys with certain tags
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • -
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • +
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads
    • Find more examples here. type: string diff --git a/paths/keys/untag.yaml b/paths/keys/untag.yaml index 13efe482e..216563a78 100644 --- a/paths/keys/untag.yaml +++ b/paths/keys/untag.yaml @@ -63,7 +63,7 @@ requestBody:
  • tags:tag_name to filter for keys with certain tags
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • -
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • +
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads
    • Find more examples here. type: string