chore: update API docs

crowdin · Feb 12, 2025 · dc65545 · dc65545
1 parent 9fec6b2
commit dc65545
Show file tree

Hide file tree

Showing 4 changed files with 1,040 additions and 308 deletions.
diff --git a/src/assets/api/crowdin/file-based.yml b/src/assets/api/crowdin/file-based.yml
@@ -13384,6 +13384,8 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/TmSegmentResource'
+        '204':
+          description: 'TM segment was successfully deleted'
         '400':
           description: 'Invalid Request Parameters'
           content:
@@ -22114,158 +22116,6 @@ components:
           items:
             $ref: '#/components/schemas/Term'
       type: object
-    GroupPatch:
-      description: 'A JSON Patch document as defined by <a href="https://tools.ietf.org/html/rfc6902#section-3" target="_blank">RFC 6902</a>'
-      type: array
-      items:
-        $ref: '#/components/schemas/GroupOperation'
-    GroupOperation:
-      description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
-      required:
-        - op
-        - path
-      properties:
-        op:
-          description: 'Patch operation to perform'
-          type: string
-          enum:
-            - replace
-            - test
-        path:
-          description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
-          type: string
-          format: json-pointer
-          enum:
-            - /name
-            - /description
-            - /parentId
-      type: object
-      discriminator:
-        propertyName: op
-        mapping:
-          replace: '#/components/schemas/GroupOperationReplace'
-          test: '#/components/schemas/GroupOperationTest'
-    GroupOperationReplace:
-      description: 'A JSON Patch `Replace` operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4.3)'
-      required:
-        - value
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/GroupOperation'
-        -
-          properties:
-            value:
-              oneOf:
-                -
-                  type: string
-                -
-                  type: integer
-    GroupOperationTest:
-      description: 'A JSON Patch `Replace` operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4.3)'
-      required:
-        - value
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/GroupOperation'
-        -
-          properties:
-            value:
-              oneOf:
-                -
-                  type: string
-                -
-                  type: array
-                  items: { type: string }
-    GroupCreateForm:
-      required:
-        - name
-      properties:
-        name:
-          description: 'Group Name'
-          type: string
-          example: 'KB materials'
-        parentId:
-          description: 'Parent Group Identifier. Get via [List Groups](#operation/api.groups.getMany)'
-          type: integer
-          example: '2'
-        description:
-          description: 'Group description'
-          type: string
-          example: 'KB localization materials'
-      type: object
-    GroupCollectionResource:
-      description: 'Group Collection Resource'
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/CollectionResource'
-        -
-          $ref: '#/components/schemas/CollectionResource'
-        -
-          properties:
-            data:
-              type: array
-              items:
-                $ref: '#/components/schemas/GroupResource'
-            pagination:
-              $ref: '#/components/schemas/Pagination'
-    GroupResource:
-      description: 'Group Resource'
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/Resource'
-        -
-          properties:
-            data:
-              $ref: '#/components/schemas/Group'
-    Group:
-      title: Group
-      description: 'Class GroupResponseModel'
-      properties:
-        id:
-          type: integer
-          example: 1
-          nullable: true
-        name:
-          type: string
-          example: 'KB materials'
-        description:
-          type: string
-          example: 'KB localization materials'
-        parentId:
-          type: integer
-          example: 2
-        organizationId:
-          type: integer
-          example: 200000299
-        userId:
-          type: integer
-          example: 6
-        subgroupsCount:
-          type: integer
-          example: 0
-          nullable: true
-        projectsCount:
-          type: integer
-          example: 1
-          nullable: true
-        webUrl:
-          type: string
-          example: 'https://example.crowdin.com/u/groups/123'
-        createdAt:
-          type: string
-          format: date-time
-          example: '2019-09-20T11:11:05+00:00'
-          nullable: true
-        updatedAt:
-          type: string
-          format: date-time
-          example: '2019-09-20T12:22:20+00:00'
-          nullable: true
-      type: object
     BackgroundUploadForm:
       required:
         - storageId

