generated from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
1175 lines (1173 loc) · 35.4 KB
/
swagger.yaml
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: Redmine API
description: |
Redmine exposes some of its data through a REST API. This API provides
access and basic CRUD operations (create, update, delete) for the resources
described below. The API supports both XML and JSON formats.
version: '3.5'
externalDocs:
description: Redmine Rest API Reference
url: 'http://www.redmine.org/projects/redmine/wiki/Rest_api'
servers:
- url: ''
security:
- api_key: []
- BasicAuth: []
tags:
- name: Issues
description: 'Status : Stable, Note : , Availlability : 1.0'
- name: Projects
description: 'Status : Stable, Note : , Availlability : 1.0'
paths:
'/issues.{format}':
get:
tags:
- Issues
summary: Listing issues
description: >
Returns a paginated list of issues. By default, it returns open issues
only.
NB: operators containing ">", "<" or "=" should be hex-encoded so
they're parsed correctly. Most evolved API clients will do that for you
by default, but for the sake of clarity the following examples have been
written with no such magic feature in mind.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
- name: offset
in: query
description: |
skip this number of issues in response (optional)
allowEmptyValue: true
schema:
type: integer
- name: limit
in: query
description: number of issues per page (optional)
schema:
type: integer
- name: sort
in: query
description: 'column to sort with. Append :desc to invert the order.'
schema:
type: string
- name: project_id
in: query
description: >-
get issues from the project with the given id (a numeric value, not
a project identifier).
schema:
type: integer
- name: subproject_id
in: query
description: >-
get issues from the subproject with the given id. You can use
project_id=XXX&subproject_id=!* to get only the issues of a given
project and none of its subprojects.
schema:
type: string
- name: tracker_id
in: query
description: get issues from the tracker with the given id
schema:
type: integer
- name: status_id
in: query
description: >-
get issues with the given status id only. Possible values: open,
closed, * to get open and closed issues, status id
schema:
type: string
- name: assigned_to_id
in: query
description: >-
get issues which are assigned to the given user id. me can be used
instead an ID to fetch all issues from the logged in user (via API
key or HTTP auth)
schema:
type: string
- name: cf_x
in: query
description: >-
get issues with the given value for custom field with an ID of x.
(Custom field must have 'used as a filter' checked.)
schema:
type: string
responses:
'200':
description: |
Success
content:
application/json:
schema:
required:
- issues
- limit
- offset
- total_count
type: object
properties:
issues:
type: array
items:
$ref: '#/components/schemas/Issue'
total_count:
type: integer
offset:
type: integer
limit:
type: integer
example:
issues:
- id: 23359
project:
id: 1
name: Redmine
tracker:
id: 3
name: Patch
status:
id: 1
name: New
priority:
id: 4
name: Normal
author:
id: 332
name: Go MAEDA
category:
id: 12
name: Translations
subject: Change Japanese translation for label_commits_per_author
description: "I suggest changing the translation for label_commits_per_author from \"起票者別のコミット\" to \"作成者別のコミット\".\r\n\r\nJapanese translation for field_author has been changed from \"起票者\" to \"作成者\" by #2798. But the word \"起票者\" is still used in label_commits_per_author. I think it should be changed to \"作成者\" for consistency."
done_ratio: 0
created_on: '2016-07-18T12:13:59.000Z'
updated_on: '2016-07-18T12:13:59.000Z'
- id: 23357
project:
id: 1
name: Redmine
tracker:
id: 1
name: Defect
status:
id: 10
name: Needs feedback
priority:
id: 5
name: High
author:
id: 115781
name: Sebastian Paluch
category:
id: 9
name: Email notifications
subject: Broken links in email notification
description: "It seems that Redmine version 3.3.0 has broken links generation in email notifications for news (at least), with 3.2.0 noone was reporting such problem.\r\n\r\nI have a news publish that includes following description:\r\n\r\n<pre>\r\nNew software version#1267 has been released. It is ...\r\n\r\n{{include(myproject:100-0_Alpha_2_(rev_93029))}}\r\n\r\nh3. Feel free to report new issues\r\n\r\n* \"myproject\":/redmine/projects/myproject/issues/new\r\n</pre>\r\n\r\nIn email notification \r\n* the first link to version#1267 has been generated correctly, \r\n* the last one is missing server name that should be added automatically: \r\nhttp://redmine/projects/myproject/issues/new but should be http://host/redmine/projects/myproject/issues/new\r\n\r\nIncluded wiki (myproject:100-0_Alpha_2_(rev_93029)) is in different project then the news and includes:\r\n\r\n<pre>\r\nh3. Requirements\r\n\r\n* Service Pack version#1272 or newer\r\n\r\n{{include(myproject:Update_Instruction)}}\r\n\r\n...\r\n\r\n</pre>\r\n\r\nIn email notification \r\n* the link to version#1272 has been generated wrong, it is missing server name: \r\nhttp://redmine/versions/1272 but should be http://host/redmine/versions/1272\r\n\r\n\r\nIncluded wiki (myproject:Update_Instruction) is in different project then the news and includes:\r\n\r\n<pre>\r\nh3. Download\r\n\r\nAll pre-production software releases are available on the \"shared network location\":file://host\\full\\path\\to\\directory. \r\n\r\n...\r\n\r\n</pre>\r\n\r\nIn email notification \r\n* the link to \"shared network location\" has been generated wrong, all \"\\\" has been replaced with a code %5: \r\nfile://\\\\host%5full%5path%5to%5directory\r\nthe link does not work and for some reason, it is not even possible to copy it from Outlook into clipboard\r\n\r\n<pre>\r\nEnvironment:\r\n Redmine version 3.3.0.stable\r\n Ruby version 2.1.8-p440 (2015-12-16) [i386-mingw32]\r\n Rails version 4.2.6\r\n Environment production\r\n Database adapter Mysql2\r\nSCM:\r\n Subversion 1.8.11\r\n Git 2.7.4\r\n Filesystem \r\nRedmine plugins:\r\n computed_custom_field 0.0.2\r\n inside_avatar 1.0.2\r\n issue_filters 1.0.1\r\n redmine_agile 1.4.1-3\r\n redmine_checklists 3.1.1-1\r\n redmine_custom_columns 1.1.0\r\n redmine_favorite_projects 2.0.2-2\r\n redmine_version_fixed_issues 1.0.1\r\n sidebar_hide 0.0.7\r\n</pre>"
done_ratio: 0
custom_fields:
- id: 2
name: Resolution
value: ''
- id: 4
name: Affected version
value: '110'
created_on: '2016-07-18T10:53:45.000Z'
updated_on: '2016-07-18T12:14:17.000Z'
total_count: 4579
offset: 0
limit: 2
application/xml:
example: >-
<issues total_count="4579" offset="0" limit="2" type="array">
<issue> <id>23359</id> <project id="1" name="Redmine"/> <tracker
id="3" name="Patch"/> <status id="1" name="New"/> <priority
id="4" name="Normal"/> <author id="332" name="Go MAEDA"/>
<category id="12" name="Translations"/> <subject> Change
Japanese translation for label_commits_per_author </subject>
<description> </description> <start_date/> <due_date/>
<done_ratio>0</done_ratio> <estimated_hours/>
<created_on>2016-07-18T12:13:59Z</created_on>
<updated_on>2016-07-18T12:13:59Z</updated_on> <closed_on/>
</issue> <issue> <id>23357</id> <project id="1" name="Redmine"/>
<tracker id="1" name="Defect"/> <status id="10" name="Needs
feedback"/> <priority id="5" name="High"/> <author id="115781"
name="Sebastian Paluch"/> <category id="9" name="Email
notifications"/> <subject>Broken links in email
notification</subject> <description> </description>
<start_date/> <due_date/> <done_ratio>0</done_ratio>
<estimated_hours/> <custom_fields type="array"> <custom_field
id="2" name="Resolution"> <value/> </custom_field> <custom_field
id="4" name="Affected version"> <value>110</value>
</custom_field> </custom_fields>
<created_on>2016-07-18T10:53:45Z</created_on>
<updated_on>2016-07-18T12:14:17Z</updated_on> <closed_on/>
</issue> </issues>
post:
tags:
- Issues
summary: Creating an issue
description: Creating a new issue
externalDocs:
description: Redmine Issue Documentation
url: 'https://www.redmine.org/projects/redmine/wiki/Rest_Issues'
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
requestBody:
description: ''
content:
application/json:
schema:
title: Issue Scheme
required:
- issue
type: object
properties:
issue:
title: Issue
required:
- project_id
- status_id
- tracker_id
type: object
properties:
project_id:
type: integer
tracker_id:
type: integer
status_id:
type: string
priority_id:
type: integer
subject:
type: string
description:
type: string
category_id:
type: integer
fixed_version_id:
type: string
description: >
'ID of the Target Versions (previously called 'Fixed
Version' and still referred to as such in the API)'
assigned_to_id:
type: string
description: >
'ID of the user to assign the issue to (currently no
mechanism to assign by name)'
parent_issue_id:
type: string
description: |
'ID of the parent issue'
custom_fields:
type: string
description: |
'See Custom fields'
watcher_user_ids:
type: string
description: |
'Array of user ids to add as watchers (since 2.3.0)'
is_private:
type: boolean
description: >
'Use true or false to indicate whether the issue is
private or not'
estimated_hours:
type: string
description: |
'Number of hours estimated for issue'
description: ''
description: ''
externalDocs:
description: Redmine Project API Documentation
url: 'https://www.redmine.org/projects/redmine/wiki/Rest_Projects'
required: false
responses:
'200':
description: Success
content: {}
x-codegen-request-body-name: BodyJson
x-swagger-router-controller: getIssues
x-a127-apply: {}
'/issues/{issue_id}.{format}':
get:
tags:
- Issues
summary: Showing an issue
parameters:
- name: issue_id
in: path
description: The user identifier number
required: true
schema:
type: number
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content:
application/json:
schema:
required:
- issue
type: object
properties:
issue:
$ref: '#/components/schemas/Issue'
put:
tags:
- Issues
summary: Updating an issue
parameters:
- name: issue_id
in: path
description: The user identifier number
required: true
schema:
type: number
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
requestBody:
description: ''
content:
application/json:
schema:
title: Issue Scheme
required:
- issue
type: object
properties:
issue:
title: Issue
type: object
properties:
project_id:
type: integer
tracker_id:
type: integer
status_id:
type: string
priority_id:
type: integer
subject:
type: string
description:
type: string
category_id:
type: integer
assigned_to_id:
type: string
description: >
'ID of the user to assign the issue to (currently no
mechanism to assign by name)'
parent_issue_id:
type: string
description: |
'ID of the parent issue'
custom_fields:
type: string
description: |
'See Custom fields'
watcher_user_ids:
type: string
description: |
'Array of user ids to add as watchers (since 2.3.0)'
is_private:
type: boolean
description: >
'Use true or false to indicate whether the issue is
private or not'
estimated_hours:
type: string
description: |
'Number of hours estimated for issue'
description: ''
description: ''
externalDocs:
description: Redmine Project API Documentation
url: 'https://www.redmine.org/projects/redmine/wiki/Rest_Projects'
required: false
responses:
'200':
description: Success
content: {}
delete:
tags:
- Issues
summary: Deleting an issue
parameters:
- name: issue_id
in: path
description: The user identifier number
required: true
schema:
type: number
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
headers:
X-dummy:
schema:
type: string
content: {}
'/issues/{issue_id}/watchers.{format}':
post:
tags:
- Issues
summary: Adding a watcher
parameters:
- name: issue_id
in: path
description: The user identifier number
required: true
schema:
type: number
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
requestBody:
description: user_id
content:
application/json:
schema:
required:
- user_id
type: object
properties:
user_id:
type: string
description: id of the user to add as a watcher
required: false
responses:
'200':
description: Success
content: {}
x-codegen-request-body-name: BodyJson
'/issues/{issue_id}/watchers/{user_id}.{format}':
delete:
tags:
- Issues
summary: Removing a watcher
parameters:
- name: issue_id
in: path
description: The user identifier number
required: true
schema:
type: number
- name: user_id
in: path
description: The user identifier number
required: true
schema:
type: number
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
'/issue_statuses.{format}':
get:
tags:
- Issues
summary: Returns possible Status Values for Issues
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
'/trackers.{format}':
get:
tags:
- Trackers
summary: Returns possible Values for Trackers
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
'/Users.{format}':
get:
tags:
- Users
summary: Returns Users
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
'/enumerations/{type}.{format}':
get:
tags:
- Enumerations
summary: Returns enum for given Type
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
- name: type
in: path
description: Enumeration Type
required: true
schema:
type: string
default: issue_priorities
enum:
- issue_priorities
- time_entry_activities
- document_categories
responses:
'200':
description: Success
content: {}
'/projects.{format}':
get:
tags:
- Projects
summary: Listing projects
description: >-
Returns all projects (all public projects and private projects where
user have access to)
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
- name: include
in: query
description: >
fetch associated data (optional). Possible values: trackers,
issue_categories, enabled_modules (since 2.6.0).
Values should be separated by a comma ",".
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
required:
- limit
- offset
- projects
type: object
properties:
projects:
type: array
items:
$ref: '#/components/schemas/Project'
total_count:
type: integer
offset:
type: integer
limit:
type: integer
post:
tags:
- Projects
summary: Creating a project
description: Creates a the project.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
'/projects/{project_id}.{format}':
get:
tags:
- Projects
summary: Showing a project
description: Returns the project of given id or identifier.
parameters:
- name: project_id
in: path
description: The user identifier number
required: true
schema:
type: string
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
put:
tags:
- Projects
summary: Updating a project
description: Updates the project of given id or identifier.
parameters:
- name: project_id
in: path
description: The user identifier number
required: true
schema:
type: string
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
delete:
tags:
- Projects
summary: Deleting a project
description: Deletes the project of given id or identifier.
parameters:
- name: project_id
in: path
description: The user identifier number
required: true
schema:
type: string
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: Success
content: {}
'/my/account.{format}':
get:
tags:
- MyAccount
summary: Shows Account data
description: Returns the Users Account data.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
responses:
'200':
description: A User object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
put:
tags:
- MyAccount
summary: Updates Account data
description: Updates the Users Account data.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
requestBody:
description: ''
content:
application/json:
schema:
title: User Scheme
required:
- user
type: object
properties:
user:
title: User
required:
- project_id
- status_id
- tracker_id
type: object
properties:
login:
type: string
admin:
type: boolean
firstname:
type: string
lastname:
type: string
mail:
type: string
custom_fields:
type: array
items:
$ref: '#/components/schemas/IdName'
description: ''
description: ''
externalDocs:
description: aaaa
url: 'http://www.google.com'
required: false
responses:
'200':
description: Success
content: {}
'/time_entries.{format}':
get:
tags:
- TimeEntries
summary: Shows Time entries
description: Returns Time entries.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
- name: project_id
in: query
description: The user identifier number
schema:
type: integer
- name: offset
in: query
description: The user identifier number
schema:
type: integer
- name: limit
in: query
description: The user identifier number
schema:
type: integer
- name: user_id
in: query
description: The user identifier number
schema:
type: integer
- name: spent_on
in: query
description: The user identifier number
schema:
type: string
- name: issue_id
in: query
description: The user identifier number
schema:
type: integer
responses:
'200':
description: A User object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
post:
tags:
- TimeEntries
summary: Creates Time entry
description: Creates a new Time entry.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
requestBody:
description: ''
content:
application/json:
schema:
title: Time entry Schema
type: object
properties:
time_entry:
title: Time Entry
required:
- issue_id
- hours
type: object
properties:
hours:
type: integer
issue_id:
type: integer
spent_on:
type: string
activity_id:
type: integer
comments:
type: string
user_id:
type: integer
description: ''
externalDocs:
description: ''
url: 'https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries'
required: false
responses:
'200':
description: Success
content: {}
'/time_entries/{entry_id}.{format}':
put:
tags:
- TimeEntries
summary: Updates Time entry
description: Updates the Users Account data.
parameters:
- name: format
in: path
description: json or xml
required: true
schema:
type: string
default: json
enum:
- json
- xml
- name: entry_id
in: path
description: id of the entry to update
required: true
schema:
type: integer
requestBody:
description: ''
content:
application/json:
schema:
title: Time entry Schema
type: object
properties:
time_entry:
title: Time Entry
required:
- issue_id
- hours
type: object
properties:
hours:
type: integer
issue_id:
type: integer