@xyd-js/uniform 0.0.0-build-8b31648-20250923204702 → 0.0.0-build-ec04de2-20250930214016

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1369 @@
1
+ {
2
+ "title": "Update user",
3
+ "canonical": "updateUser",
4
+ "description": "Update an existing user",
5
+ "type": "rest_put",
6
+ "category": "rest",
7
+ "context": {
8
+ "method": "put",
9
+ "path": "/users/{userId}",
10
+ "group": [
11
+ "Users"
12
+ ],
13
+ "fullPath": "https:/api.example.com/v1/users/{userId}",
14
+ "servers": [
15
+ "https://api.example.com/v1",
16
+ "https://staging-api.example.com/v1",
17
+ "http://localhost:3000/v1"
18
+ ],
19
+ "scopes": []
20
+ },
21
+ "examples": {
22
+ "groups": [
23
+ {
24
+ "description": "Example request",
25
+ "examples": [
26
+ {
27
+ "codeblock": {
28
+ "tabs": [
29
+ {
30
+ "title": "shell",
31
+ "language": "shell",
32
+ "code": "curl --request PUT \\\n --url https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08 \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": true\n}\n'",
33
+ "highlighted": {
34
+ "value": "curl --request PUT \\\n --url https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08 \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": true\n}\n'",
35
+ "lang": "shellscript",
36
+ "meta": "shell",
37
+ "code": "curl --request PUT \\\n --url https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08 \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": true\n}\n'",
38
+ "tokens": [
39
+ [
40
+ "curl",
41
+ "var(--syntax15)"
42
+ ],
43
+ " ",
44
+ [
45
+ "--request PUT",
46
+ "var(--syntax27)"
47
+ ],
48
+ " ",
49
+ [
50
+ "\\",
51
+ "var(--syntax15)"
52
+ ],
53
+ "\n ",
54
+ [
55
+ "--url https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08",
56
+ "var(--syntax27)"
57
+ ],
58
+ " ",
59
+ [
60
+ "\\",
61
+ "var(--syntax15)"
62
+ ],
63
+ "\n ",
64
+ [
65
+ "--header 'accept: application/json'",
66
+ "var(--syntax27)"
67
+ ],
68
+ " ",
69
+ [
70
+ "\\",
71
+ "var(--syntax15)"
72
+ ],
73
+ "\n ",
74
+ [
75
+ "--header 'content-type: application/json'",
76
+ "var(--syntax27)"
77
+ ],
78
+ " ",
79
+ [
80
+ "\\",
81
+ "var(--syntax15)"
82
+ ],
83
+ "\n ",
84
+ [
85
+ "--data '",
86
+ "var(--syntax27)"
87
+ ],
88
+ "\n",
89
+ [
90
+ "{",
91
+ "var(--syntax27)"
92
+ ],
93
+ "\n ",
94
+ [
95
+ "\"firstName\": \"string\",",
96
+ "var(--syntax27)"
97
+ ],
98
+ "\n ",
99
+ [
100
+ "\"lastName\": \"string\",",
101
+ "var(--syntax27)"
102
+ ],
103
+ "\n ",
104
+ [
105
+ "\"role\": \"user\",",
106
+ "var(--syntax27)"
107
+ ],
108
+ "\n ",
109
+ [
110
+ "\"isActive\": true",
111
+ "var(--syntax27)"
112
+ ],
113
+ "\n",
114
+ [
115
+ "}",
116
+ "var(--syntax27)"
117
+ ],
118
+ "\n",
119
+ [
120
+ "'",
121
+ "var(--syntax27)"
122
+ ]
123
+ ],
124
+ "annotations": [],
125
+ "themeName": "classic",
126
+ "style": {
127
+ "colorScheme": "var(--ch-0)"
128
+ }
129
+ }
130
+ },
131
+ {
132
+ "title": "javascript",
133
+ "language": "javascript",
134
+ "code": "const options = {\n method: 'PUT',\n headers: {accept: 'application/json', 'content-type': 'application/json'},\n body: JSON.stringify({firstName: 'string', lastName: 'string', role: 'user', isActive: true})\n};\n\nfetch('https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08', options)\n .then(res => res.json())\n .then(res => console.log(res))\n .catch(err => console.error(err));",
135
+ "highlighted": {
136
+ "value": "const options = {\n method: 'PUT',\n headers: {accept: 'application/json', 'content-type': 'application/json'},\n body: JSON.stringify({firstName: 'string', lastName: 'string', role: 'user', isActive: true})\n};\n\nfetch('https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08', options)\n .then(res => res.json())\n .then(res => console.log(res))\n .catch(err => console.error(err));",
137
+ "lang": "javascript",
138
+ "meta": "javascript",
139
+ "code": "const options = {\n method: 'PUT',\n headers: {accept: 'application/json', 'content-type': 'application/json'},\n body: JSON.stringify({firstName: 'string', lastName: 'string', role: 'user', isActive: true})\n};\n\nfetch('https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08', options)\n .then(res => res.json())\n .then(res => console.log(res))\n .catch(err => console.error(err));",
140
+ "tokens": [
141
+ [
142
+ "const",
143
+ "var(--syntax24)",
144
+ {
145
+ "fontWeight": "bold"
146
+ }
147
+ ],
148
+ " ",
149
+ [
150
+ "options = {",
151
+ "var(--syntax15)"
152
+ ],
153
+ "\n ",
154
+ [
155
+ "method",
156
+ "var(--syntax16)"
157
+ ],
158
+ [
159
+ ":",
160
+ "var(--syntax15)"
161
+ ],
162
+ " ",
163
+ [
164
+ "'PUT'",
165
+ "var(--syntax27)"
166
+ ],
167
+ [
168
+ ",",
169
+ "var(--syntax15)"
170
+ ],
171
+ "\n ",
172
+ [
173
+ "headers",
174
+ "var(--syntax16)"
175
+ ],
176
+ [
177
+ ": {",
178
+ "var(--syntax15)"
179
+ ],
180
+ [
181
+ "accept",
182
+ "var(--syntax16)"
183
+ ],
184
+ [
185
+ ":",
186
+ "var(--syntax15)"
187
+ ],
188
+ " ",
189
+ [
190
+ "'application/json'",
191
+ "var(--syntax27)"
192
+ ],
193
+ [
194
+ ",",
195
+ "var(--syntax15)"
196
+ ],
197
+ " ",
198
+ [
199
+ "'content-type'",
200
+ "var(--syntax16)"
201
+ ],
202
+ [
203
+ ":",
204
+ "var(--syntax15)"
205
+ ],
206
+ " ",
207
+ [
208
+ "'application/json'",
209
+ "var(--syntax27)"
210
+ ],
211
+ [
212
+ "},",
213
+ "var(--syntax15)"
214
+ ],
215
+ "\n ",
216
+ [
217
+ "body",
218
+ "var(--syntax16)"
219
+ ],
220
+ [
221
+ ": JSON.stringify({",
222
+ "var(--syntax15)"
223
+ ],
224
+ [
225
+ "firstName",
226
+ "var(--syntax16)"
227
+ ],
228
+ [
229
+ ":",
230
+ "var(--syntax15)"
231
+ ],
232
+ " ",
233
+ [
234
+ "'string'",
235
+ "var(--syntax27)"
236
+ ],
237
+ [
238
+ ",",
239
+ "var(--syntax15)"
240
+ ],
241
+ " ",
242
+ [
243
+ "lastName",
244
+ "var(--syntax16)"
245
+ ],
246
+ [
247
+ ":",
248
+ "var(--syntax15)"
249
+ ],
250
+ " ",
251
+ [
252
+ "'string'",
253
+ "var(--syntax27)"
254
+ ],
255
+ [
256
+ ",",
257
+ "var(--syntax15)"
258
+ ],
259
+ " ",
260
+ [
261
+ "role",
262
+ "var(--syntax16)"
263
+ ],
264
+ [
265
+ ":",
266
+ "var(--syntax15)"
267
+ ],
268
+ " ",
269
+ [
270
+ "'user'",
271
+ "var(--syntax27)"
272
+ ],
273
+ [
274
+ ",",
275
+ "var(--syntax15)"
276
+ ],
277
+ " ",
278
+ [
279
+ "isActive",
280
+ "var(--syntax16)"
281
+ ],
282
+ [
283
+ ":",
284
+ "var(--syntax15)"
285
+ ],
286
+ " ",
287
+ [
288
+ "true",
289
+ "var(--syntax24)",
290
+ {
291
+ "fontWeight": "bold"
292
+ }
293
+ ],
294
+ [
295
+ "})",
296
+ "var(--syntax15)"
297
+ ],
298
+ "\n",
299
+ [
300
+ "};",
301
+ "var(--syntax15)"
302
+ ],
303
+ "\n\n",
304
+ [
305
+ "fetch(",
306
+ "var(--syntax15)"
307
+ ],
308
+ [
309
+ "'https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08'",
310
+ "var(--syntax27)"
311
+ ],
312
+ [
313
+ ", options)",
314
+ "var(--syntax15)"
315
+ ],
316
+ "\n ",
317
+ [
318
+ ".then(res",
319
+ "var(--syntax15)"
320
+ ],
321
+ " ",
322
+ [
323
+ "=>",
324
+ "var(--syntax15)",
325
+ {
326
+ "fontWeight": "bold"
327
+ }
328
+ ],
329
+ " ",
330
+ [
331
+ "res.json())",
332
+ "var(--syntax15)"
333
+ ],
334
+ "\n ",
335
+ [
336
+ ".then(res",
337
+ "var(--syntax15)"
338
+ ],
339
+ " ",
340
+ [
341
+ "=>",
342
+ "var(--syntax15)",
343
+ {
344
+ "fontWeight": "bold"
345
+ }
346
+ ],
347
+ " ",
348
+ [
349
+ "console.log(res))",
350
+ "var(--syntax15)"
351
+ ],
352
+ "\n ",
353
+ [
354
+ ".catch(err",
355
+ "var(--syntax15)"
356
+ ],
357
+ " ",
358
+ [
359
+ "=>",
360
+ "var(--syntax15)",
361
+ {
362
+ "fontWeight": "bold"
363
+ }
364
+ ],
365
+ " ",
366
+ [
367
+ "console.error(err));",
368
+ "var(--syntax15)"
369
+ ]
370
+ ],
371
+ "annotations": [],
372
+ "themeName": "classic",
373
+ "style": {
374
+ "colorScheme": "var(--ch-0)"
375
+ }
376
+ }
377
+ },
378
+ {
379
+ "title": "python",
380
+ "language": "python",
381
+ "code": "import requests\n\nurl = \"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n\npayload = {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": True\n}\nheaders = {\n \"accept\": \"application/json\",\n \"content-type\": \"application/json\"\n}\n\nresponse = requests.put(url, json=payload, headers=headers)\n\nprint(response.text)",
382
+ "highlighted": {
383
+ "value": "import requests\n\nurl = \"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n\npayload = {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": True\n}\nheaders = {\n \"accept\": \"application/json\",\n \"content-type\": \"application/json\"\n}\n\nresponse = requests.put(url, json=payload, headers=headers)\n\nprint(response.text)",
384
+ "lang": "python",
385
+ "meta": "python",
386
+ "code": "import requests\n\nurl = \"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n\npayload = {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": True\n}\nheaders = {\n \"accept\": \"application/json\",\n \"content-type\": \"application/json\"\n}\n\nresponse = requests.put(url, json=payload, headers=headers)\n\nprint(response.text)",
387
+ "tokens": [
388
+ [
389
+ "import",
390
+ "var(--syntax24)",
391
+ {
392
+ "fontWeight": "bold"
393
+ }
394
+ ],
395
+ " ",
396
+ [
397
+ "requests",
398
+ "var(--syntax15)"
399
+ ],
400
+ "\n\n",
401
+ [
402
+ "url =",
403
+ "var(--syntax15)"
404
+ ],
405
+ " ",
406
+ [
407
+ "\"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"",
408
+ "var(--syntax27)"
409
+ ],
410
+ "\n\n",
411
+ [
412
+ "payload = {",
413
+ "var(--syntax15)"
414
+ ],
415
+ "\n ",
416
+ [
417
+ "\"firstName\"",
418
+ "var(--syntax27)"
419
+ ],
420
+ [
421
+ ":",
422
+ "var(--syntax15)"
423
+ ],
424
+ " ",
425
+ [
426
+ "\"string\"",
427
+ "var(--syntax27)"
428
+ ],
429
+ [
430
+ ",",
431
+ "var(--syntax15)"
432
+ ],
433
+ "\n ",
434
+ [
435
+ "\"lastName\"",
436
+ "var(--syntax27)"
437
+ ],
438
+ [
439
+ ":",
440
+ "var(--syntax15)"
441
+ ],
442
+ " ",
443
+ [
444
+ "\"string\"",
445
+ "var(--syntax27)"
446
+ ],
447
+ [
448
+ ",",
449
+ "var(--syntax15)"
450
+ ],
451
+ "\n ",
452
+ [
453
+ "\"role\"",
454
+ "var(--syntax27)"
455
+ ],
456
+ [
457
+ ":",
458
+ "var(--syntax15)"
459
+ ],
460
+ " ",
461
+ [
462
+ "\"user\"",
463
+ "var(--syntax27)"
464
+ ],
465
+ [
466
+ ",",
467
+ "var(--syntax15)"
468
+ ],
469
+ "\n ",
470
+ [
471
+ "\"isActive\"",
472
+ "var(--syntax27)"
473
+ ],
474
+ [
475
+ ":",
476
+ "var(--syntax15)"
477
+ ],
478
+ " ",
479
+ [
480
+ "True",
481
+ "var(--syntax24)",
482
+ {
483
+ "fontWeight": "bold"
484
+ }
485
+ ],
486
+ "\n",
487
+ [
488
+ "}",
489
+ "var(--syntax15)"
490
+ ],
491
+ "\n",
492
+ [
493
+ "headers = {",
494
+ "var(--syntax15)"
495
+ ],
496
+ "\n ",
497
+ [
498
+ "\"accept\"",
499
+ "var(--syntax27)"
500
+ ],
501
+ [
502
+ ":",
503
+ "var(--syntax15)"
504
+ ],
505
+ " ",
506
+ [
507
+ "\"application/json\"",
508
+ "var(--syntax27)"
509
+ ],
510
+ [
511
+ ",",
512
+ "var(--syntax15)"
513
+ ],
514
+ "\n ",
515
+ [
516
+ "\"content-type\"",
517
+ "var(--syntax27)"
518
+ ],
519
+ [
520
+ ":",
521
+ "var(--syntax15)"
522
+ ],
523
+ " ",
524
+ [
525
+ "\"application/json\"",
526
+ "var(--syntax27)"
527
+ ],
528
+ "\n",
529
+ [
530
+ "}",
531
+ "var(--syntax15)"
532
+ ],
533
+ "\n\n",
534
+ [
535
+ "response = requests.put(url, json=payload, headers=headers)",
536
+ "var(--syntax15)"
537
+ ],
538
+ "\n\n",
539
+ [
540
+ "print(response.text)",
541
+ "var(--syntax15)"
542
+ ]
543
+ ],
544
+ "annotations": [],
545
+ "themeName": "classic",
546
+ "style": {
547
+ "colorScheme": "var(--ch-0)"
548
+ }
549
+ }
550
+ },
551
+ {
552
+ "title": "go",
553
+ "language": "go",
554
+ "code": "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n\n\tpayload := strings.NewReader(\"{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"role\\\":\\\"user\\\",\\\"isActive\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"accept\", \"application/json\")\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(string(body))\n\n}",
555
+ "highlighted": {
556
+ "value": "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n\n\tpayload := strings.NewReader(\"{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"role\\\":\\\"user\\\",\\\"isActive\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"accept\", \"application/json\")\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(string(body))\n\n}",
557
+ "lang": "go",
558
+ "meta": "go",
559
+ "code": "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n\n\tpayload := strings.NewReader(\"{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"role\\\":\\\"user\\\",\\\"isActive\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"accept\", \"application/json\")\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(string(body))\n\n}",
560
+ "tokens": [
561
+ [
562
+ "package main",
563
+ "var(--syntax15)"
564
+ ],
565
+ "\n\n",
566
+ [
567
+ "import",
568
+ "var(--syntax24)",
569
+ {
570
+ "fontWeight": "bold"
571
+ }
572
+ ],
573
+ " ",
574
+ [
575
+ "(",
576
+ "var(--syntax15)"
577
+ ],
578
+ "\n\t",
579
+ [
580
+ "\"fmt\"",
581
+ "var(--syntax27)"
582
+ ],
583
+ "\n\t",
584
+ [
585
+ "\"strings\"",
586
+ "var(--syntax27)"
587
+ ],
588
+ "\n\t",
589
+ [
590
+ "\"net/http\"",
591
+ "var(--syntax27)"
592
+ ],
593
+ "\n\t",
594
+ [
595
+ "\"io\"",
596
+ "var(--syntax27)"
597
+ ],
598
+ "\n",
599
+ [
600
+ ")",
601
+ "var(--syntax15)"
602
+ ],
603
+ "\n\n",
604
+ [
605
+ "func main() {",
606
+ "var(--syntax15)"
607
+ ],
608
+ "\n\n\t",
609
+ [
610
+ "url :=",
611
+ "var(--syntax15)"
612
+ ],
613
+ " ",
614
+ [
615
+ "\"https://api.example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08\"",
616
+ "var(--syntax27)"
617
+ ],
618
+ "\n\n\t",
619
+ [
620
+ "payload := strings.NewReader(",
621
+ "var(--syntax15)"
622
+ ],
623
+ [
624
+ "\"{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"role\\\":\\\"user\\\",\\\"isActive\\\":true}\"",
625
+ "var(--syntax27)"
626
+ ],
627
+ [
628
+ ")",
629
+ "var(--syntax15)"
630
+ ],
631
+ "\n\n\t",
632
+ [
633
+ "req, _ := http.NewRequest(",
634
+ "var(--syntax15)"
635
+ ],
636
+ [
637
+ "\"PUT\"",
638
+ "var(--syntax27)"
639
+ ],
640
+ [
641
+ ", url, payload)",
642
+ "var(--syntax15)"
643
+ ],
644
+ "\n\n\t",
645
+ [
646
+ "req.Header.Add(",
647
+ "var(--syntax15)"
648
+ ],
649
+ [
650
+ "\"accept\"",
651
+ "var(--syntax27)"
652
+ ],
653
+ [
654
+ ",",
655
+ "var(--syntax15)"
656
+ ],
657
+ " ",
658
+ [
659
+ "\"application/json\"",
660
+ "var(--syntax27)"
661
+ ],
662
+ [
663
+ ")",
664
+ "var(--syntax15)"
665
+ ],
666
+ "\n\t",
667
+ [
668
+ "req.Header.Add(",
669
+ "var(--syntax15)"
670
+ ],
671
+ [
672
+ "\"content-type\"",
673
+ "var(--syntax27)"
674
+ ],
675
+ [
676
+ ",",
677
+ "var(--syntax15)"
678
+ ],
679
+ " ",
680
+ [
681
+ "\"application/json\"",
682
+ "var(--syntax27)"
683
+ ],
684
+ [
685
+ ")",
686
+ "var(--syntax15)"
687
+ ],
688
+ "\n\n\t",
689
+ [
690
+ "res, _ := http.DefaultClient.Do(req)",
691
+ "var(--syntax15)"
692
+ ],
693
+ "\n\n\t",
694
+ [
695
+ "defer",
696
+ "var(--syntax24)",
697
+ {
698
+ "fontWeight": "bold"
699
+ }
700
+ ],
701
+ " ",
702
+ [
703
+ "res.Body.Close()",
704
+ "var(--syntax15)"
705
+ ],
706
+ "\n\t",
707
+ [
708
+ "body, _ := io.ReadAll(res.Body)",
709
+ "var(--syntax15)"
710
+ ],
711
+ "\n\n\t",
712
+ [
713
+ "fmt.Println(",
714
+ "var(--syntax15)"
715
+ ],
716
+ [
717
+ "string",
718
+ "var(--syntax24)",
719
+ {
720
+ "fontWeight": "bold"
721
+ }
722
+ ],
723
+ [
724
+ "(body))",
725
+ "var(--syntax15)"
726
+ ],
727
+ "\n\n",
728
+ [
729
+ "}",
730
+ "var(--syntax15)"
731
+ ]
732
+ ],
733
+ "annotations": [],
734
+ "themeName": "classic",
735
+ "style": {
736
+ "colorScheme": "var(--ch-0)"
737
+ }
738
+ }
739
+ }
740
+ ]
741
+ }
742
+ }
743
+ ]
744
+ },
745
+ {
746
+ "description": "Example response",
747
+ "examples": [
748
+ {
749
+ "codeblock": {
750
+ "title": "200",
751
+ "tabs": [
752
+ {
753
+ "title": "application/json",
754
+ "language": "json",
755
+ "code": "{\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"email\": \"user@example.com\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": true,\n \"createdAt\": \"2019-08-24T14:15:22Z\",\n \"updatedAt\": \"2019-08-24T14:15:22Z\",\n \"address\": {\n \"street\": \"string\"\n }\n}",
756
+ "highlighted": {
757
+ "value": "{\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"email\": \"user@example.com\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": true,\n \"createdAt\": \"2019-08-24T14:15:22Z\",\n \"updatedAt\": \"2019-08-24T14:15:22Z\",\n \"address\": {\n \"street\": \"string\"\n }\n}",
758
+ "lang": "json",
759
+ "meta": "application/json",
760
+ "code": "{\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"email\": \"user@example.com\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"role\": \"user\",\n \"isActive\": true,\n \"createdAt\": \"2019-08-24T14:15:22Z\",\n \"updatedAt\": \"2019-08-24T14:15:22Z\",\n \"address\": {\n \"street\": \"string\"\n }\n}",
761
+ "tokens": [
762
+ [
763
+ "{",
764
+ "var(--syntax15)"
765
+ ],
766
+ "\n ",
767
+ [
768
+ "\"id\"",
769
+ "var(--syntax16)"
770
+ ],
771
+ [
772
+ ":",
773
+ "var(--syntax15)"
774
+ ],
775
+ " ",
776
+ [
777
+ "\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"",
778
+ "var(--syntax27)"
779
+ ],
780
+ [
781
+ ",",
782
+ "var(--syntax15)"
783
+ ],
784
+ "\n ",
785
+ [
786
+ "\"email\"",
787
+ "var(--syntax16)"
788
+ ],
789
+ [
790
+ ":",
791
+ "var(--syntax15)"
792
+ ],
793
+ " ",
794
+ [
795
+ "\"user@example.com\"",
796
+ "var(--syntax27)"
797
+ ],
798
+ [
799
+ ",",
800
+ "var(--syntax15)"
801
+ ],
802
+ "\n ",
803
+ [
804
+ "\"firstName\"",
805
+ "var(--syntax16)"
806
+ ],
807
+ [
808
+ ":",
809
+ "var(--syntax15)"
810
+ ],
811
+ " ",
812
+ [
813
+ "\"string\"",
814
+ "var(--syntax27)"
815
+ ],
816
+ [
817
+ ",",
818
+ "var(--syntax15)"
819
+ ],
820
+ "\n ",
821
+ [
822
+ "\"lastName\"",
823
+ "var(--syntax16)"
824
+ ],
825
+ [
826
+ ":",
827
+ "var(--syntax15)"
828
+ ],
829
+ " ",
830
+ [
831
+ "\"string\"",
832
+ "var(--syntax27)"
833
+ ],
834
+ [
835
+ ",",
836
+ "var(--syntax15)"
837
+ ],
838
+ "\n ",
839
+ [
840
+ "\"role\"",
841
+ "var(--syntax16)"
842
+ ],
843
+ [
844
+ ":",
845
+ "var(--syntax15)"
846
+ ],
847
+ " ",
848
+ [
849
+ "\"user\"",
850
+ "var(--syntax27)"
851
+ ],
852
+ [
853
+ ",",
854
+ "var(--syntax15)"
855
+ ],
856
+ "\n ",
857
+ [
858
+ "\"isActive\"",
859
+ "var(--syntax16)"
860
+ ],
861
+ [
862
+ ":",
863
+ "var(--syntax15)"
864
+ ],
865
+ " ",
866
+ [
867
+ "true",
868
+ "var(--syntax24)",
869
+ {
870
+ "fontWeight": "bold"
871
+ }
872
+ ],
873
+ [
874
+ ",",
875
+ "var(--syntax15)"
876
+ ],
877
+ "\n ",
878
+ [
879
+ "\"createdAt\"",
880
+ "var(--syntax16)"
881
+ ],
882
+ [
883
+ ":",
884
+ "var(--syntax15)"
885
+ ],
886
+ " ",
887
+ [
888
+ "\"2019-08-24T14:15:22Z\"",
889
+ "var(--syntax27)"
890
+ ],
891
+ [
892
+ ",",
893
+ "var(--syntax15)"
894
+ ],
895
+ "\n ",
896
+ [
897
+ "\"updatedAt\"",
898
+ "var(--syntax16)"
899
+ ],
900
+ [
901
+ ":",
902
+ "var(--syntax15)"
903
+ ],
904
+ " ",
905
+ [
906
+ "\"2019-08-24T14:15:22Z\"",
907
+ "var(--syntax27)"
908
+ ],
909
+ [
910
+ ",",
911
+ "var(--syntax15)"
912
+ ],
913
+ "\n ",
914
+ [
915
+ "\"address\"",
916
+ "var(--syntax16)"
917
+ ],
918
+ [
919
+ ": {",
920
+ "var(--syntax15)"
921
+ ],
922
+ "\n ",
923
+ [
924
+ "\"street\"",
925
+ "var(--syntax16)"
926
+ ],
927
+ [
928
+ ":",
929
+ "var(--syntax15)"
930
+ ],
931
+ " ",
932
+ [
933
+ "\"string\"",
934
+ "var(--syntax27)"
935
+ ],
936
+ "\n ",
937
+ [
938
+ "}",
939
+ "var(--syntax15)"
940
+ ],
941
+ "\n",
942
+ [
943
+ "}",
944
+ "var(--syntax15)"
945
+ ]
946
+ ],
947
+ "annotations": [],
948
+ "themeName": "classic",
949
+ "style": {
950
+ "colorScheme": "var(--ch-0)"
951
+ }
952
+ }
953
+ }
954
+ ]
955
+ }
956
+ },
957
+ {
958
+ "codeblock": {
959
+ "title": "404",
960
+ "tabs": [
961
+ {
962
+ "title": "application/json",
963
+ "language": "json",
964
+ "code": "{\n \"error\": \"string\",\n \"code\": \"string\",\n \"details\": {},\n \"timestamp\": \"2019-08-24T14:15:22Z\"\n}",
965
+ "highlighted": {
966
+ "value": "{\n \"error\": \"string\",\n \"code\": \"string\",\n \"details\": {},\n \"timestamp\": \"2019-08-24T14:15:22Z\"\n}",
967
+ "lang": "json",
968
+ "meta": "application/json",
969
+ "code": "{\n \"error\": \"string\",\n \"code\": \"string\",\n \"details\": {},\n \"timestamp\": \"2019-08-24T14:15:22Z\"\n}",
970
+ "tokens": [
971
+ [
972
+ "{",
973
+ "var(--syntax15)"
974
+ ],
975
+ "\n ",
976
+ [
977
+ "\"error\"",
978
+ "var(--syntax16)"
979
+ ],
980
+ [
981
+ ":",
982
+ "var(--syntax15)"
983
+ ],
984
+ " ",
985
+ [
986
+ "\"string\"",
987
+ "var(--syntax27)"
988
+ ],
989
+ [
990
+ ",",
991
+ "var(--syntax15)"
992
+ ],
993
+ "\n ",
994
+ [
995
+ "\"code\"",
996
+ "var(--syntax16)"
997
+ ],
998
+ [
999
+ ":",
1000
+ "var(--syntax15)"
1001
+ ],
1002
+ " ",
1003
+ [
1004
+ "\"string\"",
1005
+ "var(--syntax27)"
1006
+ ],
1007
+ [
1008
+ ",",
1009
+ "var(--syntax15)"
1010
+ ],
1011
+ "\n ",
1012
+ [
1013
+ "\"details\"",
1014
+ "var(--syntax16)"
1015
+ ],
1016
+ [
1017
+ ": {},",
1018
+ "var(--syntax15)"
1019
+ ],
1020
+ "\n ",
1021
+ [
1022
+ "\"timestamp\"",
1023
+ "var(--syntax16)"
1024
+ ],
1025
+ [
1026
+ ":",
1027
+ "var(--syntax15)"
1028
+ ],
1029
+ " ",
1030
+ [
1031
+ "\"2019-08-24T14:15:22Z\"",
1032
+ "var(--syntax27)"
1033
+ ],
1034
+ "\n",
1035
+ [
1036
+ "}",
1037
+ "var(--syntax15)"
1038
+ ]
1039
+ ],
1040
+ "annotations": [],
1041
+ "themeName": "classic",
1042
+ "style": {
1043
+ "colorScheme": "var(--ch-0)"
1044
+ }
1045
+ }
1046
+ }
1047
+ ]
1048
+ }
1049
+ }
1050
+ ]
1051
+ }
1052
+ ]
1053
+ },
1054
+ "definitions": [
1055
+ {
1056
+ "title": "Path parameters",
1057
+ "type": "$rest.param.path",
1058
+ "properties": [
1059
+ {
1060
+ "name": "userId",
1061
+ "type": "string",
1062
+ "description": "The user ID",
1063
+ "meta": [
1064
+ {
1065
+ "name": "required",
1066
+ "value": "true"
1067
+ }
1068
+ ]
1069
+ }
1070
+ ]
1071
+ },
1072
+ {
1073
+ "title": "Request body",
1074
+ "type": "$rest.request.body",
1075
+ "variants": [
1076
+ {
1077
+ "title": "application/json",
1078
+ "description": "",
1079
+ "properties": [
1080
+ {
1081
+ "name": "firstName",
1082
+ "type": "string",
1083
+ "description": "User's first name",
1084
+ "meta": []
1085
+ },
1086
+ {
1087
+ "name": "lastName",
1088
+ "type": "string",
1089
+ "description": "User's last name",
1090
+ "meta": []
1091
+ },
1092
+ {
1093
+ "name": "role",
1094
+ "type": "$$enum",
1095
+ "description": "User's role in the system",
1096
+ "meta": [
1097
+ {
1098
+ "name": "enum-type",
1099
+ "value": "string"
1100
+ }
1101
+ ],
1102
+ "properties": [
1103
+ {
1104
+ "name": "user",
1105
+ "type": "string",
1106
+ "description": "",
1107
+ "meta": []
1108
+ },
1109
+ {
1110
+ "name": "admin",
1111
+ "type": "string",
1112
+ "description": "",
1113
+ "meta": []
1114
+ },
1115
+ {
1116
+ "name": "moderator",
1117
+ "type": "string",
1118
+ "description": "",
1119
+ "meta": []
1120
+ }
1121
+ ],
1122
+ "ofProperty": {
1123
+ "name": "",
1124
+ "description": "",
1125
+ "type": "string"
1126
+ }
1127
+ },
1128
+ {
1129
+ "name": "isActive",
1130
+ "type": "boolean",
1131
+ "description": "Whether the user account is active",
1132
+ "meta": []
1133
+ }
1134
+ ],
1135
+ "meta": [
1136
+ {
1137
+ "name": "contentType",
1138
+ "value": "application/json"
1139
+ }
1140
+ ]
1141
+ }
1142
+ ],
1143
+ "properties": [],
1144
+ "meta": [
1145
+ {
1146
+ "name": "required",
1147
+ "value": "true"
1148
+ }
1149
+ ]
1150
+ },
1151
+ {
1152
+ "title": "Response",
1153
+ "type": "return",
1154
+ "variants": [
1155
+ {
1156
+ "title": "200",
1157
+ "description": "User updated successfully",
1158
+ "properties": [
1159
+ {
1160
+ "name": "id",
1161
+ "type": "string",
1162
+ "description": "Unique identifier for the user",
1163
+ "meta": [
1164
+ {
1165
+ "name": "required",
1166
+ "value": "true"
1167
+ }
1168
+ ]
1169
+ },
1170
+ {
1171
+ "name": "email",
1172
+ "type": "string",
1173
+ "description": "User's email address",
1174
+ "meta": [
1175
+ {
1176
+ "name": "required",
1177
+ "value": "true"
1178
+ }
1179
+ ]
1180
+ },
1181
+ {
1182
+ "name": "firstName",
1183
+ "type": "string",
1184
+ "description": "User's first name",
1185
+ "meta": [
1186
+ {
1187
+ "name": "required",
1188
+ "value": "true"
1189
+ }
1190
+ ]
1191
+ },
1192
+ {
1193
+ "name": "lastName",
1194
+ "type": "string",
1195
+ "description": "User's last name",
1196
+ "meta": [
1197
+ {
1198
+ "name": "required",
1199
+ "value": "true"
1200
+ }
1201
+ ]
1202
+ },
1203
+ {
1204
+ "name": "role",
1205
+ "type": "$$enum",
1206
+ "description": "User's role in the system",
1207
+ "meta": [
1208
+ {
1209
+ "name": "required",
1210
+ "value": "true"
1211
+ },
1212
+ {
1213
+ "name": "enum-type",
1214
+ "value": "string"
1215
+ }
1216
+ ],
1217
+ "properties": [
1218
+ {
1219
+ "name": "user",
1220
+ "type": "string",
1221
+ "description": "",
1222
+ "meta": []
1223
+ },
1224
+ {
1225
+ "name": "admin",
1226
+ "type": "string",
1227
+ "description": "",
1228
+ "meta": []
1229
+ },
1230
+ {
1231
+ "name": "moderator",
1232
+ "type": "string",
1233
+ "description": "",
1234
+ "meta": []
1235
+ }
1236
+ ],
1237
+ "ofProperty": {
1238
+ "name": "",
1239
+ "description": "",
1240
+ "type": "string"
1241
+ }
1242
+ },
1243
+ {
1244
+ "name": "isActive",
1245
+ "type": "boolean",
1246
+ "description": "Whether the user account is active",
1247
+ "meta": [
1248
+ {
1249
+ "name": "required",
1250
+ "value": "true"
1251
+ }
1252
+ ]
1253
+ },
1254
+ {
1255
+ "name": "createdAt",
1256
+ "type": "string",
1257
+ "description": "When the user was created",
1258
+ "meta": [
1259
+ {
1260
+ "name": "required",
1261
+ "value": "true"
1262
+ }
1263
+ ]
1264
+ },
1265
+ {
1266
+ "name": "updatedAt",
1267
+ "type": "string",
1268
+ "description": "When the user was last updated",
1269
+ "meta": [
1270
+ {
1271
+ "name": "required",
1272
+ "value": "true"
1273
+ }
1274
+ ]
1275
+ },
1276
+ {
1277
+ "name": "address",
1278
+ "type": "object",
1279
+ "description": "",
1280
+ "meta": [],
1281
+ "properties": [
1282
+ {
1283
+ "name": "street",
1284
+ "type": "string",
1285
+ "description": "User's street address",
1286
+ "meta": []
1287
+ }
1288
+ ]
1289
+ }
1290
+ ],
1291
+ "meta": [
1292
+ {
1293
+ "name": "status",
1294
+ "value": "200"
1295
+ },
1296
+ {
1297
+ "name": "contentType",
1298
+ "value": "application/json"
1299
+ },
1300
+ {
1301
+ "name": "definitionDescription",
1302
+ "value": ""
1303
+ }
1304
+ ]
1305
+ },
1306
+ {
1307
+ "title": "404",
1308
+ "description": "User not found",
1309
+ "properties": [
1310
+ {
1311
+ "name": "error",
1312
+ "type": "string",
1313
+ "description": "Error message",
1314
+ "meta": [
1315
+ {
1316
+ "name": "required",
1317
+ "value": "true"
1318
+ }
1319
+ ]
1320
+ },
1321
+ {
1322
+ "name": "code",
1323
+ "type": "string",
1324
+ "description": "Error code",
1325
+ "meta": [
1326
+ {
1327
+ "name": "required",
1328
+ "value": "true"
1329
+ }
1330
+ ]
1331
+ },
1332
+ {
1333
+ "name": "details",
1334
+ "type": "object",
1335
+ "description": "Additional error details",
1336
+ "meta": []
1337
+ },
1338
+ {
1339
+ "name": "timestamp",
1340
+ "type": "string",
1341
+ "description": "When the error occurred",
1342
+ "meta": [
1343
+ {
1344
+ "name": "required",
1345
+ "value": "true"
1346
+ }
1347
+ ]
1348
+ }
1349
+ ],
1350
+ "meta": [
1351
+ {
1352
+ "name": "status",
1353
+ "value": "404"
1354
+ },
1355
+ {
1356
+ "name": "contentType",
1357
+ "value": "application/json"
1358
+ },
1359
+ {
1360
+ "name": "definitionDescription",
1361
+ "value": ""
1362
+ }
1363
+ ]
1364
+ }
1365
+ ],
1366
+ "properties": []
1367
+ }
1368
+ ]
1369
+ }