diff --git a/src/assets/api/crowdin/string-based.yml b/src/assets/api/crowdin/string-based.yml
@@ -12736,6 +12736,8 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/TmSegmentResource'
+        '204':
+          description: 'TM segment was successfully deleted'
         '400':
           description: 'Invalid Request Parameters'
           content:
@@ -20973,158 +20975,6 @@ components:
           items:
             $ref: '#/components/schemas/Term'
       type: object
-    GroupPatch:
-      description: 'A JSON Patch document as defined by <a href="https://tools.ietf.org/html/rfc6902#section-3" target="_blank">RFC 6902</a>'
-      type: array
-      items:
-        $ref: '#/components/schemas/GroupOperation'
-    GroupOperation:
-      description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
-      required:
-        - op
-        - path
-      properties:
-        op:
-          description: 'Patch operation to perform'
-          type: string
-          enum:
-            - replace
-            - test
-        path:
-          description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
-          type: string
-          format: json-pointer
-          enum:
-            - /name
-            - /description
-            - /parentId
-      type: object
-      discriminator:
-        propertyName: op
-        mapping:
-          replace: '#/components/schemas/GroupOperationReplace'
-          test: '#/components/schemas/GroupOperationTest'
-    GroupOperationReplace:
-      description: 'A JSON Patch `Replace` operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4.3)'
-      required:
-        - value
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/GroupOperation'
-        -
-          properties:
-            value:
-              oneOf:
-                -
-                  type: string
-                -
-                  type: integer
-    GroupOperationTest:
-      description: 'A JSON Patch `Replace` operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4.3)'
-      required:
-        - value
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/GroupOperation'
-        -
-          properties:
-            value:
-              oneOf:
-                -
-                  type: string
-                -
-                  type: array
-                  items: { type: string }
-    GroupCreateForm:
-      required:
-        - name
-      properties:
-        name:
-          description: 'Group Name'
-          type: string
-          example: 'KB materials'
-        parentId:
-          description: 'Parent Group Identifier. Get via [List Groups](#operation/api.groups.getMany)'
-          type: integer
-          example: '2'
-        description:
-          description: 'Group description'
-          type: string
-          example: 'KB localization materials'
-      type: object
-    GroupCollectionResource:
-      description: 'Group Collection Resource'
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/CollectionResource'
-        -
-          $ref: '#/components/schemas/CollectionResource'
-        -
-          properties:
-            data:
-              type: array
-              items:
-                $ref: '#/components/schemas/GroupResource'
-            pagination:
-              $ref: '#/components/schemas/Pagination'
-    GroupResource:
-      description: 'Group Resource'
-      type: object
-      allOf:
-        -
-          $ref: '#/components/schemas/Resource'
-        -
-          properties:
-            data:
-              $ref: '#/components/schemas/Group'
-    Group:
-      title: Group
-      description: 'Class GroupResponseModel'
-      properties:
-        id:
-          type: integer
-          example: 1
-          nullable: true
-        name:
-          type: string
-          example: 'KB materials'
-        description:
-          type: string
-          example: 'KB localization materials'
-        parentId:
-          type: integer
-          example: 2
-        organizationId:
-          type: integer
-          example: 200000299
-        userId:
-          type: integer
-          example: 6
-        subgroupsCount:
-          type: integer
-          example: 0
-          nullable: true
-        projectsCount:
-          type: integer
-          example: 1
-          nullable: true
-        webUrl:
-          type: string
-          example: 'https://example.crowdin.com/u/groups/123'
-        createdAt:
-          type: string
-          format: date-time
-          example: '2019-09-20T11:11:05+00:00'
-          nullable: true
-        updatedAt:
-          type: string
-          format: date-time
-          example: '2019-09-20T12:22:20+00:00'
-          nullable: true
-      type: object
     BackgroundUploadForm:
       required:
         - storageId