Skip to content

Commit 6dd0c23

Browse files
github-actions[bot]github-actions[bot]
authored
chore(developer): update API docs (#572)
1 parent 54295de commit 6dd0c23

File tree

4 files changed

+148
-168
lines changed

4 files changed

+148
-168
lines changed

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

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1925,7 +1925,7 @@ paths:
19251925
application/json:
19261926
schema:
19271927
$ref: '#/components/schemas/MethodNotAllowedExceptionResource'
1928-
'/users/{userId}/ai/reports/{reportId}/download':
1928+
'/users/{userId}/ai/reports/{aiReportId}/download':
19291929
get:
19301930
tags:
19311931
- AI
@@ -7356,6 +7356,9 @@ paths:
73567356
summary: 'Get Project AI Settings'
73577357
description: '**Required scopes:** `project` (Read only).'
73587358
operationId: api.projects.ai.settings.get
7359+
parameters:
7360+
-
7361+
$ref: '#/components/parameters/ProjectId'
73597362
responses:
73607363
'200':
73617364
description: 'AI settings'
@@ -18947,6 +18950,8 @@ components:
1894718950
type:
1894818951
description: tokens-usage-raw-data
1894918952
type: string
18953+
enum:
18954+
- tokens-usage-raw-data
1895018955
example: tokens-usage-raw-data
1895118956
schema:
1895218957
description: 'Tokens Usage Raw Data Report schema'
@@ -31318,7 +31323,7 @@ components:
3131831323
- price
3131931324
properties:
3132031325
matchType:
31321-
description: 'Match type, %'
31326+
description: 'Match type, %. Possible values: `perfect`, `100`, or a percentage range (e.g., `99-82`, `81-60`)'
3132231327
type: string
3132331328
example: 100-82
3132431329
price:
@@ -31332,7 +31337,7 @@ components:
3133231337
- price
3133331338
properties:
3133431339
matchType:
31335-
description: 'Match type, %'
31340+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3133631341
type: string
3133731342
example: '100'
3133831343
price:
@@ -31346,7 +31351,7 @@ components:
3134631351
- price
3134731352
properties:
3134831353
matchType:
31349-
description: 'Match type, %'
31354+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3135031355
type: string
3135131356
example: 100-93
3135231357
price:
@@ -31360,9 +31365,9 @@ components:
3136031365
- price
3136131366
properties:
3136231367
matchType:
31363-
description: 'Match type, %'
31368+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3136431369
type: string
31365-
example: perfect
31370+
example: '100'
3136631371
price:
3136731372
description: 'Price, %'
3136831373
type: number
@@ -32029,13 +32034,8 @@ components:
3202932034
- price
3203032035
properties:
3203132036
matchType:
32032-
description: 'Match type, %'
32037+
description: 'Match type, %. Possible values: `perfect`, `100`, or a percentage range (e.g., `99-82`, `81-60`)'
3203332038
type: string
32034-
enum:
32035-
- perfect
32036-
- '100'
32037-
- 99-82
32038-
- 81-60
3203932039
example: perfect
3204032040
price:
3204132041
description: 'Price, %'
@@ -32380,13 +32380,8 @@ components:
3238032380
- price
3238132381
properties:
3238232382
matchType:
32383-
description: 'Match type, %'
32383+
description: 'Match type, %. Possible values: `perfect`, `100`, or a percentage range (e.g., `99-82`, `81-60`)'
3238432384
type: string
32385-
enum:
32386-
- perfect
32387-
- '100'
32388-
- 99-82
32389-
- 81-60
3239032385
example: perfect
3239132386
price:
3239232387
description: 'Price, %'
@@ -32400,12 +32395,8 @@ components:
3240032395
- price
3240132396
properties:
3240232397
matchType:
32403-
description: 'Match type, %'
32398+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3240432399
type: string
32405-
enum:
32406-
- '100'
32407-
- 99-82
32408-
- 81-60
3240932400
example: '100'
3241032401
price:
3241132402
description: 'Price, %'
@@ -32419,12 +32410,8 @@ components:
3241932410
- price
3242032411
properties:
3242132412
matchType:
32422-
description: 'Match type, %'
32413+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3242332414
type: string
32424-
enum:
32425-
- '100'
32426-
- 99-82
32427-
- 81-60
3242832415
example: '100'
3242932416
price:
3243032417
description: 'Price, %'
@@ -32438,11 +32425,8 @@ components:
3243832425
- price
3243932426
properties:
3244032427
matchType:
32441-
description: 'Match type, %'
32428+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3244232429
type: string
32443-
enum:
32444-
- '100'
32445-
- 99-82
3244632430
example: '100'
3244732431
price:
3244832432
description: 'Price, %'

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

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1925,7 +1925,7 @@ paths:
19251925
application/json:
19261926
schema:
19271927
$ref: '#/components/schemas/MethodNotAllowedExceptionResource'
1928-
'/users/{userId}/ai/reports/{reportId}/download':
1928+
'/users/{userId}/ai/reports/{aiReportId}/download':
19291929
get:
19301930
tags:
19311931
- AI
@@ -6715,6 +6715,9 @@ paths:
67156715
summary: 'Get Project AI Settings'
67166716
description: '**Required scopes:** `project` (Read only).'
67176717
operationId: api.projects.ai.settings.get
6718+
parameters:
6719+
-
6720+
$ref: '#/components/parameters/ProjectId'
67186721
responses:
67196722
'200':
67206723
description: 'AI settings'
@@ -17588,6 +17591,8 @@ components:
1758817591
type:
1758917592
description: tokens-usage-raw-data
1759017593
type: string
17594+
enum:
17595+
- tokens-usage-raw-data
1759117596
example: tokens-usage-raw-data
1759217597
schema:
1759317598
description: 'Tokens Usage Raw Data Report schema'
@@ -29709,7 +29714,7 @@ components:
2970929714
- price
2971029715
properties:
2971129716
matchType:
29712-
description: 'Match type, %'
29717+
description: 'Match type, %. Possible values: `perfect`, `100`, or a percentage range (e.g., `99-82`, `81-60`)'
2971329718
type: string
2971429719
example: 100-82
2971529720
price:
@@ -29723,7 +29728,7 @@ components:
2972329728
- price
2972429729
properties:
2972529730
matchType:
29726-
description: 'Match type, %'
29731+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
2972729732
type: string
2972829733
example: '100'
2972929734
price:
@@ -29737,7 +29742,7 @@ components:
2973729742
- price
2973829743
properties:
2973929744
matchType:
29740-
description: 'Match type, %'
29745+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
2974129746
type: string
2974229747
example: 100-93
2974329748
price:
@@ -29751,9 +29756,9 @@ components:
2975129756
- price
2975229757
properties:
2975329758
matchType:
29754-
description: 'Match type, %'
29759+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
2975529760
type: string
29756-
example: perfect
29761+
example: '100'
2975729762
price:
2975829763
description: 'Price, %'
2975929764
type: number
@@ -30372,13 +30377,8 @@ components:
3037230377
- price
3037330378
properties:
3037430379
matchType:
30375-
description: 'Match type, %'
30380+
description: 'Match type, %. Possible values: `perfect`, `100`, or a percentage range (e.g., `99-82`, `81-60`)'
3037630381
type: string
30377-
enum:
30378-
- perfect
30379-
- '100'
30380-
- 99-82
30381-
- 81-60
3038230382
example: perfect
3038330383
price:
3038430384
description: 'Price, %'
@@ -30707,13 +30707,8 @@ components:
3070730707
- price
3070830708
properties:
3070930709
matchType:
30710-
description: 'Match type, %'
30710+
description: 'Match type, %. Possible values: `perfect`, `100`, or a percentage range (e.g., `99-82`, `81-60`)'
3071130711
type: string
30712-
enum:
30713-
- perfect
30714-
- '100'
30715-
- 99-82
30716-
- 81-60
3071730712
example: perfect
3071830713
price:
3071930714
description: 'Price, %'
@@ -30727,12 +30722,8 @@ components:
3072730722
- price
3072830723
properties:
3072930724
matchType:
30730-
description: 'Match type, %'
30725+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3073130726
type: string
30732-
enum:
30733-
- '100'
30734-
- 99-82
30735-
- 81-60
3073630727
example: '100'
3073730728
price:
3073830729
description: 'Price, %'
@@ -30746,12 +30737,8 @@ components:
3074630737
- price
3074730738
properties:
3074830739
matchType:
30749-
description: 'Match type, %'
30740+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3075030741
type: string
30751-
enum:
30752-
- '100'
30753-
- 99-82
30754-
- 81-60
3075530742
example: '100'
3075630743
price:
3075730744
description: 'Price, %'
@@ -30765,11 +30752,8 @@ components:
3076530752
- price
3076630753
properties:
3076730754
matchType:
30768-
description: 'Match type, %'
30755+
description: 'Match type, %. Possible values: `100` or a percentage range (e.g., `99-82`, `81-60`)'
3076930756
type: string
30770-
enum:
30771-
- '100'
30772-
- 99-82
3077330757
example: '100'
3077430758
price:
3077530759
description: 'Price, %'

0 commit comments

Comments
 (0)