1---
2id: generate-package
3title: "Generate Package"
4description: "This endpoint generates a zip package from a specified GitHub source."
5sidebar_label: "Generate Package"
6hide_title: true
7hide_table_of_contents: true
8api: eJytVt1v2zYQ/1eIe1oB2XLSdtiEYUBWDFmBYTPa7CkIbJo6S2wokiVPTlRB//twlPzVuA/F5ieBPB7v93FH90CyilDcwy1aDNLAQwYlRhW0J+0sFHBX6yjQlt5pS6JKYYRRSPFFe+GlepQVim1wjZAielR6q7EUt5r+aDciujYonEMGzvNB7ez7EgrY51lNCSCDgJ9bjPSbKzso+q+qWMogGyQMUXCcDlgKcodyhBTHRMpZQkucRHpvtErX5p8iZ+ohqhobyV/UeYQC3OYTKpoq4MzMBwOCDDzfG5kVHxgBaYx8NG0fU0QK2lbwkjs8J0J4SbXQVlCNYutCI0msK011uyl6F6oh7wN6N+R9rOWQ9xy+IreKXiv0rpx3sjHDGoZDZRdgnNdwIx6xm+2kaVE00gu3FS7tSSP8kdUfcF7Ns30xK3KPaNevIANZlnoMX54xcI58OBDU/SWbixHDkAFpMrx2O+m2HEX7MErPWfBZNp5j9hzDRE/TuVDlTcf85HKjrq5fv3mbnxEDp6ycAuEstV9Nue94KR3nooZT3Sm0mBaidzaOMK4Xi0t+HH2/N2ApYqsUxrhtjem+bcIv2l/0oAxB8jFNeCaqtoQVBshgdMu49PoaMmi01U3bQLEYTnmDXzbaytCl9txqg2KP5tdRgzeX8Ly3O2l0KaYmPHHGdzTUuXwYggsnqdes51psNZoymyZFJ6QYhdo3iLRcBIVudKT47uZ4NYn69jJMwsDOjxh2GMRY439FeGNFa/HZo2IjpFXhlGoDe2oYy2mQaseTz7tIyahUQwH57iqfJlfM92aCDMb6eDL30AYDBdREvshz45Q0tYtU/LT4efGi2//kbVHiDo3zDVqakM7FO2e3umoDiidNtVjPZpxxPYfhga9TbdDUpfuk16tH5O8H3mMSPhxn8+8vGvQw/A7Nx4C13bpk5KnlQ2tJN3hxRiYFS3EMMVqhjekSKxs+fuOlqnF2PWfMukRL/M6E850hA2ZtTHw1/3G+mLU2ktwYTBPKRWqkPcm6n0NieXg9zqrrj8743x7CqbMJnyn3RmrLpSWN+8kV97C7SnSOvoDs8FzyQ8Tic0zfb2TEf4IZBl7+3GJImmWwk0EnzKxgBjXKkpm67yHJCu9GTLM7roTDTZtm0NfOH7L9iRul0NM3YnmmsVEOFl/+/fEOMthML3njymQA+cRvrHyCAtL/AT6cZl1a68FIW7UsQgHj9fz7F29HBlI=
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Generate Package"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/packages/generate"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40This endpoint generates a zip package from a specified GitHub source.
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={undefined}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={{"description":"Parameters required to generate a package","content":{"application/json":{"schema":{"type":"object","required":["from","params"],"properties":{"from":{"type":"string","description":"The GitHub source path in the format `github:{org}/{repo}/{sha}/{path_to_spicepod.yaml}`"},"params":{"type":"object","description":"A key-value map of optional parameters (e.g., `github_token`)","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}}},"title":"GeneratePackageRequest"},"example":{"from":"github:myorg/myrepo/abc12345/spicepod.yaml","params":{"github_token":"ghp_exampleToken12345"}}}},"required":true}}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"Package generated successfully","content":{"application/zip":{"schema":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}},"example":"<binary zip file response>"}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{},"example":{"error":"Invalid `from` field, specify a github source and retry (e.g. github:{org}/{repo}/{sha}/{path_to_spicepod.yaml})"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred"}}}}}}
67>
68
69</StatusCodes>
70
71
72
1---
2id: generate-package
3title: "Generate Package"
4description: "This endpoint generates a zip package from a specified GitHub source."
5sidebar_label: "Generate Package"
6hide_title: true
7hide_table_of_contents: true
8api: eJytVt1v2zYQ/1eIe1oB2XLSdtiEYUBWDFmBYTPa7CkIbJo6S2wokiVPTlRB//twlPzVuA/F5ieBPB7v93FH90CyilDcwy1aDNLAQwYlRhW0J+0sFHBX6yjQlt5pS6JKYYRRSPFFe+GlepQVim1wjZAielR6q7EUt5r+aDciujYonEMGzvNB7ez7EgrY51lNCSCDgJ9bjPSbKzso+q+qWMogGyQMUXCcDlgKcodyhBTHRMpZQkucRHpvtErX5p8iZ+ohqhobyV/UeYQC3OYTKpoq4MzMBwOCDDzfG5kVHxgBaYx8NG0fU0QK2lbwkjs8J0J4SbXQVlCNYutCI0msK011uyl6F6oh7wN6N+R9rOWQ9xy+IreKXiv0rpx3sjHDGoZDZRdgnNdwIx6xm+2kaVE00gu3FS7tSSP8kdUfcF7Ns30xK3KPaNevIANZlnoMX54xcI58OBDU/SWbixHDkAFpMrx2O+m2HEX7MErPWfBZNp5j9hzDRE/TuVDlTcf85HKjrq5fv3mbnxEDp6ycAuEstV9Nue94KR3nooZT3Sm0mBaidzaOMK4Xi0t+HH2/N2ApYqsUxrhtjem+bcIv2l/0oAxB8jFNeCaqtoQVBshgdMu49PoaMmi01U3bQLEYTnmDXzbaytCl9txqg2KP5tdRgzeX8Ly3O2l0KaYmPHHGdzTUuXwYggsnqdes51psNZoymyZFJ6QYhdo3iLRcBIVudKT47uZ4NYn69jJMwsDOjxh2GMRY439FeGNFa/HZo2IjpFXhlGoDe2oYy2mQaseTz7tIyahUQwH57iqfJlfM92aCDMb6eDL30AYDBdREvshz45Q0tYtU/LT4efGi2//kbVHiDo3zDVqakM7FO2e3umoDiidNtVjPZpxxPYfhga9TbdDUpfuk16tH5O8H3mMSPhxn8+8vGvQw/A7Nx4C13bpk5KnlQ2tJN3hxRiYFS3EMMVqhjekSKxs+fuOlqnF2PWfMukRL/M6E850hA2ZtTHw1/3G+mLU2ktwYTBPKRWqkPcm6n0NieXg9zqrrj8743x7CqbMJnyn3RmrLpSWN+8kV97C7SnSOvoDs8FzyQ8Tic0zfb2TEf4IZBl7+3GJImmWwk0EnzKxgBjXKkpm67yHJCu9GTLM7roTDTZtm0NfOH7L9iRul0NM3YnmmsVEOFl/+/fEOMthML3njymQA+cRvrHyCAtL/AT6cZl1a68FIW7UsQgHj9fz7F29HBlI=
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Generate Package"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/packages/generate"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40This endpoint generates a zip package from a specified GitHub source.
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={undefined}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={{"description":"Parameters required to generate a package","content":{"application/json":{"schema":{"type":"object","required":["from","params"],"properties":{"from":{"type":"string","description":"The GitHub source path in the format `github:{org}/{repo}/{sha}/{path_to_spicepod.yaml}`"},"params":{"type":"object","description":"A key-value map of optional parameters (e.g., `github_token`)","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}}},"title":"GeneratePackageRequest"},"example":{"from":"github:myorg/myrepo/abc12345/spicepod.yaml","params":{"github_token":"ghp_exampleToken12345"}}}},"required":true}}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"Package generated successfully","content":{"application/zip":{"schema":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}},"example":"<binary zip file response>"}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{},"example":{"error":"Invalid `from` field, specify a github source and retry (e.g. github:{org}/{repo}/{sha}/{path_to_spicepod.yaml})"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred"}}}}}}
67>
68
69</StatusCodes>
70
71
72