-
Notifications
You must be signed in to change notification settings - Fork 3
/
api.raml
980 lines (980 loc) · 35.8 KB
/
api.raml
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
#%RAML 0.8
title: Pivotal Tracker
version: v5
baseUri: https://www.pivotaltracker.com/services/{version}
mediaType: application/json
securitySchemes:
- customSchema: !include securitySchemes/customSchema.raml
schemas:
- me: !include schemas/me-schema.json
- notifications: !include schemas/notifications-schema.json
- notificationTimeStamp: !include schemas/notificationTimeStamp-schema.json
- notification: !include schemas/notification-schema.json
- projects: !include schemas/projects-schema.json
- project: !include schemas/project-schema.json
- projectReq: !include schemas/projectReq-schema.json
- iterations: !include schemas/iterations-schema.json
- iterationOverrideReq: !include schemas/iterationOverrideReq-schema.json
- iterationOverride: !include schemas/iterationOverride-schema.json
- project_membership: !include schemas/project_membership-schema.json
- project_member: !include schemas/project_member-schema.json
- memberReq: !include schemas/memberReq-schema.json
- member: !include schemas/member-schema.json
- updateMemberReq: !include schemas/updateMemberReq-schema.json
- accountsMembership: !include schemas/accountsMembership-schema.json
- accountCreateReq: !include schemas/accountCreateReq-schema.json
- account: !include schemas/account-schema.json
- accountUhdateReq: !include schemas/accountUhdateReq-schema.json
- accounts: !include schemas/accounts-schema.json
- labels: !include schemas/labels-schema.json
- labelReq: !include schemas/labelReq-schema.json
- label: !include schemas/label-schema.json
- lables: !include schemas/lables-schema.json
- stories: !include schemas/stories-schema.json
- storyReq: !include schemas/storyReq-schema.json
- story: !include schemas/story-schema.json
- persons: !include schemas/persons-schema.json
- ownerReq: !include schemas/ownerReq-schema.json
- person: !include schemas/person-schema.json
- tasks: !include schemas/tasks-schema.json
- task: !include schemas/task-schema.json
- taskReq: !include schemas/taskReq-schema.json
- epics: !include schemas/epics-schema.json
- epicReq: !include schemas/epicReq-schema.json
- epic: !include schemas/epic-schema.json
- epicUpdate: !include schemas/epicUpdate-schema.json
- comments: !include schemas/comments-schema.json
- commentReq: !include schemas/commentReq-schema.json
- comment: !include schemas/comment-schema.json
- file_attachment: !include schemas/file_attachment-schema.json
- google_attachments: !include schemas/google_attachments-schema.json
- search_result_container: !include schemas/search_result_container-schema.json
- saved_search: !include schemas/saved_search-schema.json
- saved_searchReq: !include schemas/saved_searchReq-schema.json
- activity_types: !include schemas/activity_types-schema.json
- source_commitReq: !include schemas/source_commitReq-schema.json
- integrationReq: !include schemas/integrationReq-schema.json
- integration: !include schemas/integration-schema.json
- webhooks: !include schemas/webhooks-schema.json
- webhookReq: !include schemas/webhookReq-schema.json
- webhook: !include schemas/webhook-schema.json
- workspaces: !include schemas/workspaces-schema.json
- workspaceReq: !include schemas/workspaceReq-schema.json
- workspace: !include schemas/workspace-schema.json
- workspaceUpdate: !include schemas/workspaceUpdate-schema.json
- integrations: !include schemas/integrations-schema.json
- membershipPerson: !include /schemas/membershipPerson-schema.json
resourceTypes:
- member: !include resourceTypes/member.raml
- base: !include resourceTypes/base.raml
- collection: !include resourceTypes/collection.raml
- activityType: !include resourceTypes/activityType.raml
traits:
- pageable: !include traits/pageable.raml
securedBy: [ customSchema ]
/me:
type: base
get:
description: |
In addition to authenticating this request like other API requests, this request can be made with authentication using "basic auth" to pass the user's normal Pivotal Tracker login credentials (their email address or user name plus their password). In this way, client software can use the user's name and password to obtain their API Token, and then use that token to authenticate future API requests made on behalf of that user. Obviously, the user's password should not be stored or otherwise retained.
responses:
200:
body:
application/json:
schema: me
example: !include examples/me-example.json
/my:
/notifications:
type: { collection: { type: notification } }
get:
description: Return list of the notifications
queryParameters:
created_after:
description: Show notifications created after this date/time. If this parameter is not provided, the default is 10 days prior to the request time.
envelope:
description: The standard formatting parameters cannot be included in requests for this operation. In particular, envelope= is prohibited and Tracker behaves as if envelope=true had been provided.
type: boolean
responses:
200:
body:
application/json:
schema: notifications
example: !include examples/notifications-example.json
/mark_read:
type: base
put:
description: "Marks the person's notifications as read up to the given notification id."
queryParameters:
before:
description: Mark all notifications before this id as read
type: integer
required: true
responses:
204:
/{notification_id}:
type: { member: { type: notification } }
put:
description: Mark the notification as read.
queryParameters:
read_at:
description: Time notification was read.
responses:
200:
body:
application/json:
example: !include examples/notification-example.json
get:
description: Retrieve particular notification
responses:
200:
body:
application/json:
example: !include examples/notification-example.json
/activity:
type: activityType
get:
is: [ pageable ]
description: Return list of the selected activity for the authenticated person.
/workspaces:
type: { collection: { type: workspace } }
get:
description: Return list of workspaces for the authenticated person.
responses:
200:
body:
application/json:
schema: workspaces
example: !include examples/workspaces-example.json
post:
description: Create a new workspace for the authenticated person.
body:
application/json:
schema: workspaceReq
example: !include examples/workspaceReq-example.json
responses:
200:
body:
application/json:
example: !include examples/workspace-example.json
/{workspace_id}:
type: { member: { type: workspace } }
put:
description: Return the specified workspace.
body:
application/json:
schema: workspaceUpdate
example: !include examples/workspaceUpdate-example.json
responses:
200:
body:
application/json:
example: !include examples/workspace-example.json
delete:
description: permanently delete the workspace.
get:
description: Return a workspace for the authenticated person.
responses:
200:
body:
application/json:
example: !include examples/workspace-example.json
/people/{person_id}/notifications/since/{timestamp}:
type: base
get:
description: Returns list of notifications for the specified person whose updated_at values are less than the timestamp.
responses:
200:
body:
application/json:
schema: notificationTimeStamp
example: !include examples/notificationTimeStamp-example.json
/projects:
type: { collection: { type: project } }
get:
description: "Get all of a user's active projects."
queryParameters:
account_ids:
description: A comma separated list of account ids whose projects should be returned
responses:
200:
body:
application/json:
schema: projects
example: !include examples/projects-example.json
post:
description: Create a new empty project.
body:
application/json:
schema: projectReq
example: !include examples/projectReq-example.json
responses:
200:
body:
application/json:
example: !include examples/project-example.json
/{project_id}:
type: { member: { type: project } }
get:
description: Fetch the content of the specified project.
responses:
200:
body:
application/json:
example: !include examples/project-example.json
put:
description: Update the specified project.
body:
application/json:
schema: projectReq
example: !include examples/projectReq-example.json
responses:
200:
body:
application/json:
example: !include examples/project-example.json
delete:
description: Permanently delete the specified project.
/iterations:
type: { collection: { type: iteration } }
get:
is: [ pageable ]
description: Return a set of iterations from the project.
queryParameters:
scope:
description: Restricts the state of iterations to return. If not specified, it defaults to all iterations including done.
enum:
- backlog
- done
- current
- current_backlog
responses:
200:
body:
application/json:
schema: iterations
example: !include examples/iterations-example.json
/integrations:
type: { collection: { type: integration } }
get:
description: "Returns a project's integrations."
responses:
200:
body:
application/json:
schema: integrations
example: !include examples/integrations-example.json
post:
description: Create a new integration for a project.
body:
application/json:
schema: integrationReq
example: !include examples/integrationReq-example.json
responses:
200:
body:
application/json:
example: !include examples/integration-example.json
/{integration_id}:
type: { member: { type: integration } }
get:
description: Returns a project integration.
responses:
200:
body:
application/json:
example: !include examples/integration-example.json
put:
description: Updates a project integration.
body:
application/json:
example: !include examples/integrationReq-example.json
responses:
200:
body:
application/json:
example: !include examples/integration-example.json
delete:
description: Deletes a project integration.
/stories:
get:
description: "Provides external_story records for all of the potential stories available through the selected integration (already configured on the selected project). The content of the objects returned is suitable for use as parameters to create stories 'imported from' the selected integration."
queryParameters:
exclude_linked:
description: When this parameter is present and true, response will not include external stories which already have matching Pivotal Tracker stories.
responses:
200:
body:
application/json:
schema: stories
example: !include examples/stories-example.json
/iteration_overrides/{iteration_number}:
put:
description: "Updates an iterration's overrides."
body:
application/json:
schema: iterationOverrideReq
example: !include examples/iterationOverrideReq-example.json
responses:
200:
body:
application/json:
schema: iterationOverride
example: !include examples/iterationOverride-example.json
/memberships:
get:
description: List all of the memberships in a project.
responses:
200:
body:
application/json:
schema: project_membership
example: !include examples/project_membership-example.json
post:
description: Add a user to the project
body:
application/json:
schema: memberReq
example: !include examples/memberReq-example.json
responses:
200:
body:
application/json:
schema: project_member
example: !include examples/project_member-example.json
/{membership_id}:
get:
description: Returns the specified project membership.
responses:
200:
body:
application/json:
schema: member
example: !include examples/member-example.json
put:
description: Updates the specified project membership.
body:
application/json:
schema: updateMemberReq
example: !include examples/updateMemberReq-example.json
responses:
200:
body:
application/json:
schema: member
example: !include examples/member-example.json
delete:
description: Deletes the specified project membership.
/labels:
type: { collection: { type: label } }
get:
description: "Provides all of the project's labels."
responses:
200:
body:
application/json:
schema: labels
example: !include examples/labels-example.json
post:
description: Creates a label on the project.
body:
application/json:
schema: labelReq
example: !include examples/labelReq-example.json
responses:
200:
body:
application/json:
example: !include examples/label-example.json
/{label_id}:
type: { member: { type: label } }
get:
description: "Provides a project's label."
responses:
200:
body:
application/json:
example: !include examples/label-example.json
put:
description: "Updates a project's label."
body:
application/json:
schema: labelReq
example: !include examples/labelReq-example.json
responses:
200:
body:
application/json:
example: !include examples/label-example.json
delete:
description: "Delete a project's label."
/stories:
type: { collection: { type: story } }
get:
is: [ pageable ]
description: Provides selected stories.
queryParameters:
filter:
description: This parameter supplies a search string; only stories that match the search criteria are returned.
with_label:
description: "A story's current_state which all returned stories must match."
enum:
- delivered
- accepted
- unscheduled
- rejected
- finished
- started
- planned
- unstarted
accepted_before:
description: A date and time (ISO 8601 format or milliseconds) which all returned stories are accepted before.
accepted_after:
description: A date and time (ISO 8601 format or milliseconds) which all returned stories are accepted after.
created_before:
description: A date and time (ISO 8601 format or milliseconds) which all returned stories are created before.
created_after:
description: A date and time (ISO 8601 format or milliseconds) which all returned stories are created after.
updated_before:
description: A date and time (ISO 8601 format or milliseconds) which all returned stories are updated before.
updated_after:
description: A date and time (ISO 8601 format or milliseconds) which all returned stories are updated after.
deadline_before:
description: A date and time (ISO 8601 format or milliseconds) that release dates fall before.
deadline_after:
description: A date and time (ISO 8601 format or milliseconds) that release dates fall after.
responses:
200:
body:
application/json:
schema: stories
example: !include examples/stories-example.json
post:
description: Create a new story.
body:
application/json:
schema: storyReq
example: !include examples/storyReq-example.json
responses:
200:
body:
application/json:
example: !include examples/story-example.json
/{story_id}:
type: { member: { type: story } }
get:
description: Returns the specified story.
responses:
200:
body:
application/json:
example: !include examples/story-example.json
put:
description: Updates a story.
body:
application/json:
schema: storyReq
example: !include examples/storyUpdate-example.json
responses:
200:
body:
application/json:
example: !include examples/story-example.json
delete:
description: Deletes a story.
/tasks:
type: { collection: { type: task } }
get:
description: Returns the tasks on a specified story.
responses:
200:
body:
application/json:
schema: tasks
example: !include examples/tasks-example.json
post:
description: Returns the task that was created.
body:
application/json:
schema: taskReq
example: !include examples/taskReq-example.json
responses:
200:
body:
application/json:
example: !include examples/task-example.json
/{task_id}:
type: { member: { type: task } }
get:
description: Returns the specified task on a specified story.
responses:
200:
body:
application/json:
example: !include examples/task-example.json
put:
description: Updates the specified task
body:
application/json:
schema: taskReq
example: !include examples/taskReq-example.json
responses:
200:
body:
application/json:
example: !include examples/task-example.json
delete:
description: Deletes the specified task
/labels:
type: { collection: { type: label } }
post:
description: Returns the label that was created.
body:
application/json:
schema: labelReq
example: !include examples/labelReq-example.json
responses:
200:
body:
application/json:
example: !include examples/label-example.json
get:
description: |
Returns the labels on a specified story.
responses:
200:
body:
application/json:
schema: lables
example: !include examples/lables-example.json
/{label_id}:
type: base
delete:
description: Removes the label from the story.
/owners:
type: base
get:
description: Returns the owners of a specified story.
responses:
200:
body:
application/json:
schema: persons
example: !include examples/persons-example.json
post:
description: Add a user as an owner of the story.
body:
application/json:
schema: ownerReq
example: !include examples/ownerReq-example.json
responses:
200:
body:
application/json:
schema: person
example: !include examples/person-example.json
/{person_id}:
delete:
description: Removes ownership of a story from a person.
/comments:
type: { collection: { type: comment } }
get:
description: "Returns the specified story's comments."
responses:
200:
body:
application/json:
schema: comments
example: !include examples/comments-example.json
post:
description: Add a new comment.
body:
application/json:
schema: commentReq
example: !include examples/commentReq-example.json
responses:
200:
body:
application/json:
example: !include examples/comment-example.json
/{comment_id}:
type: { member: { type: comment } }
get:
description: Gets a comment.
responses:
200:
body:
application/json:
example: !include examples/comment-example.json
put:
description: Updates a comment.
body:
application/json:
schema: commentReq
example: !include examples/commentReq-example.json
responses:
200:
body:
application/json:
example: !include examples/comment-example.json
delete:
description: Deletes a comment.
/google_attachments/{google_attachment_id}:
delete:
description: Deletes a google attachment.
/file_attachments/{file_attachment_id}:
delete:
description: Deletes a google attachment.
/activity:
type: activityType
get:
description: "Return list of the selected story's activity. "
queryParameters:
since_version:
description: Activity will be returned only for operations that occurred after the specified version.
/epics:
type: { collection: { type: epic } }
get:
description: Returns a list of all epics in the project.
queryParameters:
filter:
description: This parameter supplies a search string; only epics that match the search criteria are returned.
responses:
200:
body:
application/json:
schema: epics
example: !include examples/epics-example.json
post:
description: Create a new epic.
body:
application/json:
schema: epicReq
example: !include examples/epicReq-example.json
responses:
200:
body:
application/json:
example: !include examples/epic-example.json
/{epic_id}:
type: { member: { type: epic } }
get:
description: Returns the specified epic.
responses:
200:
body:
application/json:
schema: epic
example: !include examples/epic-example.json
put:
description: Updates an epic.
body:
application/json:
schema: epicUpdate
example: !include examples/epicUpdate-example.json
responses:
200:
body:
application/json:
example: !include examples/epic-example.json
delete:
description: Deletes an epic.
/activity:
type: activityType
get:
is: [ pageable ]
description: "Return list of the selected epic's activity."
queryParameters:
since_version:
description: Activity will be returned only for operations that occurred after the specified version.
/comments:
type: { collection: { type: comment } }
get:
description: "Returns the specified epic's comments."
responses:
200:
body:
application/json:
schema: comments
example: !include examples/comments-example.json
post:
description: Add a new comment.
body:
application/json:
schema: commentReq
example: !include examples/commentReq-example.json
responses:
200:
body:
application/json:
example: !include examples/comment-example.json
/{comment_id}:
type: { member: { type: comment } }
get:
description: Gets a comment.
responses:
200:
body:
application/json:
example: !include examples/comment-example.json
put:
description: Updates a comment.
body:
application/json:
schema: commentReq
example: !include examples/commentReq-example.json
responses:
200:
body:
application/json:
example: !include examples/comment-example.json
delete:
description: Deletes a comment.
/uploads:
post:
description: Upload a file to the Tracker server. Tracker will create a matching file_attachment object which can be attached to a future comment on a story.
body:
multipart/form-data:
formParameters:
comment:
description: The comment with which the file attachment will be associated.
file:
description: |
The content of the file being uploaded. It is expected to be incorporated in the multipart data with a 'Content-Disposition' of 'form-data; name="file"; filename="imperial_banner.png"'.
A Content-Type that describes the file being uploaded should be supplied if possible.
required: true
responses:
200:
body:
application/json:
schema: file_attachment
example: !include examples/file_attachment-example.json
/search:
get:
description: Search for stories and epics.
queryParameters:
query:
description: String containing the search terms and options.
required: true
default: label%3Amnt
responses:
200:
body:
application/json:
schema: search_result_container
example: !include examples/search_result_container-example.json
/my/searches:
get:
description: Provides a list of the searches which have been saved by the current person.
responses:
200:
body:
application/json:
schema: saved_search
example: !include examples/saved_search-example.json
post:
description: Saves a new search.
body:
application/json:
schema: saved_searchReq
example: !include examples/saved_searchReq-example.json
responses:
200:
body:
application/json:
schema: saved_search
example: !include examples/saved_search-example.json
/{search_id}:
delete:
description: Deletes a saved search.
/activity:
type: activityType
get:
description: Return list of the selected project activity.
queryParameters:
since_version:
description: Activity will be returned only for operations that occurred after the specified version.
/export:
post:
description: "POSTing to an individual project resource's URL is used to send story-selection parameters. The server responds with a CSV export file containing data from the selected stories."
/webhooks:
type: { collection: { type: webhook } }
get:
description: "Return the project's webhooks."
responses:
200:
body:
application/json:
schema: webhooks
example: !include examples/webhooks-example.json
post:
description: Creates a webhook on the project.
body:
application/json:
schema: webhookReq
example: !include examples/webhookReq-example.json
responses:
200:
body:
application/json:
example: !include examples/webhook-example.json
/{webhook_id}:
type: { member: { type: webhook } }
get:
description: Return the specified project webhook.
responses:
200:
body:
application/json:
example: !include examples/webhook-example.json
put:
description: Update the specified project webhook.
body:
application/json:
schema: webhookReq
example: !include examples/webhookReq-example.json
responses:
200:
body:
application/json:
example: !include examples/webhook-example.json
delete:
description: Delete the specified project webhook.
/accounts:
type: { collection: { type: account } }
get:
description: Get all of the accounts a user is an owner or admin of.
responses:
200:
body:
application/json:
example: !include examples/accounts-example.json
/{account_id}:
type: { member: { type: account } }
get:
description: Fetch the content of the specified account.
responses:
200:
body:
application/json:
example: !include examples/account-example.json
/memberships:
get:
description: List all of the memberships in an account.
responses:
200:
body:
application/json:
schema: accountsMembership
example: !include examples/accountsMembership-example.json
post:
description: Create a new membership in an account.
body:
application/json:
schema: accountCreateReq
example: !include examples/accountCreateReq-example.json
responses:
200:
body:
application/json:
schema: membershipPerson
example: !include examples/membershipPerson-example.json
/{person_id}:
type: base
get:
description: Returns the specified account membership.
responses:
200:
body:
application/json:
schema: membershipPerson
example: !include examples/membershipPerson-example.json
put:
description: Updates the specified account membership.
body:
application/json:
schema: accountUhdateReq
example: !include examples/accountUhdateReq-example.json
responses:
200:
body:
application/json:
schema: membershipPerson
example: !include examples/membershipPerson-example.json
delete:
description: Delete the specified account membership.
/stories:
/{story_id}:
type: { member: { type: story } }
get:
description: Returns the specified story.
responses:
200:
body:
application/json:
example: !include examples/story-example.json
put:
description: Updates the specified story.
body:
application/json:
schema: storyReq
example: !include examples/storyReq-example.json
responses:
200:
body:
application/json:
example: !include examples/story-example.json
delete:
description: Deletes the specified story.
/export:
type: base
post:
description: POSTing is used to send story-selection parameters. The server responds with a CSV export file containing data from the selected stories.
/epics/{epic_id}:
type: { member: { type: epic } }
get:
description: Returns the specified epic.
responses:
200:
body:
application/json:
example: !include examples/epic-example.json
/file_attachments/{file_attachment_id}/download:
type: base
get:
queryParameters:
inline:
description: Determines if server should include response headers that would cause a browser to show the attachment in a new tab or window (inline=true) or show a Save dialog box (inline=false). Default is false.
type: boolean
/google_attachments:
type: base
get:
description: "Fetch items describing the user's available Google resources."
responses:
200:
body:
application/json:
schema: google_attachments
example: !include examples/google_attachments-example.json
/source_commits:
type: base
post:
description: Creates a comment associated with a commit in a Source Control system.
body:
application/json:
schema: source_commitReq
example: !include examples/source_commitReq-example.json
responses:
200:
body:
application/json:
schema: stories
example: !include examples/stories-example.json
/aggregator:
type: base
post:
description: |
Unimplemented.
The aggregator allows the client to make a single request that returns the same information as several separate GETs to other endpoints.
documentation:
- title: Headline
content: !include docs/api/headline.md