@labeleer/api 1.0.0 → 1.0.1

package/openapi.yaml

@@ -0,0 +1,2181 @@
+openapi: 3.1.0
+info:
+  title: Labeleer API
+  version: 1.0.0
+paths:
+  /api/invitations:
+    get:
+      operationId: getInvitations
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetInvitationsResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    post:
+      operationId: respondToInvitation
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                invitationId:
+                  type: string
+                status:
+                  type: string
+                  enum:
+                    - accepted
+                    - declined
+              required:
+                - invitationId
+                - status
+      responses:
+        "201":
+          description: Resource Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/project/{projectId}/access-token:
+    post:
+      operationId: createAccessToken
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                permissions:
+                  type: object
+                  properties:
+                    translations:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+                    languages:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+                    collaborators:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+                    project:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+              required:
+                - permissions
+      responses:
+        "201":
+          description: Resource Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateAccessTokenResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    delete:
+      operationId: revokeAccessToken
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    patch:
+      operationId: updateAccessToken
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                permissions:
+                  type: object
+                  properties:
+                    translations:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+                    languages:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+                    collaborators:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+                    project:
+                      type: string
+                      enum:
+                        - viewer
+                        - editor
+              required:
+                - permissions
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/UpdateAccessTokenResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/project/{projectId}/invite:
+    post:
+      operationId: inviteUserToProject
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  type: string
+                  format: email
+                  pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
+              required:
+                - email
+      responses:
+        "201":
+          description: Resource Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/project/{projectId}:
+    put:
+      operationId: updateProject
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateProjectResponse"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    delete:
+      operationId: deleteProject
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/project/{projectId}/users/{userId}:
+    get:
+      operationId: getUserProjectPermissions
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: userId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetUserPermissionsResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    put:
+      operationId: updateUserPermissions
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: userId
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateUserPermissionsRequestBody"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    delete:
+      operationId: removeUserFromProject
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: userId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/project:
+    get:
+      operationId: getProjects
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetProjectsResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    post:
+      operationId: createProject
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateProjectRequest"
+      responses:
+        "201":
+          description: Resource Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateProjectResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/translation/generate:
+    post:
+      operationId: generateTranslations
+      parameters:
+        - in: query
+          name: project_id
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: key
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: from_locale
+          required: true
+          schema:
+            $ref: "#/components/schemas/Locale"
+        - in: query
+          name: to_locale
+          required: true
+          schema:
+            $ref: "#/components/schemas/Locale"
+      responses:
+        "200":
+          description: Ok
+          content:
+            text/event-stream:
+              schema:
+                type: string
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/translation:
+    put:
+      operationId: renameTranslationKey
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                projectId:
+                  type: string
+                keyId:
+                  type: string
+                newKeyName:
+                  type: string
+                  minLength: 4
+                  maxLength: 512
+              required:
+                - projectId
+                - keyId
+                - newKeyName
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    delete:
+      operationId: deleteTranslation
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: keyId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    get:
+      operationId: getTranslation
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: keyId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetTranslationDataResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/translation/tags:
+    patch:
+      operationId: updateTranslationTags
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateTranslationTagsRequestBody"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/UpdateTranslationTagsResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    get:
+      operationId: getTranslationTags
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: keyId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetTranslationTagsResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/translations/export:
+    get:
+      operationId: exportTranslations
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: format
+          required: true
+          schema:
+            type: string
+            enum:
+              - json
+              - yaml
+              - ts
+              - po
+              - android_strings
+              - apple_strings
+              - xliff
+              - xcstrings
+        - in: query
+          name: file_name
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: include_tags
+          required: false
+          schema:
+            $ref: "#/components/schemas/Booleanish"
+        - in: query
+          name: include_untranslated
+          required: false
+          schema:
+            $ref: "#/components/schemas/Booleanish"
+        - in: query
+          name: include_description
+          required: false
+          schema:
+            $ref: "#/components/schemas/Booleanish"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/zip:
+              schema: {}
+            application/json:
+              schema:
+                type: string
+            application/yaml:
+              schema:
+                type: string
+            application/x-qt-translation:
+              schema:
+                type: string
+            text/x-gettext-translation:
+              schema:
+                type: string
+            application/xml:
+              schema:
+                type: string
+            text/plain+apple-strings:
+              schema:
+                type: string
+            application/x-xliff+xml:
+              schema:
+                type: string
+            application/json+xcstrings:
+              schema:
+                type: string
+        "204":
+          description: No Content
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/translations/locales:
+    get:
+      operationId: getLocales
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetLocaleResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    delete:
+      operationId: deleteLocale
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: locale
+          required: true
+          schema:
+            $ref: "#/components/schemas/Locale"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    post:
+      operationId: addLocale
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateLocaleRequestBody"
+      responses:
+        "201":
+          description: Resource Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateLocaleResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    put:
+      operationId: updateReferenceLocale
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateReferenceLocaleRequestBody"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api/translations:
+    get:
+      operationId: getTranslations
+      parameters:
+        - in: query
+          name: projectId
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: limit
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: offset
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: q
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: tags
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: lang
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: case_sensitive
+          required: false
+          schema:
+            $ref: "#/components/schemas/Booleanish"
+        - in: query
+          name: untranslated_only
+          required: false
+          schema:
+            $ref: "#/components/schemas/Booleanish"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetTranslationsResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    post:
+      operationId: updateTranslations
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateTranslationsRequestBody"
+      responses:
+        "201":
+          description: Resource Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    delete:
+      operationId: deleteTranslations
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/DeleteTranslationsRequestBody"
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SuccessResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+components:
+  schemas:
+    ErrorResponse:
+      type: object
+      properties:
+        error:
+          type: string
+        details:
+          type: string
+      required:
+        - error
+      additionalProperties: false
+    SuccessResponse:
+      type: object
+      properties:
+        success:
+          type: boolean
+      required:
+        - success
+      additionalProperties: false
+    PermissionCategory:
+      type: string
+      enum:
+        - translations
+        - languages
+        - collaborators
+        - project
+    PermissionRole:
+      type: string
+      enum:
+        - viewer
+        - editor
+    ProjectPermissions:
+      type: object
+      propertyNames:
+        $ref: "#/components/schemas/PermissionCategory"
+      additionalProperties:
+        $ref: "#/components/schemas/PermissionRole"
+    Role:
+      type: string
+      enum:
+        - owner
+        - collaborator
+    ProjectFeature:
+      type: string
+      enum:
+        - auto-translate
+        - suggestions
+    Locale:
+      type: string
+      enum:
+        - af_ZA
+        - am_ET
+        - ar_SA
+        - ar_EG
+        - ar_AE
+        - ar_MA
+        - ha_NG
+        - ig_NG
+        - om_ET
+        - ps_AF
+        - so_SO
+        - sw_KE
+        - sw_TZ
+        - wo_SN
+        - xh_ZA
+        - yo_NG
+        - yo_BJ
+        - zu_ZA
+        - az_AZ
+        - hy_AM
+        - ka_GE
+        - kk_KZ
+        - ky_KG
+        - tk_TM
+        - ug_CN
+        - uz_UZ
+        - ks_IN
+        - ks_PK
+        - be_BY
+        - bg_BG
+        - bs_BA
+        - cs_CZ
+        - hr_HR
+        - lt_LT
+        - lv_LV
+        - mk_MK
+        - pl_PL
+        - ru_RU
+        - sk_SK
+        - sl_SI
+        - sq_AL
+        - sr_RS
+        - sr_BA
+        - sr_ME
+        - uk_UA
+        - ca_ES
+        - cy_GB
+        - da_DK
+        - de_DE
+        - de_AT
+        - de_CH
+        - el_GR
+        - et_EE
+        - eu_ES
+        - fi_FI
+        - ga_IE
+        - gl_ES
+        - hu_HU
+        - is_IS
+        - it_IT
+        - it_CH
+        - mt_MT
+        - nl_NL
+        - nl_BE
+        - no_NO
+        - nn_NO
+        - ro_RO
+        - sv_SE
+        - en_US
+        - en_GB
+        - en_AU
+        - en_CA
+        - en_NZ
+        - en_IN
+        - en_IE
+        - en_ZA
+        - en_SG
+        - fr_FR
+        - fr_CA
+        - fr_BE
+        - fr_CH
+        - fr_MA
+        - es_ES
+        - es_MX
+        - es_AR
+        - es_CO
+        - es_CL
+        - es_PE
+        - es_VE
+        - es_US
+        - pt_PT
+        - pt_BR
+        - as_IN
+        - bho_IN
+        - bn_BD
+        - bn_IN
+        - dv_MV
+        - fa_IR
+        - fa_AF
+        - gu_IN
+        - he_IL
+        - hi_IN
+        - kn_IN
+        - ku_TR
+        - ku_IR
+        - ku_IQ
+        - ku_SY
+        - mai_IN
+        - ml_IN
+        - mr_IN
+        - ne_NP
+        - pa_IN
+        - pa_PK
+        - sd_IN
+        - sd_PK
+        - si_LK
+        - ta_IN
+        - te_IN
+        - ur_PK
+        - ur_IN
+        - bo_CN
+        - bo_IN
+        - dz_BT
+        - id_ID
+        - ja_JP
+        - jv_ID
+        - km_KH
+        - ko_KR
+        - lo_LA
+        - mn_MN
+        - ms_MY
+        - ms_BN
+        - my_MM
+        - su_ID
+        - th_TH
+        - tl_PH
+        - vi_VN
+        - zh_CN
+        - zh_TW
+        - zh_HK
+        - zh_SG
+        - gug_PY
+        - yi_US
+        - yi_IL
+        - yi_DE
+        - tr_TR
+    Timestamp:
+      type: string
+      format: date-time
+      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
+    Plurality:
+      type: string
+      enum:
+        - zero
+        - one
+        - two
+        - few
+        - many
+        - other
+    Pagination:
+      type: object
+      properties:
+        offset:
+          type: number
+        count:
+          type: number
+        totalCount:
+          type: number
+      required:
+        - offset
+        - count
+        - totalCount
+      additionalProperties: false
+    User:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        email:
+          type: string
+        thumbnail_url:
+          type: string
+          format: uri
+      required:
+        - id
+        - name
+        - email
+      additionalProperties: false
+    Collaborator:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        email:
+          type: string
+        thumbnail_url:
+          type: string
+          format: uri
+        role:
+          $ref: "#/components/schemas/Role"
+      required:
+        - id
+        - name
+        - email
+        - role
+      additionalProperties: false
+    Project:
+      type: object
+      properties:
+        id:
+          type: string
+        description:
+          type: string
+        name:
+          type: string
+        created_on:
+          $ref: "#/components/schemas/Timestamp"
+        features:
+          type: array
+          items:
+            $ref: "#/components/schemas/ProjectFeature"
+        updated_on:
+          $ref: "#/components/schemas/Timestamp"
+        owner_user_id:
+          type: string
+        created_by:
+          $ref: "#/components/schemas/Collaborator"
+        users:
+          type: array
+          items:
+            $ref: "#/components/schemas/Collaborator"
+      required:
+        - id
+        - name
+        - created_on
+        - features
+        - owner_user_id
+        - created_by
+        - users
+      additionalProperties: false
+    InvitationProject:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+      required:
+        - id
+        - name
+      additionalProperties: false
+    InvitedBy:
+      type: object
+      properties:
+        user_id:
+          type: string
+        name:
+          type: string
+        thumbnail_url:
+          type: string
+        email:
+          type: string
+      required:
+        - user_id
+        - name
+        - email
+      additionalProperties: false
+    Invitation:
+      type: object
+      properties:
+        id:
+          type: string
+        role:
+          $ref: "#/components/schemas/Role"
+        invited_on:
+          $ref: "#/components/schemas/Timestamp"
+        project:
+          $ref: "#/components/schemas/InvitationProject"
+        invited_by:
+          $ref: "#/components/schemas/InvitedBy"
+      required:
+        - id
+        - role
+        - invited_on
+        - project
+        - invited_by
+      additionalProperties: false
+    TranslationTags:
+      type: array
+      items:
+        type: string
+    TranslationItem:
+      type: object
+      properties:
+        key:
+          type: string
+        key_id:
+          type: string
+        translations:
+          type: object
+          propertyNames:
+            $ref: "#/components/schemas/Locale"
+          additionalProperties:
+            type: string
+        plurals:
+          type: object
+          propertyNames:
+            $ref: "#/components/schemas/Locale"
+          additionalProperties:
+            type: object
+            propertyNames:
+              $ref: "#/components/schemas/Plurality"
+            additionalProperties:
+              type: string
+        comment_count:
+          type: number
+        description:
+          type: string
+        tags:
+          $ref: "#/components/schemas/TranslationTags"
+      required:
+        - key
+        - key_id
+        - translations
+        - plurals
+        - comment_count
+        - tags
+      additionalProperties: false
+    ExtendedTranslationItem:
+      type: object
+      properties:
+        key:
+          type: string
+        key_id:
+          type: string
+        translations:
+          type: object
+          propertyNames:
+            $ref: "#/components/schemas/Locale"
+          additionalProperties:
+            type: string
+        plurals:
+          type: object
+          propertyNames:
+            $ref: "#/components/schemas/Locale"
+          additionalProperties:
+            type: object
+            propertyNames:
+              $ref: "#/components/schemas/Plurality"
+            additionalProperties:
+              type: string
+        comment_count:
+          type: number
+        description:
+          type: string
+        tags:
+          $ref: "#/components/schemas/TranslationTags"
+        created_at:
+          $ref: "#/components/schemas/Timestamp"
+        updated_at:
+          $ref: "#/components/schemas/Timestamp"
+        created_by:
+          type: object
+          properties:
+            id:
+              type: string
+            name:
+              type: string
+            email:
+              type: string
+            thumbnail:
+              type: string
+          required:
+            - id
+            - name
+            - email
+          additionalProperties: false
+      required:
+        - key
+        - key_id
+        - translations
+        - plurals
+        - comment_count
+        - tags
+        - created_at
+      additionalProperties: false
+    TranslationExportItem:
+      type: object
+      properties:
+        key:
+          type: string
+        tags:
+          $ref: "#/components/schemas/TranslationTags"
+        description:
+          type: string
+        translations:
+          type: object
+          propertyNames:
+            $ref: "#/components/schemas/Locale"
+          additionalProperties:
+            type: string
+        plurals:
+          type: object
+          propertyNames:
+            $ref: "#/components/schemas/Locale"
+          additionalProperties:
+            type: object
+            propertyNames:
+              $ref: "#/components/schemas/Plurality"
+            additionalProperties:
+              type: string
+      required:
+        - key
+        - tags
+        - translations
+        - plurals
+      additionalProperties: false
+    LanguageItem:
+      type: object
+      properties:
+        id:
+          type: string
+        locale:
+          $ref: "#/components/schemas/Locale"
+        is_reference:
+          type: boolean
+      required:
+        - id
+        - locale
+        - is_reference
+      additionalProperties: false
+    Comment:
+      type: object
+      properties:
+        id:
+          type: string
+        key_id:
+          type: string
+        project_id:
+          type: string
+        created_on:
+          $ref: "#/components/schemas/Timestamp"
+        edited_on:
+          $ref: "#/components/schemas/Timestamp"
+        user:
+          type: object
+          properties:
+            id:
+              type: string
+            name:
+              type: string
+            email:
+              type: string
+            thumbnail_url:
+              type: string
+          required:
+            - id
+            - name
+            - email
+          additionalProperties: false
+        content:
+          type: string
+      required:
+        - id
+        - key_id
+        - project_id
+        - created_on
+        - user
+        - content
+      additionalProperties: false
+    ProjectApiKeyDetails:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        start:
+          type: string
+        enabled:
+          type: boolean
+        permissions:
+          $ref: "#/components/schemas/ProjectPermissions"
+        created_on:
+          $ref: "#/components/schemas/Timestamp"
+        last_request:
+          $ref: "#/components/schemas/Timestamp"
+        request_count:
+          type: number
+        expires_on:
+          $ref: "#/components/schemas/Timestamp"
+      required:
+        - id
+        - start
+        - enabled
+        - permissions
+        - created_on
+        - request_count
+      additionalProperties: false
+    Booleanish:
+      default: false
+      type: boolean
+    GetInvitationsResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/Invitation"
+      required:
+        - data
+      additionalProperties: false
+    CreateAccessTokenResponse:
+      type: object
+      properties:
+        key:
+          type: string
+        details:
+          $ref: "#/components/schemas/ProjectApiKeyDetails"
+      required:
+        - key
+        - details
+      additionalProperties: false
+    UpdateAccessTokenResponse:
+      type: object
+      properties:
+        details:
+          $ref: "#/components/schemas/ProjectApiKeyDetails"
+      required:
+        - details
+      additionalProperties: false
+    UpdateProjectResponse:
+      type: object
+      properties:
+        name:
+          type: string
+          minLength: 3
+          maxLength: 50
+        description:
+          type: string
+          maxLength: 500
+      required:
+        - name
+      additionalProperties: false
+    GetUserPermissionsResponse:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/ProjectPermissions"
+      required:
+        - data
+      additionalProperties: false
+    UpdateUserPermissionsRequestBody:
+      type: object
+      properties:
+        permissions:
+          type: object
+          properties:
+            translations:
+              type: string
+              enum:
+                - viewer
+                - editor
+            languages:
+              type: string
+              enum:
+                - viewer
+                - editor
+            collaborators:
+              type: string
+              enum:
+                - viewer
+                - editor
+            project:
+              type: string
+              enum:
+                - viewer
+                - editor
+          additionalProperties: false
+      required:
+        - permissions
+      additionalProperties: false
+    CreateProjectRequest:
+      type: object
+      properties:
+        name:
+          type: string
+          minLength: 1
+          maxLength: 50
+        description:
+          type: string
+          maxLength: 500
+        locales:
+          type: array
+          items:
+            $ref: "#/components/schemas/Locale"
+      required:
+        - name
+      additionalProperties: false
+    CreateProjectResponse:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/Project"
+      required:
+        - data
+      additionalProperties: false
+    GetProjectsResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/Project"
+      required:
+        - data
+      additionalProperties: false
+    GetTranslationDataResponse:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/ExtendedTranslationItem"
+      required:
+        - data
+      additionalProperties: false
+    GetTranslationTagsRequest:
+      type: object
+      properties:
+        projectId:
+          type: string
+        keyId:
+          type: string
+      required:
+        - projectId
+        - keyId
+      additionalProperties: false
+    GetTranslationTagsResponse:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/TranslationTags"
+      required:
+        - data
+      additionalProperties: false
+    UpdateTranslationTagsRequestBody:
+      type: object
+      properties:
+        projectId:
+          type: string
+        keyId:
+          type: string
+        tags:
+          minItems: 1
+          type: array
+          items:
+            type: string
+            maxLength: 32
+      required:
+        - projectId
+        - keyId
+        - tags
+      additionalProperties: false
+    UpdateTranslationTagsResponse:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/TranslationTags"
+      required:
+        - data
+      additionalProperties: false
+    TranslationsExportRequestQuery:
+      type: object
+      properties:
+        projectId:
+          type: string
+        format:
+          type: string
+          enum:
+            - json
+            - yaml
+            - ts
+            - po
+            - android_strings
+            - apple_strings
+            - xliff
+            - xcstrings
+        file_name:
+          type: string
+        include_tags:
+          $ref: "#/components/schemas/Booleanish"
+        include_untranslated:
+          $ref: "#/components/schemas/Booleanish"
+        include_description:
+          $ref: "#/components/schemas/Booleanish"
+      required:
+        - projectId
+        - format
+      additionalProperties: false
+    GetLocaleResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/LanguageItem"
+      required:
+        - data
+      additionalProperties: false
+    CreateLocaleRequestBody:
+      type: object
+      properties:
+        projectId:
+          type: string
+        locale:
+          $ref: "#/components/schemas/Locale"
+      required:
+        - projectId
+        - locale
+      additionalProperties: false
+    CreateLocaleResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/LanguageItem"
+      required:
+        - data
+      additionalProperties: false
+    UpdateReferenceLocaleRequestBody:
+      type: object
+      properties:
+        projectId:
+          type: string
+        locale:
+          $ref: "#/components/schemas/Locale"
+      required:
+        - projectId
+        - locale
+      additionalProperties: false
+    GetTranslationsResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/TranslationItem"
+        pagination:
+          $ref: "#/components/schemas/Pagination"
+      required:
+        - data
+        - pagination
+      additionalProperties: false
+    UpdateTranslationsRequestBody:
+      type: object
+      properties:
+        projectId:
+          type: string
+        entries:
+          type: object
+          propertyNames:
+            type: string
+          additionalProperties:
+            type: object
+            properties:
+              tags:
+                type: array
+                items:
+                  type: string
+              description:
+                type: string
+              translations:
+                type: object
+                propertyNames:
+                  $ref: "#/components/schemas/Locale"
+                additionalProperties:
+                  type: string
+              plurals:
+                type: object
+                propertyNames:
+                  $ref: "#/components/schemas/Locale"
+                additionalProperties:
+                  type: object
+                  propertyNames:
+                    $ref: "#/components/schemas/Plurality"
+                  additionalProperties:
+                    type: string
+            required:
+              - translations
+            additionalProperties: false
+      required:
+        - projectId
+        - entries
+      additionalProperties: false
+    DeleteTranslationsRequestBody:
+      type: object
+      properties:
+        projectId:
+          type: string
+        keys:
+          minItems: 1
+          type: array
+          items:
+            type: string
+      required:
+        - projectId
+        - keys
+      additionalProperties: false
+