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: eJytVt+P2zYM/lcEPq2AE+euV2AzhgG3YrgVGLaguz0dDokiM7Z6sqRKdO5cw//7QNn51Usfii1PBkVR5Pd9JNMDySpC8QB3aDFIA48ZlBhV0J60s1DAfa2jQFt6py2JKrkRRiHFF+2Fl+pJVii2wTVCiuhR6a3GUtxp+r3diOjaoHAOGTjPF7WzH0ooYB9nNQWADAJ+bjHSr67soOi/ymIpg2yQMETBfjpgKcgd0hFSHAMpZwktcRDpvdEqPZt/ihyph6hqbCR/UecRCnCbT6hoyoAjMx5cEGTg+d3IqPjAFZDGyFfT8TFEpKBtBa+xw3MghJdUC20F1Si2LjSSxLrSVLebonehGvI+oHdD3sdaDnnP7ityq+i1Qu/KeScbM6xhOGR2oYzzHG7FE3aznTQtikZ64bbCpTNphD+i+gPOq3m2T2ZF7gnt+g1kIMtSj+7LMwTOKx8OAHV/yuaixzBkQJoM2+4m3pYjaR9H6jkKvsjGs88eY5jgaToXqrzpGJ9cbtTV9dubd/kZMHCKymkhHKX2qyn2PZvSdU5qOOWdQovJEL2zcSzjerG4pMdR93sBliK2SmGM29aY7tsi/KL9RQ3KECRf04RnpGpLWGGADEa1jKa315BBo61u2gaKxXCKG/y80VaGLrXnVhsU+2p+GTm4uVTPB7uTRpdiasITZXxHQ53ThyG4cBJ6zXyuxVajKbNpUnRCipGofYNIy0lQ6EZFiu9ujjcTqe8ul0kYWPkRww6DGHP8rxXeWtFafPGoWAjJKpxSbWBNDWM6DVLtePJ5FykJlWooIN9d5dPkivleTJDBmB9P5h7aYKCAmsgXeW6ckqZ2kYofFz8tXnX7H3wsStyhcb5BS1Olc/He2a2u2oDiWVMt1rMZR1zPYXjk51QbNHXpPen16gn5+5HPGISPx9n826sGPQy/Q/NxwdpuXRLy1PKhtaQbvDgjE4OlOLoYrdDG9IiVDV+/9VLVOLuec826REu8Z8L5yZABozYGvprfjCZGvJH2JNh+/IjlYWmcJdUfBfG/7b+poQlfKPdGasupJWr7SQwPsLtKKI5ygOywJXn/MOfs0/cbGfGfYIaBzZ9bDImqDHYyaLlhsB8ehwxqlCUD9NBDYhPejzXN7jkTdjdtGj1fC37I9jdulUJP3/DlUcb6OCh7+dff95DBZlrgjSsT7/KZV6t8hgLS3wC+nEZcsvVgpK1aJqGA8Xn+/Qtq6QLF
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: eJytVt+P2zYM/lcEPq2AE+euV2AzhgG3YrgVGLaguz0dDokiM7Z6sqRKdO5cw//7QNn51Usfii1PBkVR5Pd9JNMDySpC8QB3aDFIA48ZlBhV0J60s1DAfa2jQFt6py2JKrkRRiHFF+2Fl+pJVii2wTVCiuhR6a3GUtxp+r3diOjaoHAOGTjPF7WzH0ooYB9nNQWADAJ+bjHSr67soOi/ymIpg2yQMETBfjpgKcgd0hFSHAMpZwktcRDpvdEqPZt/ihyph6hqbCR/UecRCnCbT6hoyoAjMx5cEGTg+d3IqPjAFZDGyFfT8TFEpKBtBa+xw3MghJdUC20F1Si2LjSSxLrSVLebonehGvI+oHdD3sdaDnnP7ityq+i1Qu/KeScbM6xhOGR2oYzzHG7FE3aznTQtikZ64bbCpTNphD+i+gPOq3m2T2ZF7gnt+g1kIMtSj+7LMwTOKx8OAHV/yuaixzBkQJoM2+4m3pYjaR9H6jkKvsjGs88eY5jgaToXqrzpGJ9cbtTV9dubd/kZMHCKymkhHKX2qyn2PZvSdU5qOOWdQovJEL2zcSzjerG4pMdR93sBliK2SmGM29aY7tsi/KL9RQ3KECRf04RnpGpLWGGADEa1jKa315BBo61u2gaKxXCKG/y80VaGLrXnVhsU+2p+GTm4uVTPB7uTRpdiasITZXxHQ53ThyG4cBJ6zXyuxVajKbNpUnRCipGofYNIy0lQ6EZFiu9ujjcTqe8ul0kYWPkRww6DGHP8rxXeWtFafPGoWAjJKpxSbWBNDWM6DVLtePJ5FykJlWooIN9d5dPkivleTJDBmB9P5h7aYKCAmsgXeW6ckqZ2kYofFz8tXnX7H3wsStyhcb5BS1Olc/He2a2u2oDiWVMt1rMZR1zPYXjk51QbNHXpPen16gn5+5HPGISPx9n826sGPQy/Q/NxwdpuXRLy1PKhtaQbvDgjE4OlOLoYrdDG9IiVDV+/9VLVOLuec826REu8Z8L5yZABozYGvprfjCZGvJH2JNh+/IjlYWmcJdUfBfG/7b+poQlfKPdGasupJWr7SQwPsLtKKI5ygOywJXn/MOfs0/cbGfGfYIaBzZ9bDImqDHYyaLlhsB8ehwxqlCUD9NBDYhPejzXN7jkTdjdtGj1fC37I9jdulUJP3/DlUcb6OCh7+dff95DBZlrgjSsT7/KZV6t8hgLS3wC+nEZcsvVgpK1aJqGA8Xn+/Qtq6QLF
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