-
Notifications
You must be signed in to change notification settings - Fork 52
/
openapi.json
1547 lines (1547 loc) · 48.1 KB
/
openapi.json
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",
"schemes": [
"https"
],
"host": "www.versioneye.com",
"basePath": "/api/v2",
"info": {
"description": "VersionEye is a cross-platform search engine for free/libre/open source software libraries.",
"title": "Available API endpoints",
"version": "2.0",
"x-apisguru-categories": [
"open_data",
"search"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_versioneye.files.wordpress.com_2015_05_versioneyetransparent.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://www.versioneye.com/api/v2/swagger_doc.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "versioneye.com",
"x-datafire": {
"name": "versioneye",
"type": "openapi"
}
},
"produces": [
"application/json"
],
"tags": [
{
"description": "Operations about sessions",
"name": "sessions"
},
{
"description": "Operations about services",
"name": "services"
},
{
"description": "Operations about products",
"name": "products"
},
{
"description": "Operations about projects",
"name": "projects"
},
{
"description": "Operations about organisations",
"name": "organisations"
},
{
"description": "Operations about mes",
"name": "me"
},
{
"description": "Operations about users",
"name": "users"
},
{
"description": "Operations about githubs",
"name": "github"
},
{
"description": "Operations about securities",
"name": "security"
}
],
"paths": {
"/github": {
"get": {
"description": "\nThis endpoint shows all imported repositories from your Github account.\n\nThis enpoint expects that you have a GitHub account connected and the token\nis still valid. If that is not the case please visit **https://www.versioneye.com/settings/connect**.\nto update your GitHub credentials.\n\nIf it shows no or old data, then you can use the `github/sync` endpoint\nto update your account with the current meta data from GitHub.",
"operationId": "getGithub",
"parameters": [
{
"description": "Filter by language",
"in": "query",
"name": "lang",
"required": false,
"type": "string"
},
{
"description": "Filter by visibility",
"in": "query",
"name": "private",
"required": false,
"type": "boolean"
},
{
"description": "Filter by name of organization",
"in": "query",
"name": "org_name",
"required": false,
"type": "string"
},
{
"description": "Filter by type of organization",
"in": "query",
"name": "org_type",
"required": false,
"type": "string"
},
{
"default": "1",
"description": "Number of page",
"in": "query",
"name": "page",
"required": false,
"type": "string"
},
{
"description": "Show only imported repositories",
"in": "query",
"name": "only_imported",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "lists your's github repos"
}
},
"summary": "lists your's github repos",
"tags": [
"github"
]
}
},
"/github/hook/{project_id}": {
"post": {
"consumes": [
"application/json"
],
"description": "This endpoint is registered as service hook on GitHub. It triggers a project re-parse on each git push. ",
"operationId": "postGithubHookProjectId",
"parameters": [
{
"description": "Project ID",
"in": "path",
"name": "project_id",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "github service hook"
}
},
"summary": "github service hook",
"tags": [
"github"
]
}
},
"/github/sync": {
"get": {
"description": "\nReimports ALL GitHub Repositories. This Endpoint fetches meta information to all\nrepositories in your GitHub account. Meta information such as repo name, branches and\nsupported project files.\n\nThis endpoint works asynchronously and returns a status code. The status code is either\n**running** or **done**.",
"operationId": "getGithubSync",
"responses": {
"200": {
"description": "re-load github data"
}
},
"summary": "re-load github data",
"tags": [
"github"
]
}
},
"/github/{repo_key}": {
"delete": {
"description": "\nThis Endpoint deletes a project on VersionEye!\n\nDue the limits of our current API framework, the repo key has to be\nencoded as url-safe string. That means all '/' has to be replaced with\ncolons ':' and '.' has to be replaced with '~'.\n\nFor example, repository with fullname `versioneye/veye` has to transformed\nto `versioneye:veye`.",
"operationId": "deleteGithubRepoKey",
"parameters": [
{
"description": "encoded repo-key",
"in": "path",
"name": "repo_key",
"required": true,
"type": "string"
},
{
"default": "master",
"description": "the name of the branch",
"in": "query",
"name": "branch",
"required": false,
"type": "string"
}
],
"responses": {
"204": {
"description": "remove imported project"
}
},
"summary": "remove imported project",
"tags": [
"github"
]
},
"get": {
"description": "\nThis Endpoint returns detailed information about a GitHub repository.\n\nDue the limits of our current API framework, the repo key has to be\nencoded as url-safe string. That means all '/' has to be replaced with\ncolons ':' and '.' has to be replaced with '~'.\n\nFor example, repository with fullname `versioneye/veye` has to transformed\nto `versioneye:veye`.",
"operationId": "getGithubRepoKey",
"parameters": [
{
"description": "encoded repo name with optional branch info.",
"in": "path",
"name": "repo_key",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "shows the detailed information for the repository"
}
},
"summary": "shows the detailed information for the repository",
"tags": [
"github"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "\nUse this Endpoint to import a project file from GitHub. This will create a new project on VersionEye.\n\nDue the limits of our current API framework, the repo key has to be\nencoded as url-safe string. That means all '/' has to be replaced with\ncolons ':' and '.' has to be replaced with '~'.\n\nFor example, repository with fullname `versioneye/veye` has to transformed\nto `versioneye:veye`.",
"operationId": "postGithubRepoKey",
"parameters": [
{
"description": "encoded repo name",
"in": "path",
"name": "repo_key",
"required": true,
"type": "string"
},
{
"default": "master",
"description": "the name of the branch",
"in": "formData",
"name": "branch",
"required": false,
"type": "string"
},
{
"default": "Gemfile",
"description": "the project file (default is Gemfile)",
"in": "formData",
"name": "file",
"required": false,
"type": "string"
}
],
"responses": {
"201": {
"description": "imports project file from github"
}
},
"summary": "imports project file from github",
"tags": [
"github"
]
}
},
"/me": {
"get": {
"description": "On Swagger, you can create session by adding additional parameter :api_key.",
"operationId": "getMe",
"responses": {
"200": {
"description": "shows profile of authorized user"
}
},
"summary": "shows profile of authorized user",
"tags": [
"me"
]
}
},
"/me/comments": {
"get": {
"description": "shows comments of authorized user",
"operationId": "getMeComments",
"parameters": [
{
"description": "page number for pagination",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "shows comments of authorized user"
}
},
"summary": "shows comments of authorized user",
"tags": [
"me"
]
}
},
"/me/favorites": {
"get": {
"description": "shows the packages you are following",
"operationId": "getMeFavorites",
"parameters": [
{
"description": "page number for pagination",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "shows the packages you are following"
}
},
"summary": "shows the packages you are following",
"tags": [
"me"
]
}
},
"/me/notifications": {
"get": {
"description": "\nThis Endpoint returns the 30 latest notifications.\n\nIf there are new versions out there for software packages you follow directly on VersionEye, then\neach new version is a new **notification** for your account.",
"operationId": "getMeNotifications",
"parameters": [
{
"description": "Specify page for paging",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "shows unread notifications of authorized user"
}
},
"summary": "shows unread notifications of authorized user",
"tags": [
"me"
]
}
},
"/organisations": {
"get": {
"description": "\nThis endpoint requires the API key from a user. The result is a set of organisations and their API keys.",
"operationId": "getOrganisations",
"responses": {
"200": {
"description": "Returns the list of organisations you have access to"
}
},
"summary": "Returns the list of organisations you have access to",
"tags": [
"organisations"
]
}
},
"/organisations/{orga_name}/inventory": {
"get": {
"description": "\nFind a detailed description here: https://github.com/versioneye/versioneye-api/blob/master/docs/api/v2/organisation.md",
"operationId": "getOrganisationsOrgaNameInventory",
"parameters": [
{
"description": "Filter by team name",
"in": "query",
"name": "team_name",
"required": false,
"type": "string"
},
{
"description": "Filter by programming language",
"in": "query",
"name": "language",
"required": false,
"type": "string"
},
{
"description": "Filter down by project version",
"in": "query",
"name": "project_version",
"required": false,
"type": "string"
},
{
"description": "Post processing filter. Possible values are 'ALL', 'duplicates_only', 'show_duplicates'",
"in": "query",
"name": "post_filter",
"required": false,
"type": "string"
},
{
"format": "int32",
"in": "path",
"name": "orga_name",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Returns the inventory list of the organisation"
}
},
"summary": "Returns the inventory list of the organisation",
"tags": [
"organisations"
]
}
},
"/organisations/{orga_name}/inventory_diff": {
"get": {
"operationId": "getOrganisationsOrgaNameInventoryDiff",
"parameters": [
{
"description": "ID of the inventory diff object",
"in": "query",
"name": "inventory_diff_id",
"required": false,
"type": "string"
},
{
"format": "int32",
"in": "path",
"name": "orga_name",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Returns the inventory diff object"
}
},
"summary": "Returns the inventory diff object",
"tags": [
"organisations"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "\nThis Endpoint takes 2 inventory filters and calculates the difference between them.\nThe diff object contains wich items have been removed and/or added compared to the inventory1 filter.\nThe response of this Endpoint is the ID of the diff object, which is calculated async in the background.",
"operationId": "postOrganisationsOrgaNameInventoryDiff",
"parameters": [
{
"description": "Inventory1, filter by team name",
"in": "formData",
"name": "f1_team_name",
"required": false,
"type": "string"
},
{
"description": "Inventory1, filter by programming language",
"in": "formData",
"name": "f1_language",
"required": false,
"type": "string"
},
{
"description": "Inventory1, filter down by project version",
"in": "formData",
"name": "f1_project_version",
"required": false,
"type": "string"
},
{
"description": "Inventory1, post processing filter. Possible values are 'ALL', 'duplicates_only', 'show_duplicates'",
"in": "formData",
"name": "f1_post_filter",
"required": false,
"type": "string"
},
{
"description": "Inventory2, filter by team name",
"in": "formData",
"name": "f2_team_name",
"required": false,
"type": "string"
},
{
"description": "Inventory2, filter by programming language",
"in": "formData",
"name": "f2_language",
"required": false,
"type": "string"
},
{
"description": "Inventory2, filter down by project version",
"in": "formData",
"name": "f2_project_version",
"required": false,
"type": "string"
},
{
"description": "Inventory2, post processing filter. Possible values are 'ALL', 'duplicates_only', 'show_duplicates'",
"in": "formData",
"name": "f2_post_filter",
"required": false,
"type": "string"
},
{
"format": "int32",
"in": "path",
"name": "orga_name",
"required": true,
"type": "integer"
}
],
"responses": {
"201": {
"description": "Creates an inventory diff object"
}
},
"summary": "Creates an inventory diff object",
"tags": [
"organisations"
]
}
},
"/organisations/{orga_name}/projects": {
"get": {
"description": "Returns the list of projects",
"operationId": "getOrganisationsOrgaNameProjects",
"parameters": [
{
"format": "int32",
"in": "path",
"name": "orga_name",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Returns the list of projects"
}
},
"summary": "Returns the list of projects",
"tags": [
"organisations"
]
}
},
"/organisations/{orga_name}/teams": {
"get": {
"description": "Returns the list of teams",
"operationId": "getOrganisationsOrgaNameTeams",
"parameters": [
{
"format": "int32",
"in": "path",
"name": "orga_name",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Returns the list of teams"
}
},
"summary": "Returns the list of teams",
"tags": [
"organisations"
]
}
},
"/products/search/{q}": {
"get": {
"description": "\nThis resource returns same results as our web application. But you get it as JSON objects -\nthe result is an JSON array of product objects.\n\nWhen there's no match for the query, the result array will be empty.",
"operationId": "getProductsSearchQ",
"parameters": [
{
"description": "Query string. At least 2 characters.",
"in": "path",
"name": "q",
"required": true,
"type": "string"
},
{
"description": "Filter results by programming languages;\n For filtering multiple languages submit a comma separated list of language strings.",
"in": "query",
"name": "lang",
"required": false,
"type": "string"
},
{
"description": "Filter by GroupID. This is Java/Maven specific",
"in": "query",
"name": "g",
"required": false,
"type": "string"
},
{
"description": "Specify page for paging",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "search packages"
}
},
"summary": "search packages",
"tags": [
"products"
]
}
},
"/products/sha/{sha}": {
"get": {
"description": "\nThis Endpoint expects a SHA value and returns the corresponding product to it, if available.",
"operationId": "getProductsShaSha",
"parameters": [
{
"format": "int32",
"in": "path",
"name": "sha",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "search by SHA value"
}
},
"summary": "search by SHA value",
"tags": [
"products"
]
}
},
"/products/{lang}/{prod_key}": {
"get": {
"description": "\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Notes about status codes\n\n * API returns 404, when the product with given product key doesnt exists.\n\n * Response 302 means that you didnt encode prod_key correctly.* (Replace all dots & slashes ) *",
"operationId": "getProductsLangProdKey",
"parameters": [
{
"description": "\"Name of programming language\"",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": "\"Encoded product key, replace all `/` and `.`",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
},
{
"description": "\"Version string\"",
"in": "query",
"name": "prod_version",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "detailed information for specific package"
}
},
"summary": "detailed information for specific package",
"tags": [
"products"
]
}
},
"/products/{lang}/{prod_key}/follow": {
"delete": {
"description": "\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Response codes\n\n * 400 - bad request; you used wrong product key;\n * 401 - unauthorized - please append api_key\n * 403 - forbidden; you are not authorized; or just missed api_key;",
"operationId": "deleteProductsLangProdKeyFollow",
"parameters": [
{
"description": "Programming language",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": "Package specifier",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "unfollow given software package"
}
},
"summary": "unfollow given software package",
"tags": [
"products"
]
},
"get": {
"description": "\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Notes about status codes\n\nThis resource will returns the status code 404 if there is no product\nfor the given prod_key.",
"operationId": "getProductsLangProdKeyFollow",
"parameters": [
{
"description": "\"Name of programming language\"",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": "Package specifier",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "check your following status"
}
},
"summary": "check your following status",
"tags": [
"products"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Notes about status codes\n\nIt will respond 404, when you are using wrong product key or encode it uncorrectly.",
"operationId": "postProductsLangProdKeyFollow",
"parameters": [
{
"description": "Programming language",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": " Package product key. ",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "follow your favorite software package"
}
},
"summary": "follow your favorite software package",
"tags": [
"products"
]
}
},
"/products/{lang}/{prod_key}/references": {
"get": {
"description": "\nIt returns the references of a package.\n\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Notes about status codes\n\nThis resource will return the status code 404 if there is no product for\nthe given prod_key or the product has 0 references.",
"operationId": "getProductsLangProdKeyReferences",
"parameters": [
{
"description": "Language",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": "Product Key",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
},
{
"description": "Page for paging",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "references"
}
},
"summary": "references",
"tags": [
"products"
]
}
},
"/products/{lang}/{prod_key}/versions": {
"get": {
"description": "\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Notes about status codes\n\n * API returns 404, when the product with given product key doesnt exists.\n\n * Response 302 means that you didnt encode prod_key correctly.* (Replace all dots & slashes ) *",
"operationId": "getProductsLangProdKeyVersions",
"parameters": [
{
"description": "\"Name of programming language\"",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": "\"Encoded product key, replace all `/` and `.`",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "list versions of a package"
}
},
"summary": "list versions of a package",
"tags": [
"products"
]
}
},
"/products/{lang}/{prod_key}/{prod_version}/license": {
"post": {
"consumes": [
"application/json"
],
"description": "With this endpoint users can suggest a license for an artifact.",
"operationId": "postProductsLangProdKeyProdVersionLicense",
"parameters": [
{
"description": " programming language ",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": " product key ",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
},
{
"description": " product version ",
"in": "path",
"name": "prod_version",
"required": true,
"type": "string"
},
{
"description": " name of the license ",
"in": "formData",
"name": "license_name",
"required": true,
"type": "string"
},
{
"description": " source of the license. Where did you find it? ",
"in": "formData",
"name": "license_source",
"required": true,
"type": "string"
},
{
"description": " you wanna say anyting important to this license? ",
"in": "formData",
"name": "comments",
"required": false,
"type": "string"
}
],
"responses": {
"201": {
"description": "suggest a license for an artifact"
}
},
"summary": "suggest a license for an artifact",
"tags": [
"products"
]
}
},
"/products/{lang}/{prod_key}/{prod_version}/scm_changes": {
"post": {
"consumes": [
"application/json"
],
"description": "\nThis resource can parse a changelog.xml from the maven-changelog-plugin, assign\nit to a specific artifact and display the changelog infos on the product page.\n\nPlease replace all slashes `/` through colons `:` and all dots `.` through `~`!\n\nExample: The clojure package `yummy.json/json` has to be transformed to `yummy~json:json`.\n\n#### Notes about status codes\n\nIt will respond 404, when you are using wrong product key or encode it uncorrectly.",
"operationId": "postProductsLangProdKeyProdVersionScmChanges",
"parameters": [
{
"description": " programming language ",
"in": "path",
"name": "lang",
"required": true,
"type": "string"
},
{
"description": " product key ",
"in": "path",
"name": "prod_key",
"required": true,
"type": "string"
},
{
"description": " product version ",
"in": "path",
"name": "prod_version",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "upload scm changelogs to an artifact"
}
},
"summary": "upload scm changelogs to an artifact",
"tags": [
"products"
]
}
},
"/projects": {
"get": {
"description": "\nTo use this resource you need either an active session or you have to append\nyour API Key to the URL as parameter. For example: \"?api_key=666_your_api_key_666\"",
"operationId": "getProjects",
"parameters": [
{
"description": "The name of the organisation the project is assigned to.",
"in": "query",
"name": "orga_name",
"required": false,
"type": "string"
},
{
"description": "The name of the team in the organisation this project is assigned to.",
"in": "query",
"name": "team_name",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "list of projects"
}
},
"summary": "list of projects",
"tags": [
"projects"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "\nTo use this resource you need either an active session or you have to append\nyour API Key to the URL as parameter. For example: \"?api_key=666_your_api_key_666\"",
"operationId": "postProjects",
"parameters": [
{
"description": "Project file - [maven.pom, Gemfile ...]",
"in": "formData",