-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi2.yml
1090 lines (1090 loc) · 32.4 KB
/
openapi2.yml
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
swagger: '2.0'
info:
title: wde
version: '2'
tags:
- name: changes
description: Access to the change log entries stored for a particular entry in the dictionaries.
- name: dicts
description: Query and manipulate dictionaries and the users table.
- name: entries_ndx
description: Access and update the XPaths that are used when limiting the data returned on an entries GET using the ndx parameter.
- name: entries
description: Create and manipulate entries in a given dictionary.
- name: users
description: "Manipulate the users and user rights for a dictionary. Can also be used by global admin users to manipulate users for any table when used with \"dict_users\".\r\nDefinitions:\r\n<ul>\r\n<li>A standard user is a user that is authorized to read and write her own entries in a dictionary.</li>\r\n<li>An admin user is a user that is authorized to read and write any entry in a partictular dictionary (writeown = 'n')</li>\r\n<li>A global admin user is a user that is authorized to read and write any entry in \"dict_users\". Global admin users are authorized to manipulate users for any dictionary also through a url referriung to that dictionary.</li>\r\n</ul>"
paths:
'/dicts/{dict_name}/entries/{entries_id}/changes':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary. dict_users does not record changes"
- name: entries_id
in: path
required: true
type: string
description: "ID referencing a particular entry"
get:
tags:
- changes
description: Read only. The list size can be limited by passing pageSize. For a pageSize of more than 10 no entry before is returned as embedded result. Default pageSize is 25. For only getting the changes of a user pass a user paramter with the user name.
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'/dicts/{dict_name}/entries/{entries_id}/changes/{changes_timestamp}':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary. dict_users does not record changes"
- name: entries_id
in: path
required: true
type: string
description: "ID referencing a particular entry"
get:
tags:
- changes
description: Read only.
parameters:
- in: path
name: changes_timestamp
description: "Timstamp of a particular saved entry before the change"
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
/dicts:
get:
tags:
- dicts
description: Return all known dictionaries and the user rights storage "dict_users".
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
post:
tags:
- dicts
description: "Create a new dictionary. Can create an empty user rights storage by using the special name \"dict_users\".\r\nIn order to create a dictionary you need to be an admin user at least for that dictionary. See users.\r\nIf the data base is empty any user may create \"dict_users\"."
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/dicts'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
- application/xml
responses:
'201':
description: Created
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
'/dicts/{dicts_name}':
get:
tags:
- dicts
description: "Get a dictionary. Does not provide any useful additional information about the dicionary yet but will only succede if the user has the right to access the dictionary using the supplied username and password. If the user is not authorized for the dictionary 404 Item not found is returned.\r\nTODO: Get statistics about the dictionary?"
parameters:
- in: path
name: dicts_name
description: URL parameter dicts_name
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
delete:
tags:
- dicts
description: "Delete that dictionary.\r\nOnly global admins can do this. All others get 403 \"Not allowed\""
parameters:
- in: path
name: dicts_name
description: URL parameter dicts_name
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
- application/xml
responses:
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'/dicts/{dict_name}/entries/{entries_id}/entries_ndx':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary. dict_users does not have that auxilliary data"
- name: entries_id
in: path
required: true
type: string
description: "ID referencing a particular entry"
get:
tags:
- entries_ndx
description: Get all the xpath => txt data for the entry specified in the path.
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
delete:
tags:
- entries_ndx
description: Delete all xpath => text entries for the entry_id specified in the path.
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
patch:
tags:
- entries_ndx
description: Create or change all xpath => text entries for the entry_id specified in the path. With the special path entries/0/entries_ndx bulk changes and inserts can be achieved.
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries_ndx'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
'/dicts/{dict_name}/entries/{entries_id}/entries_ndx/{entries_ndx_id}':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary. dict_users does not have that auxilliary data"
- name: entries_id
in: path
required: true
type: string
description: "ID referencing a particular entry"
get:
tags:
- entries_ndx
description: Not implemneted yet.
parameters:
- in: path
name: entries_ndx_id
description: URL parameter entries_ndx_id
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
put:
tags:
- entries_ndx
description: Not implemneted yet.
parameters:
- in: path
name: entries_ndx_id
description: URL parameter entries_ndx_id
type: string
required: true
minimum: 0
maximum: 1
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries_ndx'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
delete:
tags:
- entries_ndx
description: Not implemneted yet.
parameters:
- in: path
name: entries_ndx_id
description: URL parameter entries_ndx_id
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
post:
tags:
- entries_ndx
description: Not implemneted yet.
parameters:
- in: path
name: entries_ndx_id
description: URL parameter entries_ndx_id
type: string
required: true
minimum: 0
maximum: 1
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries_ndx'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'201':
description: Created
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
'/dicts/{dict_name}/entries':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary or dict_users."
get:
tags:
- entries
description: "Get a list of entries.\r\nLimiting the query:\r\n<ul>\r\n<li>Query parameter \"lem\": limit using the lemma column. May contain * jokers.</li>\r\n<li>Query parameter \"sid\": limit using the sid column</li>\r\n<li>Query parameters \"xpath\" and \"txt\": Do a (limited) xpath search to narrow down the result.\r\nThe parameters may be used in a key => value style to secify multiple xpath criteria. \"txt\" may contain \"*\" jokers.</li>\r\n</ul>\r\nNotes on paging:\r\n<ul>\r\n<li>The page size can be set using the pageSize query parameter. For performance reasons better do not request more the a few hundred entries per page.</li>\r\n<li>Only if 10 or less entries per page are requested the actual entry is sent for performance reasons</li>\r\n</ul>"
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
post:
tags:
- entries
description: 'Create a new entry. An id is automatically assigned. TODO: implement -> An id may be supplied by admin users to create entries in the special entries section of the dictionary below id 700.'
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'201':
description: Created
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
# delete:
# tags:
# - entries
# description: Warnung! Dangerous! Deletes every entry except the system entries < 699 from the dictionary.
# produces:
# - application/vnd.wde.v2+json
# - application/hal+json
# - application/json
# responses:
# '204':
# description: No Content
# '401':
# description: Unauthorized
# '403':
# description: Forbidden
# '406':
# description: Not Acceptable
# '415':
# description: Unsupported Media Type
patch:
tags:
- entries
description: Create a set of Entries or change them in bulk (e. g. lock or unlock many entries).
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
'/dicts/{dict_name}/entries/{entries_id}':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary or dict_users."
get:
tags:
- entries
description: Get an entry and (TODO) lock it for writing if the user has the right to do this.
parameters:
- in: path
name: entries_id
description: URL parameter entries_id
type: string
required: true
minimum: 1
maximum: 1
- in: query
name: lock
description: Whether to lock the entry for editing it and how long in seconds.
For true the maximum duration allowed by the server is used.
type: string
pattern: ($|\d+|true)
allowEmptyValue: true
required: false
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
patch:
tags:
- entries
description: Manipulate just one part of the entry. (TODO change to post for compatibility reasons?)
parameters:
- in: path
name: entries_id
description: URL parameter entries_id
type: string
required: true
minimum: 0
maximum: 1
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
put:
tags:
- entries
description: Recreate the whole entry.
parameters:
- in: path
name: entries_id
description: URL parameter entries_id
type: string
required: true
minimum: 0
maximum: 1
- in: body
name: body
required: true
schema:
$ref: '#/definitions/entries'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
delete:
tags:
- entries
description: Delete an entry. Admin user authorization needed.
parameters:
- in: path
name: entries_id
description: URL parameter entries_id
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'422':
description: You don't own the lock for the entry to delete
'/dicts/{dict_name}/files':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary."
get:
tags:
- files
description: "Get a list of files."
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
post:
tags:
- files
description: 'Upload a new file. Replaces a file with the same name'
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/files'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'201':
description: Created
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
# delete:
# tags:
# - files
# description: Warnung! Dangerous! Deletes every entry except the system entries < 699 from the dictionary.
# produces:
# - application/vnd.wde.v2+json
# - application/hal+json
# - application/json
# responses:
# '204':
# description: No Content
# '401':
# description: Unauthorized
# '403':
# description: Forbidden
# '406':
# description: Not Acceptable
# '415':
# description: Unsupported Media Type
# patch:
# tags:
# - files
# description: Create a set of Entries or change them in bulk (e. g. lock or unlock many entries).
# parameters:
# - in: body
# name: body
# required: true
# schema:
# $ref: '#/definitions/entries'
# produces:
# - application/vnd.wde.v2+json
# - application/hal+json
# - application/json
# responses:
# '200':
# description: OK
# '400':
# description: Client Error
# '401':
# description: Unauthorized
# '403':
# description: Forbidden
# '406':
# description: Not Acceptable
# '415':
# description: Unsupported Media Type
# '422':
# description: Unprocessable Entity
'/dicts/{dict_name}/files/{file_name}':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary."
get:
tags:
- files
description: Get an entry and (TODO) lock it for writing if the user has the right to do this.
parameters:
- in: path
name: file_name
description: URL parameter file_name
type: string
required: true
minimum: 1
maximum: 1
- in: query
name: lock
description: Whether to lock the entry for editing it and how long in seconds.
For true the maximum duration allowed by the server is used.
type: string
pattern: ($|\d+|true)
allowEmptyValue: true
required: false
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'/dicts/{dict_name}/users':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary or dict_users."
get:
tags:
- users
description: "<ul>\r\n<li>For standard users: Get ones rights. The list is filtered to only contain the user that was provided as username during authentication.</li>\r\n<li>For admin users: Get a list of all users and their rights for the table given by the url. This also means that global admin users which are authorized to see and manitpulate \"dict_users\" can see all users when querying \"dict_user\".</li>\r\n</ul>\r\nNote that the password is write only thus it is never shown in any response."
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
post:
tags:
- users
description: Create a new user for that table. Admin users only. With the special dictionary "dict_users" users can be created for any table by global admins.
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/users'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'201':
description: Created
'400':
description: Client Error
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
'/dicts/{dict_name}/users/{users_id}':
parameters:
- name: dict_name
in: path
required: true
type: string
description: "Name of an existing dictionary or dict_users."
get:
tags:
- users
description: "Get a user's rights for that table. Non admin users can only query their rights using der user ID.<br/>\r\nNote: The password is not sent over the wire."
parameters:
- in: path
name: users_id
description: URL parameter users_id
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
delete:
tags:
- users
description: "Delete a user for that table. Admin users only."
parameters:
- in: path
name: users_id
description: URL parameter users_id
type: string
required: true
minimum: 0
maximum: 1
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
post:
tags:
- users
description: "<ul>\r\n<li>For a standard user: Change the password. Any other fields are read-only, a 403 error is returned if an attempt is made to manipulate them.</li>\r\n<li>For an admin user: Change the access rights and the password of some user. TODO: check setting rights without changing pw</li>\r\n</ul>"
parameters:
- in: path
name: users_id
description: URL parameter users_id
type: string
required: true
minimum: 0
maximum: 1
- in: body
name: body
required: true
schema:
$ref: '#/definitions/users'
produces:
- application/vnd.wde.v2+json
- application/hal+json
- application/json
responses:
'201':
description: Created
'400':
description: Client Error
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessable Entity
definitions:
dicts:
type: object
properties:
name:
type: string
description: Name of the dictionary.
required:
- name
example:
name: Name of the dictionary.
entries_ndx:
type: object
properties:
id:
type: string
description: The id of the entry this XPath belongs to
xpath:
type: string
description: An XPath (although with - as the separator) within an entry.
txt:
type: string
description: The text that will be returned if this XPath is selected using an XML tool.
weight:
type: string
description: Some integer value by wihch an important occurence of a word can be destinguished from a less important one.