-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi-openapi-generated-stable.yaml
More file actions
15639 lines (15639 loc) · 802 KB
/
api-openapi-generated-stable.yaml
File metadata and controls
15639 lines (15639 loc) · 802 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: "3.0.1"
info:
title: "API Documentation"
version: "1.0"
paths:
/api/v1/chat/{sessionId}/messages:
get:
summary: "getMessages"
description: "getMessages"
parameters:
- name: "sessionId"
in: "path"
description: ""
required: true
schema:
type: "string"
- name: "page"
in: "query"
description: ""
required: true
schema:
type: "integer"
nullable: false
default: "0"
- name: "size"
in: "query"
description: ""
required: true
schema:
type: "integer"
nullable: false
default: "100"
- name: "tokenValue"
in: "query"
description: ""
required: false
schema:
type: "string"
nullable: false
- name: "issuedAt.seconds"
in: "query"
description: "The number of seconds from the epoch of 1970-01-01T00:00:00Z."
required: false
schema:
type: "integer"
format: "int64"
nullable: false
- name: "issuedAt.nanos"
in: "query"
description: "The number of nanoseconds, later along the time-line, from the\
\ seconds field.\nThis is always positive, and never exceeds 999,999,999."
required: false
schema:
type: "integer"
nullable: false
- name: "expiresAt.seconds"
in: "query"
description: "The number of seconds from the epoch of 1970-01-01T00:00:00Z."
required: false
schema:
type: "integer"
format: "int64"
nullable: false
- name: "expiresAt.nanos"
in: "query"
description: "The number of nanoseconds, later along the time-line, from the\
\ seconds field.\nThis is always positive, and never exceeds 999,999,999."
required: false
schema:
type: "integer"
nullable: false
- name: "headers.key.key"
in: "query"
description: ""
required: false
schema:
type: ""
nullable: false
- name: "claims.key.key"
in: "query"
description: ""
required: false
schema:
type: ""
nullable: false
responses:
"200":
description: ""
content:
application/json:
schema:
type: "object"
properties:
success:
type: "boolean"
description: ""
message:
type: "string"
description: ""
data:
type: "object"
properties:
content:
type: "array"
description: ""
items:
type: "object"
properties:
messageId:
type: "object"
properties:
mostSigBits:
type: "integer"
description: ""
format: "int64"
leastSigBits:
type: "integer"
description: ""
format: "int64"
leastSignificantBits:
type: "integer"
description: "Returns the least significant 64 bits\
\ of this UUID's 128 bit value."
format: "int64"
mostSignificantBits:
type: "integer"
description: "Returns the most significant 64 bits\
\ of this UUID's 128 bit value."
format: "int64"
description: ""
sessionId:
type: "object"
properties:
mostSigBits:
type: "integer"
description: ""
format: "int64"
leastSigBits:
type: "integer"
description: ""
format: "int64"
leastSignificantBits:
type: "integer"
description: "Returns the least significant 64 bits\
\ of this UUID's 128 bit value."
format: "int64"
mostSignificantBits:
type: "integer"
description: "Returns the most significant 64 bits\
\ of this UUID's 128 bit value."
format: "int64"
description: ""
sender:
type: "string"
description: "{AI=AI, CANDIDATE=CANDIDATE}"
enum:
- "AI"
- "CANDIDATE"
content:
type: "string"
description: ""
sentAt:
type: "string"
description: ""
description: "ChatMessage DTO according to api-openapi-original-design.yaml\n\
\nSchema definition:\nChatMessageDto:\nproperties:\nmessageId:\
\ string (uuid)\nsessionId: string (uuid)\nsender: string\
\ (enum: [AI, CANDIDATE])\ncontent: string\nsentAt: string\
\ (date-time)"
default: "new ArrayList<>()"
pageable:
type: "object"
properties:
paged:
type: "boolean"
description: "Returns whether the current{@link Pageable}\
\ contains pagination information."
unpaged:
type: "boolean"
description: "Returns whether the current{@link Pageable}\
\ does not contain pagination information."
pageNumber:
type: "integer"
description: "Returns the page to be returned."
pageSize:
type: "integer"
description: "Returns the number of items to be returned."
offset:
type: "integer"
description: "Returns the offset to be taken according\
\ to the underlying page and page size."
format: "int64"
sort:
type: "array"
description: "Returns the sorting parameters."
items:
type: "object"
properties:
direction:
type: "string"
description: "{ASC=ASC, DESC=DESC}"
enum:
- "ASC"
- "DESC"
property:
type: "string"
description: ""
ignoreCase:
type: "boolean"
description: ""
nullHandling:
type: "string"
description: "{NATIVE=Lets the data store decide\
\ what to do with nulls., NULLS_FIRST=A hint to\
\ the used data store to order entries with null\
\ values before non null entries., NULLS_LAST=A\
\ hint to the used data store to order entries\
\ with null values after non null entries.}"
enum:
- "NATIVE"
- "NULLS_FIRST"
- "NULLS_LAST"
ascending:
type: "boolean"
description: "Returns whether sorting for this property\
\ shall be ascending."
descending:
type: "boolean"
description: "Returns whether sorting for this property\
\ shall be descending."
description: "org.springframework.data.domain.Sort"
description: ""
total:
type: "integer"
description: ""
format: "int64"
empty:
type: "boolean"
description: "Returns whether the current{@link Streamable}\
\ is empty."
number:
type: "integer"
size:
type: "integer"
numberOfElements:
type: "integer"
sort:
type: "array"
items:
type: "object"
properties:
direction:
type: "string"
description: "{ASC=ASC, DESC=DESC}"
enum:
- "ASC"
- "DESC"
property:
type: "string"
description: ""
ignoreCase:
type: "boolean"
description: ""
nullHandling:
type: "string"
description: "{NATIVE=Lets the data store decide what\
\ to do with nulls., NULLS_FIRST=A hint to the used\
\ data store to order entries with null values before\
\ non null entries., NULLS_LAST=A hint to the used\
\ data store to order entries with null values after\
\ non null entries.}"
enum:
- "NATIVE"
- "NULLS_FIRST"
- "NULLS_LAST"
ascending:
type: "boolean"
description: "Returns whether sorting for this property\
\ shall be ascending."
descending:
type: "boolean"
description: "Returns whether sorting for this property\
\ shall be descending."
description: "org.springframework.data.domain.Sort"
first:
type: "boolean"
last:
type: "boolean"
totalPages:
type: "integer"
totalElements:
type: "integer"
format: "int64"
description: ""
timestamp:
type: "string"
description: ""
code:
type: "integer"
description: ""
/api/v1/files/applications/{applicationId}/resume:
get:
summary: "Download resume file by application ID"
description: "Download resume file by application ID"
parameters:
- name: "applicationId"
in: "path"
description: ""
required: true
schema:
type: "string"
- name: "tokenValue"
in: "query"
description: ""
required: false
schema:
type: "string"
nullable: false
- name: "issuedAt.seconds"
in: "query"
description: "The number of seconds from the epoch of 1970-01-01T00:00:00Z."
required: false
schema:
type: "integer"
format: "int64"
nullable: false
- name: "issuedAt.nanos"
in: "query"
description: "The number of nanoseconds, later along the time-line, from the\
\ seconds field.\nThis is always positive, and never exceeds 999,999,999."
required: false
schema:
type: "integer"
nullable: false
- name: "expiresAt.seconds"
in: "query"
description: "The number of seconds from the epoch of 1970-01-01T00:00:00Z."
required: false
schema:
type: "integer"
format: "int64"
nullable: false
- name: "expiresAt.nanos"
in: "query"
description: "The number of nanoseconds, later along the time-line, from the\
\ seconds field.\nThis is always positive, and never exceeds 999,999,999."
required: false
schema:
type: "integer"
nullable: false
- name: "headers.key.key"
in: "query"
description: ""
required: false
schema:
type: ""
nullable: false
- name: "claims.key.key"
in: "query"
description: ""
required: false
schema:
type: ""
nullable: false
responses:
"200":
description: ""
content:
application/json:
schema:
type: "object"
properties:
inputStream:
type: "object"
properties: {}
description: "Return an{@link InputStream} for the content of\
\ an underlying resource.\n<p>It is usually expected that every\
\ such call creates a <i>fresh</i> stream.\n<p>This requirement\
\ is particularly important when you consider an API such\n\
as JavaMail, which needs to be able to read the stream multiple\
\ times when\ncreating mail attachments. For such a use case,\
\ it is <i>required</i>\nthat each{@code getInputStream()} call\
\ returns a fresh stream."
readable:
type: "boolean"
description: "Indicate whether non-empty contents of this resource\
\ can be read via\n{@link #getInputStream()}.\n<p>Will be{@code\
\ true} for typical resource descriptors that exist\nsince it\
\ strictly implies{@link #exists()} semantics as of 5.1.\nNote\
\ that actual content reading may still fail when attempted.\n\
However, a value of{@code false} is a definitive indication\n\
that the resource content cannot be read."
open:
type: "boolean"
description: "Indicate whether this resource represents a handle\
\ with an open stream.\nIf{@code true}, the InputStream cannot\
\ be read multiple times,\nand must be read and closed to avoid\
\ resource leaks.\n<p>Will be{@code false} for typical resource\
\ descriptors."
file:
type: "object"
properties:
path:
type: "string"
description: "This abstract pathname's normalized pathname\
\ string. A normalized\npathname string uses the default\
\ name-separator character and does not\ncontain any duplicate\
\ or redundant separators."
name:
type: "string"
description: "Returns the name of the file or directory denoted\
\ by this abstract\npathname. This is just the last name\
\ in the pathname's name\nsequence. If the pathname's name\
\ sequence is empty, then the empty\nstring is returned."
parent:
type: "string"
description: "Returns the pathname string of this abstract\
\ pathname's parent, or\n{@code null} if this pathname does\
\ not name a parent directory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's prefix,\
\ if any, and each name in the pathname's name\nsequence\
\ except for the last. If the name sequence is empty then\n\
the pathname does not name a parent directory."
parentFile:
type: "object"
properties:
path:
type: "string"
description: "This abstract pathname's normalized pathname\
\ string. A normalized\npathname string uses the default\
\ name-separator character and does not\ncontain any\
\ duplicate or redundant separators."
name:
type: "string"
description: "Returns the name of the file or directory\
\ denoted by this abstract\npathname. This is just\
\ the last name in the pathname's name\nsequence. If\
\ the pathname's name sequence is empty, then the empty\n\
string is returned."
parent:
type: "string"
description: "Returns the pathname string of this abstract\
\ pathname's parent, or\n{@code null} if this pathname\
\ does not name a parent directory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's\
\ prefix, if any, and each name in the pathname's name\n\
sequence except for the last. If the name sequence\
\ is empty then\nthe pathname does not name a parent\
\ directory."
parentFile:
type: "object"
properties: {}
description: "Returns the abstract pathname of this abstract\
\ pathname's parent,\nor{@code null} if this pathname\
\ does not name a parent\ndirectory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's\
\ prefix, if any, and each name in the pathname's name\n\
sequence except for the last. If the name sequence\
\ is empty then\nthe pathname does not name a parent\
\ directory."
absolute:
type: "boolean"
description: "Tests whether this abstract pathname is\
\ absolute. The definition of\nabsolute pathname is\
\ system dependent. On UNIX systems, a pathname is\n\
absolute if its prefix is{@code \"/\"}. On Microsoft\
\ Windows systems, a\npathname is absolute if its prefix\
\ is a drive specifier followed by\n{@code \"\\\\\"\
}, or if its prefix is{@code \"\\\\\\\\\"}."
absolutePath:
type: "string"
description: "Returns the absolute pathname string of\
\ this abstract pathname.\n\n<p> If this abstract pathname\
\ is already absolute, then the pathname\nstring is\
\ simply returned as if by the{@link #getPath}\nmethod.\
\ If this abstract pathname is the empty abstract pathname\
\ then\nthe pathname string of the current user directory,\
\ which is named by the\nsystem property{@code user.dir},\
\ is returned. Otherwise this\npathname is resolved\
\ in a system-dependent way. On UNIX systems, a\nrelative\
\ pathname is made absolute by resolving it against\
\ the current\nuser directory. On Microsoft Windows\
\ systems, a relative pathname is made absolute\nby\
\ resolving it against the current directory of the\
\ drive named by the\npathname, if any; if not, it is\
\ resolved against the current user\ndirectory."
absoluteFile:
type: "object"
properties: {}
description: "Returns the absolute form of this abstract\
\ pathname. Equivalent to\n<code>new File(this.{@link\
\ #getAbsolutePath})</code>."
canonicalPath:
type: "string"
description: "Returns the canonical pathname string of\
\ this abstract pathname.\n\n<p> A canonical pathname\
\ is both absolute and unique. The precise\ndefinition\
\ of canonical form is system-dependent. This method\
\ first\nconverts this pathname to absolute form if\
\ necessary, as if by invoking the\n{@link #getAbsolutePath}\
\ method, and then maps it to its unique form in a\n\
system-dependent way. This typically involves removing\
\ redundant names\nsuch as{@code \".\"} and{@code \"\
..\"} from the pathname, resolving\nsymbolic links (on\
\ UNIX platforms), and converting drive letters to a\n\
standard case (on Microsoft Windows platforms).\n\n\
<p> Every pathname that denotes an existing file or\
\ directory has a\nunique canonical form. Every pathname\
\ that denotes a nonexistent file\nor directory also\
\ has a unique canonical form. The canonical form of\n\
the pathname of a nonexistent file or directory may\
\ be different from\nthe canonical form of the same\
\ pathname after the file or directory is\ncreated.\
\ Similarly, the canonical form of the pathname of\
\ an existing\nfile or directory may be different from\
\ the canonical form of the same\npathname after the\
\ file or directory is deleted."
canonicalFile:
type: "object"
properties: {}
description: "Returns the canonical form of this abstract\
\ pathname. Equivalent to\n<code>new File(this.{@link\
\ #getCanonicalPath})</code>."
directory:
type: "boolean"
description: "Tests whether the file denoted by this abstract\
\ pathname is a\ndirectory.\n\n<p> Where it is required\
\ to distinguish an I/O exception from the case\nthat\
\ the file is not a directory, or where several attributes\
\ of the\nsame file are required at the same time, then\
\ the{@link\n * java.nio.file.Files#readAttributes(Path,Class,LinkOption[])\n\
\ * Files.readAttributes} method may be used."
file:
type: "boolean"
description: "Tests whether the file denoted by this abstract\
\ pathname is a normal\nfile. A file is <em>normal</em>\
\ if it is not a directory and, in\naddition, satisfies\
\ other system-dependent criteria. Any non-directory\n\
file created by a Java application is guaranteed to\
\ be a normal file.\n\n<p> Where it is required to distinguish\
\ an I/O exception from the case\nthat the file is not\
\ a normal file, or where several attributes of the\n\
same file are required at the same time, then the{@link\n\
\ * java.nio.file.Files#readAttributes(Path,Class,LinkOption[])\n\
\ * Files.readAttributes} method may be used."
hidden:
type: "boolean"
description: "Tests whether the file named by this abstract\
\ pathname is a hidden\nfile. The exact definition\
\ of <em>hidden</em> is system-dependent. On\nUNIX\
\ systems, a file is considered to be hidden if its\
\ name begins with\na period character ({@code '.'}).\
\ On Microsoft Windows systems, a file is\nconsidered\
\ to be hidden if it has been marked as such in the\
\ filesystem."
lastModified:
type: "integer"
description: "Sets the last-modified time of the file\
\ or directory named by this\nabstract pathname.\n\n\
<p> All platforms support file-modification times to\
\ the nearest second,\nbut some provide more precision.\
\ The argument will be truncated to fit\nthe supported\
\ precision. If the operation succeeds and no intervening\n\
operations on the file take place, then the next invocation\
\ of the\n{@link #lastModified} method will return the\
\ (possibly\ntruncated){@code time} argument that was\
\ passed to this method."
writable:
type: "boolean"
description: "A convenience method to set the owner's\
\ write permission for this abstract\npathname. On some\
\ platforms it may be possible to start the Java virtual\n\
machine with special privileges that allow it to modify\
\ files that\ndisallow write operations.\n\n<p> An invocation\
\ of this method of the form{@code file.setWritable(arg)}\n\
behaves in exactly the same way as the invocation\n\n\
{@snippet lang=java :\n * file.setWritable(arg,\
\ true)\n * }"
readable:
type: "boolean"
description: "A convenience method to set the owner's\
\ read permission for this abstract\npathname. On some\
\ platforms it may be possible to start the Java virtual\n\
machine with special privileges that allow it to read\
\ files that are\nmarked as unreadable.\n\n<p>An invocation\
\ of this method of the form{@code file.setReadable(arg)}\n\
behaves in exactly the same way as the invocation\n\n\
{@snippet lang=java :\n * file.setReadable(arg,\
\ true)\n * }"
executable:
type: "boolean"
description: "A convenience method to set the owner's\
\ execute permission for this\nabstract pathname. On\
\ some platforms it may be possible to start the Java\n\
virtual machine with special privileges that allow it\
\ to execute files\nthat are not marked executable.\n\
\n<p>An invocation of this method of the form{@code\
\ file.setExcutable(arg)}\nbehaves in exactly the same\
\ way as the invocation\n\n{@snippet lang=java :\n \
\ * file.setExecutable(arg, true)\n * }"
totalSpace:
type: "integer"
description: "Returns the size of the partition <a href=\"\
#partName\">named</a> by this\nabstract pathname. If\
\ the total number of bytes in the partition is\ngreater\
\ than{@link Long#MAX_VALUE}, then{@code Long.MAX_VALUE}\
\ will be\nreturned."
format: "int64"
freeSpace:
type: "integer"
description: "Returns the number of unallocated bytes\
\ in the partition <a\nhref=\"#partName\">named</a>\
\ by this abstract path name. If the\nnumber of unallocated\
\ bytes in the partition is greater than\n{@link Long#MAX_VALUE},\
\ then{@code Long.MAX_VALUE} will be returned.\n\n<p>\
\ The returned number of unallocated bytes is a hint,\
\ but not\na guarantee, that it is possible to use most\
\ or any of these\nbytes. The number of unallocated\
\ bytes is most likely to be\naccurate immediately after\
\ this call. It is likely to be made\ninaccurate by\
\ any external I/O operations including those made\n\
on the system outside of this virtual machine. This\
\ method\nmakes no guarantee that write operations to\
\ this file system\nwill succeed."
format: "int64"
usableSpace:
type: "integer"
description: "Returns the number of bytes available to\
\ this virtual machine on the\npartition <a href=\"\
#partName\">named</a> by this abstract pathname. If\n\
the number of available bytes in the partition is greater\
\ than\n{@link Long#MAX_VALUE}, then{@code Long.MAX_VALUE}\
\ will be returned.\nWhen possible, this method checks\
\ for write permissions and other\noperating system\
\ restrictions and will therefore usually provide a\
\ more\naccurate estimate of how much new data can actually\
\ be written than\n{@link #getFreeSpace}.\n\n<p> The\
\ returned number of available bytes is a hint, but\
\ not a\nguarantee, that it is possible to use most\
\ or any of these bytes. The\nnumber of available bytes\
\ is most likely to be accurate immediately\nafter this\
\ call. It is likely to be made inaccurate by any external\n\
I/O operations including those made on the system outside\
\ of this\nvirtual machine. This method makes no guarantee\
\ that write operations\nto this file system will succeed."
format: "int64"
description: "Returns the abstract pathname of this abstract\
\ pathname's parent,\nor{@code null} if this pathname does\
\ not name a parent\ndirectory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's prefix,\
\ if any, and each name in the pathname's name\nsequence\
\ except for the last. If the name sequence is empty then\n\
the pathname does not name a parent directory."
absolute:
type: "boolean"
description: "Tests whether this abstract pathname is absolute.\
\ The definition of\nabsolute pathname is system dependent.\
\ On UNIX systems, a pathname is\nabsolute if its prefix\
\ is{@code \"/\"}. On Microsoft Windows systems, a\npathname\
\ is absolute if its prefix is a drive specifier followed\
\ by\n{@code \"\\\\\"}, or if its prefix is{@code \"\\\\\
\\\\\"}."
absolutePath:
type: "string"
description: "Returns the absolute pathname string of this\
\ abstract pathname.\n\n<p> If this abstract pathname is\
\ already absolute, then the pathname\nstring is simply\
\ returned as if by the{@link #getPath}\nmethod. If this\
\ abstract pathname is the empty abstract pathname then\n\
the pathname string of the current user directory, which\
\ is named by the\nsystem property{@code user.dir}, is returned.\
\ Otherwise this\npathname is resolved in a system-dependent\
\ way. On UNIX systems, a\nrelative pathname is made absolute\
\ by resolving it against the current\nuser directory. \
\ On Microsoft Windows systems, a relative pathname is made\
\ absolute\nby resolving it against the current directory\
\ of the drive named by the\npathname, if any; if not, it\
\ is resolved against the current user\ndirectory."
absoluteFile:
type: "object"
properties:
path:
type: "string"
description: "This abstract pathname's normalized pathname\
\ string. A normalized\npathname string uses the default\
\ name-separator character and does not\ncontain any\
\ duplicate or redundant separators."
name:
type: "string"
description: "Returns the name of the file or directory\
\ denoted by this abstract\npathname. This is just\
\ the last name in the pathname's name\nsequence. If\
\ the pathname's name sequence is empty, then the empty\n\
string is returned."
parent:
type: "string"
description: "Returns the pathname string of this abstract\
\ pathname's parent, or\n{@code null} if this pathname\
\ does not name a parent directory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's\
\ prefix, if any, and each name in the pathname's name\n\
sequence except for the last. If the name sequence\
\ is empty then\nthe pathname does not name a parent\
\ directory."
parentFile:
type: "object"
properties: {}
description: "Returns the abstract pathname of this abstract\
\ pathname's parent,\nor{@code null} if this pathname\
\ does not name a parent\ndirectory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's\
\ prefix, if any, and each name in the pathname's name\n\
sequence except for the last. If the name sequence\
\ is empty then\nthe pathname does not name a parent\
\ directory."
absolute:
type: "boolean"
description: "Tests whether this abstract pathname is\
\ absolute. The definition of\nabsolute pathname is\
\ system dependent. On UNIX systems, a pathname is\n\
absolute if its prefix is{@code \"/\"}. On Microsoft\
\ Windows systems, a\npathname is absolute if its prefix\
\ is a drive specifier followed by\n{@code \"\\\\\"\
}, or if its prefix is{@code \"\\\\\\\\\"}."
absolutePath:
type: "string"
description: "Returns the absolute pathname string of\
\ this abstract pathname.\n\n<p> If this abstract pathname\
\ is already absolute, then the pathname\nstring is\
\ simply returned as if by the{@link #getPath}\nmethod.\
\ If this abstract pathname is the empty abstract pathname\
\ then\nthe pathname string of the current user directory,\
\ which is named by the\nsystem property{@code user.dir},\
\ is returned. Otherwise this\npathname is resolved\
\ in a system-dependent way. On UNIX systems, a\nrelative\
\ pathname is made absolute by resolving it against\
\ the current\nuser directory. On Microsoft Windows\
\ systems, a relative pathname is made absolute\nby\
\ resolving it against the current directory of the\
\ drive named by the\npathname, if any; if not, it is\
\ resolved against the current user\ndirectory."
absoluteFile:
type: "object"
properties: {}
description: "Returns the absolute form of this abstract\
\ pathname. Equivalent to\n<code>new File(this.{@link\
\ #getAbsolutePath})</code>."
canonicalPath:
type: "string"
description: "Returns the canonical pathname string of\
\ this abstract pathname.\n\n<p> A canonical pathname\
\ is both absolute and unique. The precise\ndefinition\
\ of canonical form is system-dependent. This method\
\ first\nconverts this pathname to absolute form if\
\ necessary, as if by invoking the\n{@link #getAbsolutePath}\
\ method, and then maps it to its unique form in a\n\
system-dependent way. This typically involves removing\
\ redundant names\nsuch as{@code \".\"} and{@code \"\
..\"} from the pathname, resolving\nsymbolic links (on\
\ UNIX platforms), and converting drive letters to a\n\
standard case (on Microsoft Windows platforms).\n\n\
<p> Every pathname that denotes an existing file or\
\ directory has a\nunique canonical form. Every pathname\
\ that denotes a nonexistent file\nor directory also\
\ has a unique canonical form. The canonical form of\n\
the pathname of a nonexistent file or directory may\
\ be different from\nthe canonical form of the same\
\ pathname after the file or directory is\ncreated.\
\ Similarly, the canonical form of the pathname of\
\ an existing\nfile or directory may be different from\
\ the canonical form of the same\npathname after the\
\ file or directory is deleted."
canonicalFile:
type: "object"
properties: {}
description: "Returns the canonical form of this abstract\
\ pathname. Equivalent to\n<code>new File(this.{@link\
\ #getCanonicalPath})</code>."
directory:
type: "boolean"
description: "Tests whether the file denoted by this abstract\
\ pathname is a\ndirectory.\n\n<p> Where it is required\
\ to distinguish an I/O exception from the case\nthat\
\ the file is not a directory, or where several attributes\
\ of the\nsame file are required at the same time, then\
\ the{@link\n * java.nio.file.Files#readAttributes(Path,Class,LinkOption[])\n\
\ * Files.readAttributes} method may be used."
file:
type: "boolean"
description: "Tests whether the file denoted by this abstract\
\ pathname is a normal\nfile. A file is <em>normal</em>\
\ if it is not a directory and, in\naddition, satisfies\
\ other system-dependent criteria. Any non-directory\n\
file created by a Java application is guaranteed to\
\ be a normal file.\n\n<p> Where it is required to distinguish\
\ an I/O exception from the case\nthat the file is not\
\ a normal file, or where several attributes of the\n\
same file are required at the same time, then the{@link\n\
\ * java.nio.file.Files#readAttributes(Path,Class,LinkOption[])\n\
\ * Files.readAttributes} method may be used."
hidden:
type: "boolean"
description: "Tests whether the file named by this abstract\
\ pathname is a hidden\nfile. The exact definition\
\ of <em>hidden</em> is system-dependent. On\nUNIX\
\ systems, a file is considered to be hidden if its\
\ name begins with\na period character ({@code '.'}).\
\ On Microsoft Windows systems, a file is\nconsidered\
\ to be hidden if it has been marked as such in the\
\ filesystem."
lastModified:
type: "integer"
description: "Sets the last-modified time of the file\
\ or directory named by this\nabstract pathname.\n\n\
<p> All platforms support file-modification times to\
\ the nearest second,\nbut some provide more precision.\
\ The argument will be truncated to fit\nthe supported\
\ precision. If the operation succeeds and no intervening\n\
operations on the file take place, then the next invocation\
\ of the\n{@link #lastModified} method will return the\
\ (possibly\ntruncated){@code time} argument that was\
\ passed to this method."
writable:
type: "boolean"
description: "A convenience method to set the owner's\
\ write permission for this abstract\npathname. On some\
\ platforms it may be possible to start the Java virtual\n\
machine with special privileges that allow it to modify\
\ files that\ndisallow write operations.\n\n<p> An invocation\
\ of this method of the form{@code file.setWritable(arg)}\n\
behaves in exactly the same way as the invocation\n\n\
{@snippet lang=java :\n * file.setWritable(arg,\
\ true)\n * }"
readable:
type: "boolean"
description: "A convenience method to set the owner's\
\ read permission for this abstract\npathname. On some\
\ platforms it may be possible to start the Java virtual\n\
machine with special privileges that allow it to read\
\ files that are\nmarked as unreadable.\n\n<p>An invocation\
\ of this method of the form{@code file.setReadable(arg)}\n\
behaves in exactly the same way as the invocation\n\n\
{@snippet lang=java :\n * file.setReadable(arg,\
\ true)\n * }"
executable:
type: "boolean"
description: "A convenience method to set the owner's\
\ execute permission for this\nabstract pathname. On\
\ some platforms it may be possible to start the Java\n\
virtual machine with special privileges that allow it\
\ to execute files\nthat are not marked executable.\n\
\n<p>An invocation of this method of the form{@code\
\ file.setExcutable(arg)}\nbehaves in exactly the same\
\ way as the invocation\n\n{@snippet lang=java :\n \
\ * file.setExecutable(arg, true)\n * }"
totalSpace:
type: "integer"
description: "Returns the size of the partition <a href=\"\
#partName\">named</a> by this\nabstract pathname. If\
\ the total number of bytes in the partition is\ngreater\
\ than{@link Long#MAX_VALUE}, then{@code Long.MAX_VALUE}\
\ will be\nreturned."
format: "int64"
freeSpace:
type: "integer"
description: "Returns the number of unallocated bytes\
\ in the partition <a\nhref=\"#partName\">named</a>\
\ by this abstract path name. If the\nnumber of unallocated\
\ bytes in the partition is greater than\n{@link Long#MAX_VALUE},\
\ then{@code Long.MAX_VALUE} will be returned.\n\n<p>\
\ The returned number of unallocated bytes is a hint,\
\ but not\na guarantee, that it is possible to use most\
\ or any of these\nbytes. The number of unallocated\
\ bytes is most likely to be\naccurate immediately after\
\ this call. It is likely to be made\ninaccurate by\
\ any external I/O operations including those made\n\
on the system outside of this virtual machine. This\
\ method\nmakes no guarantee that write operations to\
\ this file system\nwill succeed."
format: "int64"
usableSpace:
type: "integer"
description: "Returns the number of bytes available to\
\ this virtual machine on the\npartition <a href=\"\
#partName\">named</a> by this abstract pathname. If\n\
the number of available bytes in the partition is greater\
\ than\n{@link Long#MAX_VALUE}, then{@code Long.MAX_VALUE}\
\ will be returned.\nWhen possible, this method checks\
\ for write permissions and other\noperating system\
\ restrictions and will therefore usually provide a\
\ more\naccurate estimate of how much new data can actually\
\ be written than\n{@link #getFreeSpace}.\n\n<p> The\
\ returned number of available bytes is a hint, but\
\ not a\nguarantee, that it is possible to use most\
\ or any of these bytes. The\nnumber of available bytes\
\ is most likely to be accurate immediately\nafter this\
\ call. It is likely to be made inaccurate by any external\n\
I/O operations including those made on the system outside\
\ of this\nvirtual machine. This method makes no guarantee\
\ that write operations\nto this file system will succeed."
format: "int64"
description: "Returns the absolute form of this abstract pathname.\
\ Equivalent to\n<code>new File(this.{@link #getAbsolutePath})</code>."
canonicalPath:
type: "string"
description: "Returns the canonical pathname string of this\
\ abstract pathname.\n\n<p> A canonical pathname is both\
\ absolute and unique. The precise\ndefinition of canonical\
\ form is system-dependent. This method first\nconverts\
\ this pathname to absolute form if necessary, as if by\
\ invoking the\n{@link #getAbsolutePath} method, and then\
\ maps it to its unique form in a\nsystem-dependent way.\
\ This typically involves removing redundant names\nsuch\
\ as{@code \".\"} and{@code \"..\"} from the pathname, resolving\n\
symbolic links (on UNIX platforms), and converting drive\
\ letters to a\nstandard case (on Microsoft Windows platforms).\n\
\n<p> Every pathname that denotes an existing file or directory\
\ has a\nunique canonical form. Every pathname that denotes\
\ a nonexistent file\nor directory also has a unique canonical\
\ form. The canonical form of\nthe pathname of a nonexistent\
\ file or directory may be different from\nthe canonical\
\ form of the same pathname after the file or directory\
\ is\ncreated. Similarly, the canonical form of the pathname\
\ of an existing\nfile or directory may be different from\
\ the canonical form of the same\npathname after the file\
\ or directory is deleted."
canonicalFile:
type: "object"
properties:
path:
type: "string"
description: "This abstract pathname's normalized pathname\
\ string. A normalized\npathname string uses the default\
\ name-separator character and does not\ncontain any\
\ duplicate or redundant separators."
name:
type: "string"
description: "Returns the name of the file or directory\
\ denoted by this abstract\npathname. This is just\
\ the last name in the pathname's name\nsequence. If\
\ the pathname's name sequence is empty, then the empty\n\
string is returned."
parent:
type: "string"
description: "Returns the pathname string of this abstract\
\ pathname's parent, or\n{@code null} if this pathname\
\ does not name a parent directory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's\
\ prefix, if any, and each name in the pathname's name\n\
sequence except for the last. If the name sequence\
\ is empty then\nthe pathname does not name a parent\
\ directory."
parentFile:
type: "object"
properties: {}
description: "Returns the abstract pathname of this abstract\
\ pathname's parent,\nor{@code null} if this pathname\
\ does not name a parent\ndirectory.\n\n<p> The <em>parent</em>\
\ of an abstract pathname consists of the\npathname's\
\ prefix, if any, and each name in the pathname's name\n\
sequence except for the last. If the name sequence\
\ is empty then\nthe pathname does not name a parent\
\ directory."
absolute:
type: "boolean"
description: "Tests whether this abstract pathname is\
\ absolute. The definition of\nabsolute pathname is\
\ system dependent. On UNIX systems, a pathname is\n\
absolute if its prefix is{@code \"/\"}. On Microsoft\
\ Windows systems, a\npathname is absolute if its prefix\
\ is a drive specifier followed by\n{@code \"\\\\\"\
}, or if its prefix is{@code \"\\\\\\\\\"}."
absolutePath:
type: "string"
description: "Returns the absolute pathname string of\
\ this abstract pathname.\n\n<p> If this abstract pathname\
\ is already absolute, then the pathname\nstring is\
\ simply returned as if by the{@link #getPath}\nmethod.\
\ If this abstract pathname is the empty abstract pathname\
\ then\nthe pathname string of the current user directory,\
\ which is named by the\nsystem property{@code user.dir},\
\ is returned. Otherwise this\npathname is resolved\
\ in a system-dependent way. On UNIX systems, a\nrelative\
\ pathname is made absolute by resolving it against\
\ the current\nuser directory. On Microsoft Windows\
\ systems, a relative pathname is made absolute\nby\
\ resolving it against the current directory of the\
\ drive named by the\npathname, if any; if not, it is\
\ resolved against the current user\ndirectory."
absoluteFile:
type: "object"
properties: {}
description: "Returns the absolute form of this abstract\
\ pathname. Equivalent to\n<code>new File(this.{@link\
\ #getAbsolutePath})</code>."
canonicalPath:
type: "string"
description: "Returns the canonical pathname string of\
\ this abstract pathname.\n\n<p> A canonical pathname\
\ is both absolute and unique. The precise\ndefinition\