-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsnippets.xml
1792 lines (1764 loc) · 73 KB
/
snippets.xml
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
<p>
<ac:structured-macro ac:name="toc">
<ac:parameter ac:name="maxLevel">4</ac:parameter>
<ac:parameter ac:name="minLevel">2</ac:parameter>
</ac:structured-macro>
</p>
<h2>Overview</h2>
<p>The snippets endpoint allows you many ways to create and retrieve information about snippets in Bitbucket.</p>
<p>Snippets can be either public (visible to anyone on Bitbucket, as well as anonymous users), or private (visible only to the owner, creator and members of the team in case the snippet is owned by a team).</p>
<h3>Permissions</h3>
<p>Snippets can be either public or private as shown in the following table:</p>
<table>
<tbody>
<tr>
<th>Snippet owner</th>
<th>Private:<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[is_private=true]]></ac:plain-text-body>
</ac:structured-macro></th>
<th>Public: <ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[is_private=false]]></ac:plain-text-body>
</ac:structured-macro></th>
</tr>
<tr>
<td>Team </td>
<td>Only members of the team, including the creator, can view the snippet. </td>
<td>Everyone, including anonymous users, can view the snippet. Only team members can edit the snippet.</td>
</tr>
<tr>
<td colspan="1">Individual account</td>
<td colspan="1">Only the owner of the account can view the snippet.</td>
<td colspan="1">Everyone, including anonmyous users, can view the snippet. Only the account owner can edit the snippet.</td>
</tr>
</tbody>
</table>
<p>
<ac:structured-macro ac:name="info">
<ac:rich-text-body>
<p>The team or user UUID can also be used in calls, however remember the <a href="https://confluence.atlassian.com/display/BITBUCKET/Use+the+Bitbucket+REST+APIs#UsetheBitbucketRESTAPIs-uuid-mainUniversallyUniqueIdentifier%28UUID%29">UUID specification</a> regarding special characters.</p>
</ac:rich-text-body>
</ac:structured-macro>
<h2>snippetsResource</h2>
<h3>POST a new snippet</h3>
<p>Essentially all properties are optional except authentication. This means that creating a snippet from a local file (either binary or text) can be as easy as:</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl -u {username} -X POST https://api.bitbucket.org/2.0/snippets/ \
-F [email protected]]]></ac:plain-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="info">
<ac:rich-text-body>
<p>Bitbucket will assign each snippet an alphanumeric "id" even if you assign a title and description.</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click here to view response...</ac:parameter>
<ac:rich-text-body>
<pre>curl -u {username} -X POST https://api.bitbucket.org/2.0/snippets/teamsinspace \
-F [email protected]</pre>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[{
"created_on": "2015-03-18T18:50:07.990433+00:00",
"creator": {
"display_name": "Daniel Stevens",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Jan/29/dans9190-avatar-2647033047-1_avatar.png"
},
"html": {
"href": "https://bitbucket.org/dans9190"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/dans9190"
}
},
"username": "dans9190",
"uuid": "{1cd06601-cd0e-4fce-be03-e9ac226978b7}"
},
"files": {
"README.md": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/KzRo/revisions/a697ae7cdbfa2ba3dbb4d3bacc7669493ebae5e3#README.md"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/a697ae7cdbfa2ba3dbb4d3bacc7669493ebae5e3/files/README.md"
}
}
}
},
"id": "KzRo",
"is_private": false,
"links": {
"comments": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/commits"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/a697ae7cdbfa2ba3dbb4d3bacc7669493ebae5e3/diff"
},
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/KzRo"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/a697ae7cdbfa2ba3dbb4d3bacc7669493ebae5e3/patch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo"
},
"watchers": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/watchers"
}
},
"owner": {
"display_name": "Teams In Space",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Sep/24/teamsinspace-avatar-3731530358-7_avatar.png"
},
"html": {
"href": "https://bitbucket.org/teamsinspace"
},
"self": {
"href": "https://api.bitbucket.org/2.0/teams/teamsinspace"
}
},
"username": "teamsinspace",
"uuid": "{61fc5cf6-d054-47d2-b4a9-061ccf858379}"
},
"scm": "git",
"title": "",
"updated_on": "2015-03-18T18:50:07.990473+00:00"
}
]]></ac:plain-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
<h3>POST Multipart considerations</h3>
<p>A snippet can contain multiple files or entries so you create with a multipart POST using either:</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[multipart/related]]></ac:plain-text-body>
</ac:structured-macro>
<p>or</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[multipart/form-data]]></ac:plain-text-body>
</ac:structured-macro>
<p>Both allow the creation of snippets with both meta data (title, etc), as well as multiple text and binary files. The main difference is that `<code>multipart/related</code>` can use rich encoding for the meta data (currently JSON).</p>
<h4>multipart/related (RFC-2387)</h4>
<p>This is the most advanced and efficient way to create a snippet.</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[ POST /2.0/snippets/{username} HTTP/1.1
Content-Length: 1188
Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
MIME-Version: 1.0
--===============1438169132528273974==
Content-Type: application/json; charset="utf-8"
MIME-Version: 1.0
Content-ID: snippet
{
"title": "My snippet",
"is_private": true,
"files": {
"foo.txt": {},
"image.png": {}
}
}
--===============1438169132528273974==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-ID: "foo.txt"
Content-Disposition: attachment; filename="foo.txt"
foo
--===============1438169132528273974==
Content-Type: image/png
MIME-Version: 1.0
Content-Transfer-Encoding: base64
Content-ID: "image.png"
Content-Disposition: attachment; filename="image.png"
iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
--===============1438169132528273974==--]]></ac:plain-text-body>
</ac:structured-macro>
<p>The request contains multiple parts and is structured as follows:</p>
<ul>
<li>The first part is the JSON document which describes the snippet's properties or metadata. It either has to be the first part, or the request's `<code>Content-Type</code>` header must contain the `<code>start</code>` parameter to point to it.</li>
<li>The remaining parts are the files of which there can be zero or more. Each file part should contain the `<code>Content-ID</code>` MIME header through which the JSON meta data's `<code>files</code>` element addresses it. The value should be the name of the file.</li>
<li>`<code>Content-Disposition</code>` is an optional MIME header. The header's optional `<code>filename</code>` parameter can be used to specify the file name that Bitbucket should use when writing the file to disk. When present, `<code>filename</code>` takes precedence over the value of `<code>Content-ID</code>`.</li>
<li>When the JSON body omits the <code>files</code> element, the remaining parts are not ignored. Instead, each file is added to the new snippet as if its name was explicitly linked (the use of the `<code>files</code>` elements is mandatory for some operations like deleting or renaming files).</li>
</ul>
<h4>multipart form</h4>
<p>The use of JSON for the snippet's metadata is optional. Metadata can also be supplied as regular form fields in a more conventional `m<code>ultipart/form-data</code>` request, as shown in the following example:</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl -u {username} -X POST https://api.bitbucket.org/2.0/snippets/teamsinspace \
-F title="multipart snippet" \
-F [email protected] \
-F [email protected]]]></ac:plain-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click to expand and view a response...</ac:parameter>
<ac:rich-text-body>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[{
"created_on": "2015-03-18T17:25:48.967354+00:00",
"creator": {
"display_name": "Daniel Stevens",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Jan/29/dans9190-avatar-2647033047-1_avatar.png"
},
"html": {
"href": "https://bitbucket.org/dans9190"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/dans9190"
}
},
"username": "dans9190",
"uuid": "{1cd06601-cd0e-4fce-be03-e9ac226978b7}"
},
"files": {
"README.md": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/4c0ce23eae4487d0779fe9b021a433ea284dce9e#README.md"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/files/README.md"
}
}
},
"myquote2.html": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/4c0ce23eae4487d0779fe9b021a433ea284dce9e#myquote2.html"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/files/myquote2.html"
}
}
}
},
"id": "kypj",
"is_private": false,
"links": {
"comments": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/commits"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/diff"
},
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/patch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj"
},
"watchers": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/watchers"
}
},
"owner": {
"display_name": "Teams In Space",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Sep/24/teamsinspace-avatar-3731530358-7_avatar.png"
},
"html": {
"href": "https://bitbucket.org/teamsinspace"
},
"self": {
"href": "https://api.bitbucket.org/2.0/teams/teamsinspace"
}
},
"username": "teamsinspace",
"uuid": "{61fc5cf6-d054-47d2-b4a9-061ccf858379}"
},
"scm": "git",
"title": "multipart snippet",
"updated_on": "2015-03-18T17:25:48.967370+00:00"
}]]></ac:plain-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
<p>Here the meta data properties are included as flat, top-level form fields. The file attachments use the `file` field name. To attach multiple files, simply repeat the field. The advantage of `<code>multipart/form-data</code>` over `<code>multipart/related</code>` is that it's easier to build clients.</p>
<h3>PUT an update to a snippet</h3>
<p>Add and delete files and to change a snippet's title. To update a snippet, one can either PUT a full snapshot, or only the parts that need to be changed. The contract for PUT on this API is that properties missing from the request remain untouched so that snippets can be efficiently manipulated with differential payloads. To delete a property (e.g. the title, or a file), include its name in the request, but omit its value (use null).</p>
<ac:structured-macro ac:name="info">
<ac:rich-text-body>
<p>Explicit renaming of files is not supported. To rename a file, delete it and add it again under another name. This can be done atomically in a single request. Rename detection is left to the SCM.</p>
<p>The owner and creator values cannot be modified in a snippet.</p>
</ac:rich-text-body>
</ac:structured-macro>
<p>PUT calls support the following content types for both request and response bodies:</p>
<ul>
<li>
<code>application/json</code>
</li>
<li>
<code>multipart/related</code>
</li>
<li>
<code>multipart/form-data</code>
</li>
</ul>
<p>The content type used for the request body can be different than that used for the response. Content types are specified using standard HTTP headers. Use the <code>Content-Type</code> and <code>Accept</code> headers to select the desired request and response format.</p>
<h4>application/json</h4>
<p>As with creation and retrieval, the content type determines what properties can be manipulated. <code>application/json</code> does not support file contents and is therefore limited to a snippet's meta data.</p>
<h5>Update title without changing files</h5>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl -u {username} -X PUT https://api.bitbucket.org/2.0/snippets/{username or teamname}/{snippet id} \
-d '{"title": "Newer snippet title"}' \
-H 'Content-Type: application/json']]></ac:plain-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click here to expand and view a response</ac:parameter>
<ac:rich-text-body>
<p>
<code>curl -u {username} -X PUT <span class="nolink">https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj</span> \</code> <br/> <code> -d '{"title": "Example API snippet"}' \</code> <br/> <code> -H 'Content-Type: application/json'</code>
</p>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="title">View a json respone for chaning title</ac:parameter>
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[{
"created_on": "2015-03-18T19:04:47.666240+00:00",
"creator": {
"display_name": "Daniel Stevens",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Jan/29/dans9190-avatar-2647033047-1_avatar.png"
},
"html": {
"href": "https://bitbucket.org/dans9190"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/dans9190"
}
},
"username": "dans9190",
"uuid": "{1cd06601-cd0e-4fce-be03-e9ac226978b7}"
},
"files": {
"README.md": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/4c0ce23eae4487d0779fe9b021a433ea284dce9e#README.md"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/files/README.md"
}
}
},
"myquote2.html": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/4c0ce23eae4487d0779fe9b021a433ea284dce9e#myquote2.html"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/files/myquote2.html"
}
}
}
},
"id": "kypj",
"is_private": false,
"links": {
"comments": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/commits"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/diff"
},
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/4c0ce23eae4487d0779fe9b021a433ea284dce9e/patch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj"
},
"watchers": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/watchers"
}
},
"owner": {
"display_name": "Teams In Space",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Sep/24/teamsinspace-avatar-3731530358-7_avatar.png"
},
"html": {
"href": "https://bitbucket.org/teamsinspace"
},
"self": {
"href": "https://api.bitbucket.org/2.0/teams/teamsinspace"
}
},
"username": "teamsinspace",
"uuid": "{61fc5cf6-d054-47d2-b4a9-061ccf858379}"
},
"scm": "git",
"title": "Example API snippet",
"updated_on": "2015-03-18T19:04:47.666275+00:00"
}]]></ac:plain-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
<p>To delete a snippet title leave the title field empty just leave the title value empty</p>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[curl -u {username} -X PUT https://api.bitbucket.org/2.0/snippets/{username or teamname}/{snippet ID} \
-d '{"title": ""}' \
-H 'Content-Type: application/json']]></ac:plain-text-body>
</ac:structured-macro>
<h4>multipart/related</h4>
<p>You can use<code> multipart/related</code> to manipulate all of a snippet's properties. The body is identical to a POST. properties omitted from the request are left unchanged. Since the <code>start</code> part contains JSON, the mechanism for manipulating the snippet's meta data is identical to <code>application/json</code> requests.</p>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="title">update one of a snippet's file contents, while also changing its title</ac:parameter>
<ac:parameter ac:name="language">js</ac:parameter>
<ac:parameter ac:name="collapse">true</ac:parameter>
<ac:plain-text-body><![CDATA[PUT /2.0/snippets/{username}/{id} HTTP/1.1
Content-Length: 288
Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
MIME-Version: 1.0
--===============1438169132528273974==
Content-Type: application/json; charset="utf-8"
MIME-Version: 1.0
Content-ID: snippet
{
"title": "My updated snippet",
"files": {
"foo.txt": {}
}
}
--===============1438169132528273974==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-ID: "foo.txt"
Content-Disposition: attachment; filename="foo.txt"
Updated file contents.
--===============1438169132528273974==-- ]]></ac:plain-text-body>
</ac:structured-macro>
<p>Here only the parts that are changed are included in the body. The other files remain untouched.</p>
<p>Note the use of the <code>files</code> map in the JSON part. This map contains the files that are being manipulated. This map should have corresponding parts in the request that contain the new contents of these files. If a filename in the <code>files</code> map does not have a corresponding part, it will be deleted from the snippet, as shown below:</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[PUT /2.0/snippets/{username}/{id} HTTP/1.1
Content-Length: 188
Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
MIME-Version: 1.0
--===============1438169132528273974==
Content-Type: application/json; charset="utf-8"
MIME-Version: 1.0
Content-ID: snippet
{
"files": {
"foo.txt": {}
}
}
--===============1438169132528273974==--]]></ac:plain-text-body>
</ac:structured-macro>
<p>A rename would look something like this:</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[PUT /2.0/snippets/{username}/{id} HTTP/1.1
Content-Length: 212
Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
MIME-Version: 1.0
--===============1438169132528273974==
Content-Type: application/json; charset="utf-8"
MIME-Version: 1.0
Content-ID: snippet
{
"files": {
"foo.txt": {},
"bar.txt": {}
}
}
--===============1438169132528273974==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-ID: "bar.txt"
Content-Disposition: attachment; filename="bar.txt"
foo
--===============1438169132528273974==--]]></ac:plain-text-body>
</ac:structured-macro>
<h4>multipart/form-data</h4>
<p>You can also use <code>multipart/form-data</code> to manipulate file contents and meta data atomically.</p>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click here to expand and view a response</ac:parameter>
<ac:rich-text-body>
<pre>curl -u {username} -X PUT <span>https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/</span> \<br/> -F title="API docs snippet" \<br/> -F [email protected]</pre>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[{
"created_on": "2015-03-18T19:56:51.269348+00:00",
"creator": {
"display_name": "Daniel Stevens",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Jan/29/dans9190-avatar-2647033047-1_avatar.png"
},
"html": {
"href": "https://bitbucket.org/dans9190"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/dans9190"
}
},
"username": "dans9190",
"uuid": "{1cd06601-cd0e-4fce-be03-e9ac226978b7}"
},
"files": {
"README.md": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/503019269b337032912f7fea99ed6f9bf1b91c24#README.md"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/files/README.md"
}
}
},
"myquote2.html": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/503019269b337032912f7fea99ed6f9bf1b91c24#myquote2.html"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/files/myquote2.html"
}
}
}
},
"id": "kypj",
"is_private": false,
"links": {
"comments": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/commits"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/diff"
},
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/patch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj"
},
"watchers": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/watchers"
}
},
"owner": {
"display_name": "Teams In Space",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Sep/24/teamsinspace-avatar-3731530358-7_avatar.png"
},
"html": {
"href": "https://bitbucket.org/teamsinspace"
},
"self": {
"href": "https://api.bitbucket.org/2.0/teams/teamsinspace"
}
},
"username": "teamsinspace",
"uuid": "{61fc5cf6-d054-47d2-b4a9-061ccf858379}"
},
"scm": "git",
"title": "API docs snippet",
"updated_on": "2015-03-18T19:56:51.269378+00:00"
}]]></ac:plain-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
<p>To delete a file, omit its contents while including its name in the <code>files</code> field. The explicit use of the <code>files</code> element in <code>multipart/related</code> and <code>multipart/form-data</code> is only required when deleting files. The default mode of operation is for file parts to be processed, regardless of whether or not they are listed in <code>files</code>, as a convenience to the client.</p>
<h3>DELETE a snippet</h3>
<p>Allows you to delete a snippet. When successful the call returns: <code>HTTP/1.1 204 NO CONTENT</code>
</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl -u {username} -X DELETE https://api.bitbucket.org/2.0/snippets/{teamname or username}/{snippet id}]]></ac:plain-text-body>
</ac:structured-macro>
<h3>GET a specific snippet</h3>
<p>Gets the information associated with a specific snippet. Authentication is required for snippets set to private. This call takes the following parameters:</p>
<table>
<tbody>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>username or teamname</td>
<td>yes</td>
<td>The Bitbucket username or team name of the snippets owner</td>
</tr>
<tr>
<td colspan="1">id</td>
<td colspan="1">yes</td>
<td colspan="1">The id assigned by Bitbucket when the snippet was created.</td>
</tr>
</tbody>
</table>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl https://api.bitbucket.org/2.0/snippets/{username}/{id}]]></ac:plain-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click here to expand to view JSON repsonse without file contents </ac:parameter>
<ac:rich-text-body>
<p>
<code>
<span class="nolink">curl <span class="nolink">https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj</span> </span>
</code>
</p>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="title"/>
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[{
"created_on": "2015-03-18T19:56:51.269348+00:00",
"creator": {
"display_name": "Daniel Stevens",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Jan/29/dans9190-avatar-2647033047-1_avatar.png"
},
"html": {
"href": "https://bitbucket.org/dans9190"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/dans9190"
}
},
"username": "dans9190",
"uuid": "{1cd06601-cd0e-4fce-be03-e9ac226978b7}"
},
"files": {
"README.md": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/503019269b337032912f7fea99ed6f9bf1b91c24#README.md"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/files/README.md"
}
}
},
"myquote2.html": {
"links": {
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj/revisions/503019269b337032912f7fea99ed6f9bf1b91c24#myquote2.html"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/files/myquote2.html"
}
}
}
},
"id": "kypj",
"is_private": false,
"links": {
"comments": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/commits"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/diff"
},
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/kypj"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/503019269b337032912f7fea99ed6f9bf1b91c24/patch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj"
},
"watchers": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/watchers"
}
},
"owner": {
"display_name": "Teams In Space",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Sep/24/teamsinspace-avatar-3731530358-7_avatar.png"
},
"html": {
"href": "https://bitbucket.org/teamsinspace"
},
"self": {
"href": "https://api.bitbucket.org/2.0/teams/teamsinspace"
}
},
"username": "teamsinspace",
"uuid": "{61fc5cf6-d054-47d2-b4a9-061ccf858379}"
},
"scm": "git",
"title": "API docs snippet",
"updated_on": "2015-03-18T19:56:51.269378+00:00"
}]]></ac:plain-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
<p>
<span class="nolink"> <br/> </span>
</p>
<p>Since JSON is always <code>utf-8</code>, it cannot reliably contain file contents for files that are not text. Therefore, JSON snippet documents only contain the filename and links to the file contents. This means that in order to retrieve all parts of a snippet, N+1 requests need to be made (where N is the number of files in the snippet).</p>
<p>To avoid this problem, retrieve the snippet in multipart/related format, which will include the the contents of all files. This can return the contents of any type of file, including binary:</p>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl https://api.bitbucket.org/2.0/snippets/{teamname or username}/{id} \
-H "Accept: multipart/related"]]></ac:plain-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click here to expand and view a response</ac:parameter>
<ac:rich-text-body>
<p>
<code>curl <span>https://api.bitbucket.org/2.0/snippets/teamsinspace/kypj/</span> -H "Accept: multipart/related"</code>
</p>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><
### How do I get set up? ###
* Summary of set up
* Configuration
* Dependencies
* Database configuration
* How to run tests
* Deployment instructions
### Contribution guidelines ###
* Writing tests
* Code review
* Other guidelines
### Who do I talk to? ###
* Repo owner or admin
* Other community or team contact
--===============0818187906501074328==
Content-Type: text/plain
MIME-Version: 1.0
Content-ID: myquote2.html
Content-Disposition: attachment; name="file"; filename="myquote2.html"
<!--
To add a quote, copy the div below and paste it at the bottom of the file.
Then populate it with your quote and attribution.
You can add an optional image tag. The image must be linked from an external
site and not be in the repository.
<div class="quote">
<blockquote>Your quote goes here</blockquote>
<cite>Attribution</cite>
</div>
Please do not edit above this line -->
<div class="quote">
<blockquote>very influential stuff</blockquote>
<cite>very important person</cite>
</div>
<div class="quote">
<blockquote>Something really smart</blockquote>
<cite>A really smart person</cite>
</div>
<div class="quote">
<blockquote>Something really nice</blockquote>
<cite>A really nice person</cite>
</div>
* Connection #0 to host api.bitbucket.org left intact
--===============0818187906501074328==--]]></ac:plain-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
<h3>GET a list of snippets for a user or a team</h3>
<p>Gets a list of all the snippets owned with a user or a team. Authentication is required to return snippets set to private.</p>
<table>
<tbody>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>
<p>
<span>username </span>
</p>
<p>
<span>or </span>
</p>
<p>
<span>teamname<br/> </span>
</p>
</td>
<td>Yes</td>
<td>
<p>The Bitbucket username or teamname of the account or team's snippets you want to retrieve.</p>
<p>The UUID can also be used. However, remember the <a href="https://confluence.atlassian.com/display/BITBUCKET/Use+the+Bitbucket+REST+APIs#UsetheBitbucketRESTAPIs-uuid-mainUniversallyUniqueIdentifier%28UUID%29">UUID specification</a> regarding special characters.</p>
</td>
</tr>
</tbody>
</table>
<ac:structured-macro ac:name="code">
<ac:plain-text-body><![CDATA[curl https://api.bitbucket.org/2.0/snippets/{username or teamname}]]></ac:plain-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="expand">
<ac:parameter ac:name="title">Click to expand and view a response...</ac:parameter>
<ac:rich-text-body>
<p>
<code>curl <span class="nolink">https://api.bitbucket.org/2.0/snippets/teamsinspace</span>
</code>
</p>
<ac:structured-macro ac:name="code">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body><![CDATA[{
"page": 1,
"pagelen": 30,
"size": 3,
"values": [
{
"created_on": "2015-03-18T18:50:07.990433+00:00",
"id": "KzRo",
"is_private": false,
"links": {
"comments": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/commits"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/a697ae7cdbfa2ba3dbb4d3bacc7669493ebae5e3/diff"
},
"html": {
"href": "https://bitbucket.org/snippets/teamsinspace/KzRo"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/a697ae7cdbfa2ba3dbb4d3bacc7669493ebae5e3/patch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo"
},
"watchers": {
"href": "https://api.bitbucket.org/2.0/snippets/teamsinspace/KzRo/watchers"
}
},
"owner": {
"display_name": "Teams In Space",
"links": {
"avatar": {
"href": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2014/Sep/24/teamsinspace-avatar-3731530358-7_avatar.png"