docs: Mention passing name instead of locale ID (#404)

phrase · Sep 6, 2023 · 80c87aa · 80c87aa
1 parent 3e663d9
commit 80c87aa
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 8 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -4164,6 +4164,15 @@
           "type": "string"
         }
       },
+      "locale_id_as_id": {
+        "in": "path",
+        "name": "id",
+        "description": "Locale ID or locale name",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      },
       "gitlab_sync_id": {
         "in": "path",
         "name": "gitlab_sync_id",
@@ -6544,7 +6553,7 @@
             "$ref": "#/components/parameters/project_id"
           },
           {
-            "$ref": "#/components/parameters/id"
+            "$ref": "#/components/parameters/locale_id_as_id"
           },
           {
             "description": "specify the branch to use",
@@ -6615,7 +6624,7 @@
             "$ref": "#/components/parameters/project_id"
           },
           {
-            "$ref": "#/components/parameters/id"
+            "$ref": "#/components/parameters/locale_id_as_id"
           }
         ],
         "responses": {
@@ -6745,7 +6754,7 @@
             "$ref": "#/components/parameters/project_id"
           },
           {
-            "$ref": "#/components/parameters/id"
+            "$ref": "#/components/parameters/locale_id_as_id"
           },
           {
             "description": "specify the branch to use",
@@ -6806,7 +6815,7 @@
             "$ref": "#/components/parameters/project_id"
           },
           {
-            "$ref": "#/components/parameters/id"
+            "$ref": "#/components/parameters/locale_id_as_id"
           },
           {
             "description": "specify the branch to use",

diff --git a/parameters.yaml b/parameters.yaml
@@ -136,6 +136,13 @@ locale_id:
   required: true
   schema:
     type: string
+locale_id_as_id:
+  in: path
+  name: id
+  description: Locale ID or locale name
+  required: true
+  schema:
+    type: string
 gitlab_sync_id:
   in: path
   name: gitlab_sync_id

diff --git a/paths/locales/destroy.yaml b/paths/locales/destroy.yaml
@@ -7,7 +7,7 @@ tags:
 parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
-- "$ref": "../../parameters.yaml#/id"
+- "$ref": "../../parameters.yaml#/locale_id_as_id"
 - description: specify the branch to use
   example: my-feature-branch
   name: branch

diff --git a/paths/locales/download.yaml b/paths/locales/download.yaml
@@ -9,7 +9,7 @@ parameters:
   - "$ref": "../../parameters.yaml#/If-Modified-Since"
   - "$ref": "../../parameters.yaml#/If-None-Match"
   - "$ref": "../../parameters.yaml#/project_id"
-  - "$ref": "../../parameters.yaml#/id"
+  - "$ref": "../../parameters.yaml#/locale_id_as_id"
   - description: specify the branch to use
     example: my-feature-branch
     name: branch

diff --git a/paths/locales/show.yaml b/paths/locales/show.yaml
@@ -7,7 +7,7 @@ tags:
 parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
-- "$ref": "../../parameters.yaml#/id"
+- "$ref": "../../parameters.yaml#/locale_id_as_id"
 - description: specify the branch to use
   example: my-feature-branch
   name: branch

diff --git a/paths/locales/update.yaml b/paths/locales/update.yaml
@@ -7,7 +7,7 @@ tags:
 parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
-- "$ref": "../../parameters.yaml#/id"
+- "$ref": "../../parameters.yaml#/locale_id_as_id"
 responses:
   '200':
     description: OK