Document exclude system tags param (#680)

On our tags endpoint there is an undocumented param to exclude tags from the results. Lets make it public.
phrase · Sep 3, 2024 · b812154 · b812154
1 parent cf45164
commit b812154
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 22 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -20404,6 +20404,15 @@
           {
             "$ref": "#/components/parameters/per_page"
           },
+          {
+            "description": "excludes tags generated by the system, e.g. job, upload or figma tags",
+            "name": "exclude_system_tags",
+            "example": true,
+            "in": "query",
+            "schema": {
+              "type": "boolean"
+            }
+          },
           {
             "description": "specify the branch to use",
             "example": "my-feature-branch",

diff --git a/paths/tags/index.yaml b/paths/tags/index.yaml
@@ -1,20 +1,25 @@
----
 summary: List tags
 description: List all tags for the given project.
 operationId: tags/list
 tags:
-- Tags
+  - Tags
 parameters:
-- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
-- "$ref": "../../parameters.yaml#/project_id"
-- "$ref": "../../parameters.yaml#/page"
-- "$ref": "../../parameters.yaml#/per_page"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
+  - "$ref": "../../parameters.yaml#/project_id"
+  - "$ref": "../../parameters.yaml#/page"
+  - "$ref": "../../parameters.yaml#/per_page"
+  - description: excludes tags generated by the system, e.g. job, upload or figma tags
+    name: exclude_system_tags
+    example: true
+    in: query
+    schema:
+      type: boolean
+  - description: specify the branch to use
+    example: my-feature-branch
+    name: branch
+    in: query
+    schema:
+      type: string
 responses:
   '200':
     description: OK
@@ -42,14 +47,14 @@ responses:
   '429':
     "$ref": "../../responses.yaml#/429"
 x-code-samples:
-- lang: Curl
-  source: |-
-    curl "https://api.phrase.com/v2/projects/:project_id/tags?branch=my-feature-branch" \
-      -u USERNAME_OR_ACCESS_TOKEN
-- lang: CLI v2
-  source: |-
-    phrase tags list \
-    --project_id <project_id> \
-    --branch my-feature-branch \
-    --access_token <token>
+  - lang: Curl
+    source: |-
+      curl "https://api.phrase.com/v2/projects/:project_id/tags?branch=my-feature-branch" \
+        -u USERNAME_OR_ACCESS_TOKEN
+  - lang: CLI v2
+    source: |-
+      phrase tags list \
+      --project_id <project_id> \
+      --branch my-feature-branch \
+      --access_token <token>
 x-cli-version: '2.5'