Skip to content

Commit 501069c

Browse files
chore(developer): update API docs (#800)
1 parent d51301a commit 501069c

4 files changed

Lines changed: 78 additions & 38 deletions

File tree

src/assets/api/crowdin/file-based.yml

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37808,7 +37808,7 @@ components:
3780837808
x-doc-sections:
3780937809
- file-based
3781037810
StringMassOperation:
37811-
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
37811+
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
3781237812
required:
3781337813
- op
3781437814
- path
@@ -37824,14 +37824,6 @@ components:
3782437824
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
3782537825
type: string
3782637826
format: json-pointer
37827-
enum:
37828-
- '/{stringId}/identifier'
37829-
- '/{stringId}/text'
37830-
- '/{stringId}/context'
37831-
- '/{stringId}/isHidden'
37832-
- '/{stringId}/maxLength'
37833-
- '/{stringId}/labelIds'
37834-
example: '/{stringId}/isHidden'
3783537827
type: object
3783637828
discriminator:
3783737829
propertyName: op
@@ -37849,6 +37841,18 @@ components:
3784937841
$ref: '#/components/schemas/StringMassOperation'
3785037842
-
3785137843
properties:
37844+
path:
37845+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
37846+
type: string
37847+
format: json-pointer
37848+
enum:
37849+
- '/{stringId}/identifier'
37850+
- '/{stringId}/text'
37851+
- '/{stringId}/context'
37852+
- '/{stringId}/isHidden'
37853+
- '/{stringId}/maxLength'
37854+
- '/{stringId}/labelIds'
37855+
example: '/{stringId}/isHidden'
3785237856
value:
3785337857
example: true
3785437858
oneOf:
@@ -37884,6 +37888,12 @@ components:
3788437888
$ref: '#/components/schemas/StringMassOperation'
3788537889
-
3788637890
properties:
37891+
path:
37892+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
37893+
type: string
37894+
format: json-pointer
37895+
enum:
37896+
- /-
3788737897
value:
3788837898
type: object
3788937899
StringPatch:

src/assets/api/crowdin/string-based.yml

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35330,7 +35330,7 @@ components:
3533035330
x-doc-sections:
3533135331
- string-based
3533235332
StringMassOperation:
35333-
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
35333+
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
3533435334
required:
3533535335
- op
3533635336
- path
@@ -35346,14 +35346,6 @@ components:
3534635346
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
3534735347
type: string
3534835348
format: json-pointer
35349-
enum:
35350-
- '/{stringId}/identifier'
35351-
- '/{stringId}/text'
35352-
- '/{stringId}/context'
35353-
- '/{stringId}/isHidden'
35354-
- '/{stringId}/maxLength'
35355-
- '/{stringId}/labelIds'
35356-
example: '/{stringId}/isHidden'
3535735349
type: object
3535835350
discriminator:
3535935351
propertyName: op
@@ -35371,6 +35363,18 @@ components:
3537135363
$ref: '#/components/schemas/StringMassOperation'
3537235364
-
3537335365
properties:
35366+
path:
35367+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
35368+
type: string
35369+
format: json-pointer
35370+
enum:
35371+
- '/{stringId}/identifier'
35372+
- '/{stringId}/text'
35373+
- '/{stringId}/context'
35374+
- '/{stringId}/isHidden'
35375+
- '/{stringId}/maxLength'
35376+
- '/{stringId}/labelIds'
35377+
example: '/{stringId}/isHidden'
3537435378
value:
3537535379
example: true
3537635380
oneOf:
@@ -35406,6 +35410,12 @@ components:
3540635410
$ref: '#/components/schemas/StringMassOperation'
3540735411
-
3540835412
properties:
35413+
path:
35414+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
35415+
type: string
35416+
format: json-pointer
35417+
enum:
35418+
- /-
3540935419
value:
3541035420
type: object
3541135421
StringPatch:

src/assets/api/enterprise/file-based.yml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44241,7 +44241,7 @@ components:
4424144241
x-doc-sections:
4424244242
- file-based
4424344243
EnterpriseStringMassOperation:
44244-
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
44244+
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
4424544245
required:
4424644246
- op
4424744247
- path
@@ -44257,15 +44257,6 @@ components:
4425744257
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
4425844258
type: string
4425944259
format: json-pointer
44260-
enum:
44261-
- '/{stringId}/identifier'
44262-
- '/{stringId}/text'
44263-
- '/{stringId}/context'
44264-
- '/{stringId}/isHidden'
44265-
- '/{stringId}/maxLength'
44266-
- '/{stringId}/labelIds'
44267-
- '/{stringId}/fields'
44268-
example: '/{stringId}/isHidden'
4426944260
type: object
4427044261
discriminator:
4427144262
propertyName: op
@@ -44283,6 +44274,19 @@ components:
4428344274
$ref: '#/components/schemas/EnterpriseStringMassOperation'
4428444275
-
4428544276
properties:
44277+
path:
44278+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
44279+
type: string
44280+
format: json-pointer
44281+
enum:
44282+
- '/{stringId}/identifier'
44283+
- '/{stringId}/text'
44284+
- '/{stringId}/context'
44285+
- '/{stringId}/isHidden'
44286+
- '/{stringId}/maxLength'
44287+
- '/{stringId}/labelIds'
44288+
- '/{stringId}/fields'
44289+
example: '/{stringId}/isHidden'
4428644290
value:
4428744291
example: true
4428844292
oneOf:
@@ -44318,6 +44322,12 @@ components:
4431844322
$ref: '#/components/schemas/EnterpriseStringMassOperation'
4431944323
-
4432044324
properties:
44325+
path:
44326+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
44327+
type: string
44328+
format: json-pointer
44329+
enum:
44330+
- /-
4432144331
value:
4432244332
type: object
4432344333
EnterpriseStringPatch:

src/assets/api/enterprise/string-based.yml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41535,7 +41535,7 @@ components:
4153541535
x-doc-sections:
4153641536
- string-based
4153741537
EnterpriseStringMassOperation:
41538-
description: 'A JSON Patch (222) operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
41538+
description: 'A JSON Patch operation as defined by [RFC 6902](https://tools.ietf.org/html/rfc6902#section-4)'
4153941539
required:
4154041540
- op
4154141541
- path
@@ -41551,15 +41551,6 @@ components:
4155141551
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
4155241552
type: string
4155341553
format: json-pointer
41554-
enum:
41555-
- '/{stringId}/identifier'
41556-
- '/{stringId}/text'
41557-
- '/{stringId}/context'
41558-
- '/{stringId}/isHidden'
41559-
- '/{stringId}/maxLength'
41560-
- '/{stringId}/labelIds'
41561-
- '/{stringId}/fields'
41562-
example: '/{stringId}/isHidden'
4156341554
type: object
4156441555
discriminator:
4156541556
propertyName: op
@@ -41577,6 +41568,19 @@ components:
4157741568
$ref: '#/components/schemas/EnterpriseStringMassOperation'
4157841569
-
4157941570
properties:
41571+
path:
41572+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
41573+
type: string
41574+
format: json-pointer
41575+
enum:
41576+
- '/{stringId}/identifier'
41577+
- '/{stringId}/text'
41578+
- '/{stringId}/context'
41579+
- '/{stringId}/isHidden'
41580+
- '/{stringId}/maxLength'
41581+
- '/{stringId}/labelIds'
41582+
- '/{stringId}/fields'
41583+
example: '/{stringId}/isHidden'
4158041584
value:
4158141585
example: true
4158241586
oneOf:
@@ -41612,6 +41616,12 @@ components:
4161241616
$ref: '#/components/schemas/EnterpriseStringMassOperation'
4161341617
-
4161441618
properties:
41619+
path:
41620+
description: 'A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>'
41621+
type: string
41622+
format: json-pointer
41623+
enum:
41624+
- /-
4161541625
value:
4161641626
type: object
4161741627
EnterpriseStringPatch:

0 commit comments

Comments
 (0)