Skip to content

chore(developer): update API docs #800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Jul 6, 2026
Merged

chore(developer): update API docs #800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions src/assets/api/crowdin/file-based.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37808,7 +37808,7 @@ components:
x-doc-sections:
- file-based
StringMassOperation:
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
required:
- op
- path
Expand All @@ -37824,14 +37824,6 @@ components:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
example: '/{stringId}/isHidden'
type: object
discriminator:
propertyName: op
Expand All @@ -37849,6 +37841,18 @@ components:
$ref: '#/components/schemas/StringMassOperation'
-
properties:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
example: '/{stringId}/isHidden'
value:
example: true
oneOf:
Expand Down Expand Up @@ -37884,6 +37888,12 @@ components:
$ref: '#/components/schemas/StringMassOperation'
-
properties:
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:
- /-
value:
type: object
StringPatch:
Expand Down
28 changes: 19 additions & 9 deletions src/assets/api/crowdin/string-based.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35330,7 +35330,7 @@ components:
x-doc-sections:
- string-based
StringMassOperation:
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
required:
- op
- path
Expand All @@ -35346,14 +35346,6 @@ components:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
example: '/{stringId}/isHidden'
type: object
discriminator:
propertyName: op
Expand All @@ -35371,6 +35363,18 @@ components:
$ref: '#/components/schemas/StringMassOperation'
-
properties:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
example: '/{stringId}/isHidden'
value:
example: true
oneOf:
Expand Down Expand Up @@ -35406,6 +35410,12 @@ components:
$ref: '#/components/schemas/StringMassOperation'
-
properties:
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:
- /-
value:
type: object
StringPatch:
Expand Down
30 changes: 20 additions & 10 deletions src/assets/api/enterprise/file-based.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44241,7 +44241,7 @@ components:
x-doc-sections:
- file-based
EnterpriseStringMassOperation:
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
required:
- op
- path
Expand All @@ -44257,15 +44257,6 @@ components:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
- '/{stringId}/fields'
example: '/{stringId}/isHidden'
type: object
discriminator:
propertyName: op
Expand All @@ -44283,6 +44274,19 @@ components:
$ref: '#/components/schemas/EnterpriseStringMassOperation'
-
properties:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
- '/{stringId}/fields'
example: '/{stringId}/isHidden'
value:
example: true
oneOf:
Expand Down Expand Up @@ -44318,6 +44322,12 @@ components:
$ref: '#/components/schemas/EnterpriseStringMassOperation'
-
properties:
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:
- /-
value:
type: object
EnterpriseStringPatch:
Expand Down
30 changes: 20 additions & 10 deletions src/assets/api/enterprise/string-based.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41535,7 +41535,7 @@ components:
x-doc-sections:
- string-based
EnterpriseStringMassOperation:
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
required:
- op
- path
Expand All @@ -41551,15 +41551,6 @@ components:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
- '/{stringId}/fields'
example: '/{stringId}/isHidden'
type: object
discriminator:
propertyName: op
Expand All @@ -41577,6 +41568,19 @@ components:
$ref: '#/components/schemas/EnterpriseStringMassOperation'
-
properties:
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:
- '/{stringId}/identifier'
- '/{stringId}/text'
- '/{stringId}/context'
- '/{stringId}/isHidden'
- '/{stringId}/maxLength'
- '/{stringId}/labelIds'
- '/{stringId}/fields'
example: '/{stringId}/isHidden'
value:
example: true
oneOf:
Expand Down Expand Up @@ -41612,6 +41616,12 @@ components:
$ref: '#/components/schemas/EnterpriseStringMassOperation'
-
properties:
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:
- /-
value:
type: object
EnterpriseStringPatch:
Expand Down