docs: generate API reference for 2.12.3 (#14341)

2025-12-17 18:19:46 +02:00
parent c0ec54fc15
commit 52e965f411
134 changed files with 7706 additions and 12 deletions
@@ -0,0 +1,155 @@
+get:
+  operationId: GetLocales
+  summary: List Locales
+  description: >-
+    Retrieve a list of locales. The locales can be filtered by fields such as
+    `code`. The locales can also be sorted or paginated.
+  x-authenticated: true
+  parameters:
+    - name: q
+      in: query
+      description: Search query to filter locales by code or other fields.
+      required: false
+      schema:
+        type: string
+        title: q
+        description: Search query to filter locales by code or other fields.
+    - name: code
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: code
+            description: Filter locales by a code.
+          - type: array
+            description: Filter locales by multiple codes.
+            items:
+              type: string
+              title: code
+              description: A locale code.
+    - name: limit
+      in: query
+      description: Limit the number of items returned in the list.
+      required: false
+      schema:
+        type: number
+        title: limit
+        description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
+    - name: offset
+      in: query
+      description: The number of items to skip when retrieving a list.
+      required: false
+      schema:
+        type: number
+        title: offset
+        description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
+    - name: order
+      in: query
+      description: >-
+        The field to sort the data by. By default, the sort order is ascending.
+        To change the order to descending, prefix the field name with `-`.
+      required: false
+      schema:
+        type: string
+        title: order
+        description: >-
+          The field to sort the data by. By default, the sort order is
+          ascending. To change the order to descending, prefix the field name
+          with `-`.
+        externalDocs:
+          url: '#pagination'
+    - name: with_deleted
+      in: query
+      description: The locale's with deleted.
+      required: false
+      schema:
+        type: boolean
+        title: with_deleted
+        description: The locale's with deleted.
+    - name: fields
+      in: query
+      description: >-
+        Comma-separated fields that should be included in the returned data. If
+        a field is prefixed with `+` it will be added to the default fields,
+        using `-` will remove it from the default fields. Without prefix it will
+        replace the entire default fields.
+      required: false
+      schema:
+        type: string
+        title: fields
+        description: >-
+          Comma-separated fields that should be included in the returned data.
+          If a field is prefixed with `+` it will be added to the default
+          fields, using `-` will remove it from the default fields. Without
+          prefix it will replace the entire default fields.
+        externalDocs:
+          url: '#select-fields-and-relations'
+    - name: $and
+      in: query
+      description: >-
+        Join query parameters with an AND condition. Each object's content is
+        the same type as the expected query parameters.
+      required: false
+      schema:
+        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
+    - name: $or
+      in: query
+      description: >-
+        Join query parameters with an OR condition. Each object's content is the
+        same type as the expected query parameters.
+      required: false
+      schema:
+        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
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS SDK
+      source:
+        $ref: ../code_samples/JavaScript/admin_locales/get.js
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_locales/get.sh
+  tags:
+    - Locales
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminLocaleListResponse.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
+  x-since: 2.12.3
+  x-featureFlag: translation