-
Notifications
You must be signed in to change notification settings - Fork 1
/
forge_api_v3.json
2390 lines (2390 loc) · 85.9 KB
/
forge_api_v3.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
{
"openapi": "3.0.2",
"info": {
"title": "Puppet Forge v3 API",
"version": "29",
"description": "## Introduction\nThe Puppet Forge API (hereafter referred to as the Forge API) provides quick access to all the\ndata on the Puppet Forge via a RESTful interface. Using the Forge API, you can write scripts and\ntools that interact with the Puppet Forge website.\n\nThe Forge API's current version is `v3`. It is considered regression-stable, meaning that the returned\ndata is guaranteed to include the fields described in the schemas on this page; however, additional data\nmight be added in the future and clients must ignore any properties they do not recognize.\n\n## OpenAPI Specification\nThe Puppet Forge v3 API is described by an\n[OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md) formatted\nspecification file. The most up-to-date version of this specification file can be accessed at\n[https://forgeapi.puppet.com/v3/openapi.json](/v3/openapi.json).\n\n## Features\n* The API is accessed over HTTPS via either the `forgeapi.puppet.com` (IPv4 or IPv6). All data is returned in JSON\n format.\n* Blank fields are included as `null`.\n* Nested resources may use an abbreviated representation. A link to the full representation for the\n resource is always included.\n* All timestamps in JSON responses are returned in ISO 8601 format: `YYYY-MM-DD HH:MM:SS ±HHMM`.\n* The HTTP response headers include caching hints for conditional requests.\n\n## Concepts and Terminology\n* **Module**: Modules are self-contained bundles of code and data with a specific directory structure. Modules are identified by a combination of the author's username and the module's name, separated by a hyphen. For example: `puppetlabs-apache`\n* **Release**: A single, specific version of a module is called a Release. Releases are identified by a combination of the module identifier (see above) and the Release version, separated by a hyphen. For example: `puppetlabs-apache-4.0.0`\n\n## Errors\nThe Puppet Forge API follows [RFC 2616](https://tools.ietf.org/html/rfc2616) and\n[RFC 6585](https://tools.ietf.org/html/rfc6585).\n\nError responses are served with a `4xx` or `5xx` status code, and are sent as a JSON document with a content type\nof `application/json`. The error document contains the following top-level keys and values:\n\n * `message`: a string value that summarizes the problem\n * `errors`: a list (array) of strings containing additional details describing the underlying cause(s) of the\n failure\n\nAn example error response is shown below:\n\n```json\n{\n \"message\": \"400 Bad Request\",\n \"errors\": [\n \"Cannot parse request body as JSON\"\n ]\n}\n```\n\n## User-Agent Required\nAll API requests must include a valid `User-Agent` header. Requests with no `User-Agent` header will\nbe rejected. The `User-Agent` header helps identify your application or library, so we can communicate\nwith you if necessary. If your use of the API is informal or personal, we recommend using your username\nas the value for the `User-Agent` header.\n\nUser-Agent headers are a list of one or more product descriptions, generally taking this form:\n\n```\n<name-without-spaces>/<version> (comments)\n```\n\nFor example, the following are all useful User-Agent values:\n\n```\nMyApplication/0.0.0 Her/0.6.8 Faraday/0.8.8 Ruby/1.9.3-p194 (i386-linux)\nMy-Library-Name/1.2.4\nmyusername\n```\n\n## Hostname Configuration\nMost tools that interact with the Forge API allow specification of the hostname to use. You can configure\na few common tools to use a specified hostname as follows:\n\nFor **Puppet Enterprise** users, in [r10k](https://puppet.com/docs/pe/latest/r10k_customize_config.html#r10k_configuring_forge_settings)\nor [Code Manager](https://puppet.com/docs/pe/latest/code_mgr_customizing.html#config_forge_settings), specify\n`forge_settings` in Hiera:\n```\npe_r10k::forge_settings:\n baseurl: 'https://forgeapi.puppet.com'\n```\nor\n```\npuppet_enterprise::master::code_manager::forge_settings:\n baseurl: 'https://forgeapi.puppet.com'\n```\n<br />\n\nIf you are an **open source Puppet** user using r10k, you'll need to [edit your r10k.yaml\ndirectly](https://github.com/puppetlabs/r10k/blob/main/doc/dynamic-environments/configuration.mkd#forge):\n```\nforge:\n baseurl: 'https://forgeapi.puppet.com'\n```\nor set the appropriate class param for the [open source r10k module](https://forge.puppet.com/puppet/r10k#forge_settings):\n```\n$forge_settings = {\n 'baseurl' => 'https://forgeapi.puppet.com',\n}\n```\n<br />\n\nIn [**Bolt**](https://puppet.com/docs/bolt/latest/bolt_installing_modules.html#install-forge-modules-from-an-alternate-forge), set a `baseurl` for the Forge in `bolt-project.yaml`:\n```\nmodule-install:\n forge:\n baseurl: https://forgeapi.puppet.com\n```\n<br />\n\nUsing `puppet config`:\n```\n$ puppet config set module_repository https://forgeapi.puppet.com\n```\n"
},
"servers": [
{
"url": "https://forgeapi.puppet.com"
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization: Bearer <api_key>",
"description": "Some of the Forge API endpoints require authentication in the form of a user API key. API keys may be created and revoked from a user's profile on the [Forge website](https://forge.puppet.com), where other profile details are managed.\n\nTo perform actions that require API key authentication, the key must be present in an `Authorization` header with the request. The header should be formatted as:\n\n```\nAuthorization: Bearer <api_key>\n```\n\nIf a request is made to a protected endpoint without the required `Authorization` header a `401 Unauthorized` response will be returned. If an `Authorization` header is sent with the request, but the provided key is invalid or has insufficent permissions a `403 Forbidden` response will be returned.\n"
}
},
"parameters": {
"ifModifiedSince": {
"in": "header",
"name": "If-Modified-Since",
"schema": {
"type": "string",
"format": "rfc2616 httpdate",
"description": "Only processes the request if the resource or list of resources has changed since the given time,\notherwise returns a `304 Not Modified` response\n",
"example": "Mon, 19 Feb 2019 10:15:08 GMT"
}
},
"limitQuery": {
"in": "query",
"name": "limit",
"description": "The numbers of items to return per page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20
}
},
"offsetQuery": {
"in": "query",
"name": "offset",
"description": "The number of items to skip before starting to collect the result set",
"schema": {
"type": "integer",
"minimum": 0,
"default": 0
}
},
"withHTML": {
"in": "query",
"name": "with_html",
"description": "Render markdown files (README, REFERENCE, etc.) to HTML before returning results",
"schema": {
"type": "boolean"
}
},
"includeFields": {
"in": "query",
"name": "include_fields",
"description": "List of top level keys to include in response object, only applies to fields marked 'optional'",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "spaceDelimited",
"explode": false,
"example": [
"docs"
]
},
"excludeFields": {
"in": "query",
"name": "exclude_fields",
"description": "List of top level keys to exclude from response object",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "spaceDelimited",
"explode": false,
"example": [
"readme",
"changelog",
"license",
"reference"
]
}
},
"schemas": {
"Pagination": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"example": 20,
"description": "Maximum number of results per page"
},
"offset": {
"type": "integer",
"example": 0,
"description": "Current page's offset from the beginning of the result set"
},
"first": {
"type": "string",
"format": "URL path and query string",
"example": "/v3/<resource>?offset=0&limit=20",
"description": "Relative URL for the first page of the result set"
},
"previous": {
"type": "string",
"format": "URL path and query string",
"nullable": true,
"example": null,
"description": "Relative URL for the previous page of the result set, or `null` if this is the first page"
},
"current": {
"type": "string",
"format": "URL path and query string",
"example": "/v3/<resource>?offset=0&limit=20",
"description": "Relative URL for the current page of the result set"
},
"next": {
"type": "string",
"format": "URL path and query string",
"nullable": true,
"example": "/v3/<resource>?offset=20&limit=20",
"description": "Relative URL for the next page of the result set, or `null` if this is the last page"
},
"total": {
"type": "integer",
"example": 100,
"description": "Total number of all results"
}
}
},
"User": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this User resource",
"example": "/v3/users/puppetlabs"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"description": "Unique textual identifier for this User resource",
"example": "puppetlabs"
},
"gravatar_id": {
"type": "string",
"description": "Gravatar ID, learn more at [https://gravatar.com/]()",
"example": "fdd009b7c1ec96e088b389f773e87aec"
},
"username": {
"type": "string",
"description": "Username for this User resource",
"example": "puppetlabs"
},
"display_name": {
"type": "string",
"description": "Free form display name for this User resource",
"example": "Puppet"
},
"release_count": {
"type": "integer",
"description": "Total number of module releases (versions) published under this User",
"example": 1619
},
"module_count": {
"type": "integer",
"description": "Total number of unique modules published under this User",
"example": 178
},
"created_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this User resource was created",
"example": "2010-05-19 05:46:26 -0700"
},
"updated_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this User resource was last modified",
"example": "2018-09-18 11:46:25 -0700"
}
}
},
"UserAbbreviated": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this User resource",
"example": "/v3/users/puppetlabs"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"description": "Unique textual identifier for this User resource",
"example": "puppetlabs"
},
"username": {
"type": "string",
"description": "Username for this User resource",
"example": "puppetlabs"
},
"gravatar_id": {
"type": "string",
"description": "Gravatar ID, learn more at [https://gravatar.com/]()",
"example": "fdd009b7c1ec96e088b389f773e87aec"
}
}
},
"SearchFilter": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier for the search filter."
},
"filter": {
"type": "object",
"description": "The hash definining the search filter criteria."
},
"active": {
"type": "boolean",
"description": "Indicates whether the search filter is active.",
"default": false
},
"created_at": {
"type": "string",
"description": "The timestamp indicating when the search filter was created."
}
},
"example": {
"id": 1,
"filter": {
"keyword": "apache",
"features": {
"premium": true,
"with_pdk": null,
"with_tasks": null
},
"endorsements": {
"partner": true,
"approved": null,
"supported": null
},
"compatibility": {
"pe_requirement": "2023.1",
"operating_system": "Windows",
"puppet_requirement": "8.0",
"operating_system_release": "2019"
},
"with_minimum_score": "80",
"release_within": "1year"
},
"active": true,
"created_at": "2023-11-28 17:51:53 +0530"
}
},
"SearchFilterResponse": {
"type": "object",
"properties": {
"user_search_filters": {
"type": "array",
"description": "The array of user search filter.",
"items": {
"$ref": "#/components/schemas/SearchFilter"
}
}
},
"example": {
"user_search_filters": [
{ "id": 1,
"filter": {
"keyword": "apache",
"features": {
"premium": true,
"with_pdk": null,
"with_tasks": null
},
"endorsements": {
"partner": true,
"approved": null,
"supported": null
},
"compatibility": {
"pe_requirement": "2023.1",
"operating_system": "Windows",
"puppet_requirement": "8.0",
"operating_system_release": "2019"
},
"with_minimum_score": "80",
"release_within": "1year"
},
"active": true,
"created_at": "2023-11-28 17:51:53 +0530"
},
{ "id": 2,
"filter": {
"keyword": "sql",
"features": {
"premium": true,
"with_pdk": null,
"with_tasks": null
},
"endorsements": {
"partner": true,
"approved": null,
"supported": null
},
"compatibility": {
"pe_requirement": "2023.1",
"operating_system": "Windows",
"puppet_requirement": "8.0",
"operating_system_release": "2019"
},
"with_minimum_score": "80",
"release_within": "1year"
},
"active": true,
"created_at": "2023-11-28 17:51:53 +0530"
}
]
}
},
"Module": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Module resource",
"example": "/v3/modules/puppetlabs-apache"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-z][a-z0-9_]*$",
"description": "Unique textual identifier for this Module resource",
"example": "puppetlabs-apache"
},
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Base name of this module (without username/namespace)",
"example": "apache"
},
"downloads": {
"type": "integer",
"description": "Total download count for all released versions of this module",
"example": 6618694
},
"created_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this Module resource was created",
"example": "2010-05-19 05:46:26 -0700"
},
"updated_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this Module resource was last modified",
"example": "2010-05-19 05:46:26 -0700"
},
"deprecated_at": {
"type": "string",
"format": "iso8601",
"nullable": true,
"description": "Date and time this Module resource was marked as deprecated by the owner",
"example": null
},
"deprecated_for": {
"type": "string",
"nullable": true,
"description": "Reason provided by the owner for marking this module as deprecated",
"example": null
},
"superseded_by": {
"allOf": [
{
"$ref": "#/components/schemas/ModuleMinimal"
},
{
"nullable": true,
"description": "Module resource suggested by the owner as a potential replacement for a deprecated module"
}
],
"example": null
},
"supported": {
"type": "boolean",
"deprecated": true,
"description": "Whether or not this module is a [Supported module](https://forge.puppet.com/supported), see `endorsement` field instead",
"example": true
},
"endorsement": {
"type": "string",
"enum": [
"supported",
"approved",
"partner"
],
"nullable": true,
"description": "Indicates whether a module is endorsed through the Supported, Approved or Partner Supported programs, or `null` if not endorsed",
"example": "supported"
},
"module_group": {
"type": "string",
"enum": [
"base",
"pe_only"
],
"description": "Indicates whether or not a module is licensed for use by Puppet Enterprise customers only, indicated by a value of `pe_only`, for all other modules this value will be `base`",
"example": "base"
},
"premium": {
"type": "boolean",
"description": "Whether this module is premium (requires payment to download)",
"example": false
},
"owner": {
"allOf": [
{
"$ref": "#/components/schemas/UserAbbreviated"
},
{
"description": "Abbreviated representation of the User resource that owns/publishes this module"
}
]
},
"current_release": {
"allOf": [
{
"$ref": "#/components/schemas/Release"
},
{
"description": "Full representation of the Release resource for the most \"recent\" version of this module"
}
]
},
"releases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseAbbreviated"
},
"description": "Array of abbreviated representations of all published Releases of this module"
},
"feedback_score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Numeric score representing the average rating this module has received from Forge users",
"example": 84
},
"homepage_url": {
"type": "string",
"format": "uri",
"description": "Author-provided URL for this module's homepage",
"example": "https://github.com/puppetlabs/puppetlabs-apache"
},
"issues_url": {
"type": "string",
"format": "uri",
"description": "Author-provided URL for reporting issues about this module",
"example": "https://tickets.puppetlabs.com/browse/MODULES"
}
}
},
"ModuleAbbreviated": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Module resource",
"example": "/v3/modules/puppetlabs-apache"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-z][a-z0-9_]*$",
"description": "Unique textual identifier for this Module resource",
"example": "puppetlabs-apache"
},
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Base name of this module (without username/namespace)",
"example": "apache"
},
"deprecated_at": {
"type": "string",
"format": "iso8601",
"nullable": true,
"description": "Date and time this Module resource was marked as deprecated by the owner",
"example": null
},
"owner": {
"allOf": [
{
"$ref": "#/components/schemas/UserAbbreviated"
},
{
"description": "Abbreviated representation of the User resource that owns/publishes this module"
}
]
}
}
},
"ModuleMinimal": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Module resource",
"example": "/v3/modules/puppetlabs-apache"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-z][a-z0-9_]*$",
"description": "Unique textual identifier for this Module resource",
"example": "puppetlabs-apache"
}
}
},
"Release": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Release resource",
"example": "/v3/releases/puppetlabs-apache-4.0.0"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-z][a-z0-9_]*[-\\/][0-9]+\\.[0-9]+\\.[0-9]+(?:[\\-+].+)?$",
"description": "Unique textual identifier for this Release resource",
"example": "puppetlabs-apache-4.0.0"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/ModuleAbbreviated"
},
{
"description": "Abbreviated representation of the Module resource that this release is a version of"
}
]
},
"version": {
"type": "string",
"format": "semantic version",
"example": "4.0.0"
},
"metadata": {
"type": "object",
"description": "Verbatim contents of release's `metadata.json` file"
},
"tags": {
"type": "array",
"description": "List of tags applied to this module release (derived from `metadata.json`)",
"items": {
"type": "string"
}
},
"supported": {
"type": "boolean",
"deprecated": true,
"description": "Indicates whether or not this specific module release is supported, this value is no longer relevant,\nplease see the `endorsement` property of the parent module instead\n",
"example": true
},
"pdk": {
"type": "boolean",
"description": "Indicates whether or not this module release's metadata contains\n[Puppet Development Kit](https://puppet.com/docs/pdk/latest/pdk.html) related keys/values\n",
"example": true
},
"validation_score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Numeric value representing module release's \"Quality score\", see\n[module scoring](https://forge.puppet.com/about/scoring) to learn more\n",
"example": 100
},
"file_uri": {
"type": "string",
"format": "uri",
"description": "Relative or absolute URL to download this release's tarball",
"example": "/v3/files/puppetlabs-apache-4.0.0.tar.gz"
},
"file_size": {
"type": "integer",
"format": "bytes",
"description": "Size of this release's tarball in bytes",
"example": 317119
},
"file_md5": {
"type": "string",
"format": "md5",
"description": "MD5 checksum for this release's tarball, can be used to verify successful download",
"example": "e579a02bd16f9dec56018d407be7ab32"
},
"file_sha256": {
"type": "string",
"format": "sha256",
"description": "SHA-256 checksum for this release's tarball, can be used to verify successful download",
"example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
},
"downloads": {
"type": "integer",
"description": "Number of times this release has been downloaded through the Forge",
"example": 12782
},
"readme": {
"type": "string",
"description": "Contents of this release's README file, optionally converted to HTML format if possible (see `with_html` param)"
},
"changelog": {
"type": "string",
"description": "Contents of this release's CHANGELOG file, optionally converted to HTML format if possible (see `with_html` param)"
},
"license": {
"type": "string",
"description": "Contents of this release's LICENSE file, optionally converted to HTML format if possible (see `with_html` param)"
},
"reference": {
"type": "string",
"description": "Contents of this release's REFERENCE file, optionally converted to HTML format if possible (see `with_html` param)"
},
"docs": {
"type": "object",
"deprecated": true,
"description": "(OPTIONAL) Automatically generated documentation for custom Types included in this module release, see `reference`\nkey instead (This field is not included in response by default, see `include_fields` param for more info)\n"
},
"pe_compatibility": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "(OPTIONAL) List of compatible PE versions for the release. This is calculated from the Puppet version requirement if one is provided\nin the module metadata. If a PE version but no Puppet version is provided, the PE version requirement will be returned. (This field\nis not included in response by default, see `include_fields` param for more info)\n"
},
"tasks": {
"type": "array",
"description": "Metadata for any Bolt tasks included in this module release",
"items": {
"$ref": "#/components/schemas/ReleaseTask"
}
},
"plans": {
"type": "array",
"description": "Links to metadata for Bolt plans included in this module release",
"items": {
"$ref": "#/components/schemas/ReleasePlanAbbreviated"
}
},
"created_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this Release resource was created",
"example": "2019-01-10 05:18:00 -0800"
},
"updated_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this Release resource was last updated",
"example": "2019-01-10 05:20:17 -0800"
},
"deleted_at": {
"type": "string",
"format": "iso8601",
"nullable": true,
"description": "Date and time this Release resource was marked as deleted",
"example": null
},
"deleted_for": {
"type": "string",
"nullable": true,
"description": "Author-provided reason that this module release was marked as deleted",
"example": null
}
}
},
"ReleaseAbbreviated": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Release resource",
"example": "/v3/releases/puppetlabs-apache-4.0.0"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-z][a-z0-9_]*[-\\/][0-9]+\\.[0-9]+\\.[0-9]+(?:[\\-+].+)?$",
"description": "Unique textual identifier for this Release resource",
"example": "puppetlabs-apache-4.0.0"
},
"version": {
"type": "string",
"format": "semantic version",
"example": "4.0.0"
},
"supported": {
"type": "boolean",
"deprecated": true,
"description": "Indicates whether or not this specific module release is supported, this value is no longer relevant,\nplease see the `endorsement` property of the parent module instead\n",
"example": true
},
"created_at": {
"type": "string",
"format": "iso8601",
"description": "Date and time this Release resource was created",
"example": "2019-01-10 05:18:00 -0800"
},
"deleted_at": {
"type": "string",
"format": "iso8601",
"nullable": true,
"description": "Date and time this Release resource was marked as deleted",
"example": null
},
"file_uri": {
"type": "string",
"format": "uri",
"description": "Relative or absolute URL to download this release's tarball",
"example": "/v3/files/puppetlabs-apache-4.0.0.tar.gz"
},
"file_size": {
"type": "integer",
"format": "bytes",
"description": "Size of this release's tarball in bytes",
"example": 317119
}
}
},
"ReleaseMinimal": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Release resource",
"example": "/v3/releases/puppetlabs-apache-4.0.0"
},
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-z][a-z0-9_]*[-\\/][0-9]+\\.[0-9]+\\.[0-9]+(?:[\\-+].+)?$",
"description": "Unique textual identifier for this Release resource",
"example": "puppetlabs-apache-4.0.0"
},
"file_uri": {
"type": "string",
"format": "uri",
"description": "Relative or absolute URL to download this release's tarball",
"example": "/v3/files/puppetlabs-apache-4.0.0.tar.gz"
}
}
},
"ReleaseTask": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name for this task",
"example": "init"
},
"executable": {
"type": "string",
"description": "Executable for this task (deprecated, superseded by \"executables\")",
"deprecated": true,
"example": "init.sh"
},
"executables": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of executable name(s) for all implementations of this task",
"example": [
"init.sh",
"init.ps1"
]
},
"description": {
"type": "string",
"description": "Description for this task",
"example": "Allows you to perform apache service functions"
},
"metadata": {
"type": "object",
"description": "JSON metadata for this task, see [writing tasks](https://puppet.com/docs/bolt/latest/writing_tasks.html)\ndocumentation for more info\n"
}
}
},
"ReleasePlanAbbreviated": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path",
"description": "URL path to the full metadata for this plan",
"example": "/v3/releases/puppetlabs-lvm-1.4.0/plans/lvm::expand"
},
"name": {
"type": "string",
"description": "The name of the plan, including the module name",
"example": "lvm::expand"
},
"private": {
"type": "boolean",
"description": "Whether this plan is private"
}
}
},
"ReleasePlan": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "URL path and query string",
"description": "Relative URL for this Plan resource",
"example": "/v3/releases/puppetlabs-lvm-1.4.0/plans/lvm::expand"
},
"name": {
"type": "string",
"description": "The name of the plan, including the module name",
"example": "lvm::expand"
},
"filename": {
"type": "string",
"description": "Path to this Plan within the module's file structure",
"example": "plans/expand.pp"
},
"plan_metadata": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "the name of the plan, including the module name",
"example": "lvm::expand"
},
"file": {
"type": "string",
"description": "Path to this plan within the module's file structure",
"example": "plans/expand.pp"
},
"line": {
"type": "integer",
"description": "The line within the plan source file where the plan code starts",
"example": 15,
"minimum": 1
},
"private": {
"type": "boolean",
"description": "Whether this plan is private"
},
"source": {
"type": "string",
"description": "Full text of the plan source file",
"example": "plan lvm::expand (\n String..."
},
"defaults": {
"type": "object",
"description": "Default values for the plan's arguments: keys are argument names, and values are their defaults",
"example": {
"resize_fs": "true"
}
},
"docstring": {
"type": "object",
"description": "Raw doc objects for this plan generated by puppet-strings (YARD) docstring comments in the plan source",
"properties": {
"tags": {
"description": "Generated docstrings for any YARD tags (like @param, for example)",
"type": "array",
"items": {
"type": "object",
"description": "Generated docstring for a specific YARD tag (like @param, for example)",
"properties": {
"name": {
"type": "string",
"description": "The name specified by this YARD tag",
"example": "resize_fs"
},
"text": {
"type": "string",
"description": "The description text specified by this YARD tag",
"example": "Whether to resize the filesystem"
},
"types": {
"type": "array",
"description": "Valid types specified by this YARD tag",
"items": {
"type": "string",
"example": "Boolean"
}
},
"tag_name": {
"type": "string",
"description": "The name of the YARD tag itself",
"example": "param"
}
}
}
},
"text": {
"description": "Contains any free-form YARD comment text outside of tags",
"type": "string",
"example": "This plan expands storage on servers using LVM..."
}
}
}
}
},
"private": {
"type": "boolean",
"description": "Whether this plan is private"
}
}
},
"DeprecationRequest": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"deprecate"
],
"description": "Action to take on resource. 'deprecate' is currently the only valid option.",
"example": "deprecate"
},
"params": {
"type": "object",
"nullable": true,
"properties": {
"reason": {
"type": "string",
"nullable": true,
"description": "Reason for deprecation",
"example": "No longer maintained"
},
"replacement_slug": {
"type": "string",
"nullable": true,
"description": "Slug identifying a replacement Module. Accepts legacy (case-sensitive) module naming.",
"example": "puppet-nginx",
"pattern": "^[a-zA-Z0-9]+[-\\/][a-zA-Z][a-zA-Z0-9_]*$"
}
}
}
}
}
},
"responses": {
"NotModified": {
"description": "Not Modified",
"headers": {
"Last-Modified": {
"schema": {
"type": "string",
"format": "rfc2616 httpdate",
"description": "Date and time that this response last changed",
"example": "Mon, 19 Feb 2019 10:15:08 GMT"
}
}
}
},
"BadRequest": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "400 Bad Request"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"'puppetlabs-apache4.5.0' is not a valid release slug"
]