Update openapi.json for spiceai/spiceai#10272

website/docs/api/HTTP/generate-package.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body","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}}

website/docs/api/HTTP/generate-package.StatusCodes.json

@@ -0,0 +1 @@
+{"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"}}}}}}

website/docs/api/HTTP/generate-package.api.mdx

@@ -5,7 +5,7 @@ description: "This endpoint generates a zip package from a specified GitHub sour
 sidebar_label: "Generate Package"
 hide_title: true
 hide_table_of_contents: true
-api: eJytVt1v2zYQ/1eIe1oB2bLTFtiEokBWDFmBYQu67CkIbJo6S2wokiVPTlRB//twlPzVuA/F5ieBPB7v93FH90CyilDcww1aDNLAQwYlRhW0J+0sFHBX6yjQlt5pS6JKYYRRSPFVe+GlepQVim1wjZAielR6q7EUN5p+bzciujYonEMGzvNB7ezHEgrY51lNCSCDgF9ajPSrKzso+m+quJVBNkgYouA4HbAU5A7lCCmOiZSzhJY4ifTeaJWuzT9HztRDVDU2kr+o8wgFuM1nVDRVwJmZDwYEGXi+NzIrPjAC0hj5aNo+pogUtK3gJXd4ToTwkmqhraAaxdaFRpJYV5rqdlP0LlRD3gf0bsj7WMsh7zl8RW4VvVboXTnvZGOGNQyHyi7AOK/hWjxiN9tJ06JopBduK1zak0b4I6s/4byaZ/tiVuQe0a5fQQayLPUYfnvGwDny4UBQ96dsLkYMQwakyfDazaTb7Sjap1F6zoLPsvEcs+cYJnqazoUqbzrmJ5cbtbx6/eZtfkYMnLJyCoSz1H415b7jpXScixpOdafQYlqI3tk4wrhaLC75cfT93oCliK1SGOO2Nab7vgm/an/RgzIEycc04Zmo2hJWGCCD0S3j0usryKDRVjdtA8ViOOUN3m20laFL7bnVBsUezftRgzeX8Hy0O2l0KaYmPHHGDzTUuXwYggsnqdes51psNZoymyZFJ6QYhdo3iLRcBIVudKT44eZ4NYn69jJMwsDOjxh2GMRY439FeG1Fa/HZo2IjpFXhlGoDe2oYy2mQaseTz7tIyahUQwH5bplPkyvmezNBBmN9PJl7aIOBAmoiX+S5cUqa2kUqfl78snjR7X/wtihxh8b5Bi1NSOfig7NbXbUBxZOmWqxnM864nsPwwNepNmjq0n3S69Uj8vcD7zEJn46z+bcXDXoYfofmY8Dabl0y8tTyobWkG7w4I5OCpTiGGK3QxnSJlQ0fv/ZS1Ti7mjNmXaIlfmfC+c6QAbM2Jl7Ol8v5YtbaSHJjMI0oF6mR9iTtfhCJ28PzcVZef7TG//YSTq1N+Ey5N1JbLi2J3E+2uIfdMvE5GgOyw3vJLxGrzzF9v5ER/wlmGHj5S4shiZbBTgadMLOEGdQoS6bqvoekK3wYMc3uuBION20aQt9af8j2J66VQk/fieWhxk45ePz2r7/vIIPN9JQ3rkwOkE/8yMonKCD9IeDDadiltR6MtFXLIhQwXs+/fwEqAQZ+
+api: eJytVt1v2zYQ/1eIe1oB2XLcFtiEokBWDFmBYQu67CkIbJo6S2wokiVPTlRB//twlPzVuA/F5ieBPB7v93FH90CyilDcww1aDNLAQwYlRhW0J+0sFHBX6yjQlt5pS6JKYYRRSPFVe+GlepQVim1wjZAielR6q7EUN5p+bzciujYonEMGzvNB7ezHEgrY51lNCSCDgF9ajPSrKzso+m+quJVBNkgYouA4HbAU5A7lCCmOiZSzhJY4ifTeaJWuzT9HztRDVDU2kr+o8wgFuM1nVDRVwJmZDwYEGXi+NzIrPjAC0hj5aNo+pogUtK3gJXd4ToTwkmqhraAaxdaFRpJYV5rqdlP0LlRD3gf0bsj7WMsh7zl8RW4VvVboXTnvZGOGNQyHyi7AOK/hWjxiN9tJ06JopBduK1zak0b4I6s/4byaZ/tiVuQe0a5fQQayLPUYfnvGwDny4UBQ96dsLkYMQwakyfDazaTb7Sjap1F6zoLPsvEcs+cYJnqazoUqbzrmJ5cbdbV8/eZtfkYMnLJyCoSz1H415b7jpXScixpOdafQYlqI3tk4wlguFpf8OPp+b8BSxFYpjHHbGtN934Rftb/oQRmC5GOa8ExUbQkrDJDB6JZx6fUSMmi01U3bQLEYTnmDdxttZehSe261QbFH837U4M0lPB/tThpdiqkJT5zxAw11Lh+G4MJJ6jXruRZbjabMpknRCSlGofYNIi0XQaEbHSl+uDleTaK+vQyTMLDzI4YdBjHW+F8RXlvRWnz2qNgIaVU4pdrAnhrGchqk2vHk8y5SMirVUEC+u8qnyRXzvZkgg7E+nsw9tMFAATWRL/LcOCVN7SIVPy9+Wbzo9j94W5S4Q+N8g5YmpHPxwdmtrtqA4klTLdazGWdcz2F44OtUGzR16T7p9eoR+fuB95iET8fZ/NuLBj0Mv0PzMWBtty4ZeWr50FrSDV6ckUnBUhxDjFZoY7rEyoaPX3upapwt54xZl2iJ35lwvjNkwKyNiZfzxXwxa20kuTGYJpSL1Eh7knU/h8Tt4fU4q64/OuN/ewinziZ8ptwbqS2XljTuJ1fcw+4q0Tn6ArLDc8kPEYvPMX2/kRH/CWYYePlLiyFplsFOBp0ws4IZ1ChLZuq+hyQrfBgxze64Eg43bZpB3zp/yPYnrpVCT9+J5ZnGRjlY/Pavv+8gg830kjeuTAaQT/zGyicoIP0f4MNp1qW1Hoy0VcsiFDBez79/AWZ1Bk0=
 sidebar_class_name: "post api-method"
 info_path: docs/api/HTTP/runtime
 custom_edit_url: null
@@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes";
 import OperationTabs from "@theme/OperationTabs";
 import TabItem from "@theme/TabItem";
 import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
 
 <Heading
   as={"h1"}
@@ -43,8 +44,8 @@ This endpoint generates a zip package from a specified GitHub source.
   id={"request"}
   as={"h2"}
   className={"openapi-tabs__heading"}
-  children={"Request"}
 >
+  <Translate id="theme.openapi.request.title">Request</Translate>
 </Heading>
 
 <ParamsDetails
@@ -54,16 +55,13 @@ This endpoint generates a zip package from a specified GitHub source.
 </ParamsDetails>
 
 <RequestSchema
-  title={"Body"}
-  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}}
+  {...require("./generate-package.RequestSchema.json")}
 >
 
 </RequestSchema>
 
 <StatusCodes
-  id={undefined}
-  label={undefined}
-  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"}}}}}}
+  {...require("./generate-package.StatusCodes.json")}
 >
 
 </StatusCodes>

website/docs/api/HTTP/get-catalogs.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"from","in":"query","description":"Filters catalogs by source (e.g., 'spiceai').","required":false,"schema":{"type":["string","null"]}}]}

website/docs/api/HTTP/get-catalogs.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body"}

website/docs/api/HTTP/get-catalogs.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"200":{"description":"List of catalogs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Catalog information returned by the `/v1/catalogs` endpoint.","required":["from","name"],"properties":{"from":{"type":"string","description":"The source/provider of the catalog (e.g., `spiceai`, `unity`)"},"name":{"type":"string","description":"The name of the catalog"}},"title":"CatalogInfo"}},"example":[{"from":"spiceai","name":"spiceai"}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name\nspiceai,spiceai\n"}}},"500":{"description":"Internal server error occurred while processing catalogs","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred while processing the catalogs"}}}}}}

website/docs/api/HTTP/get-catalogs.api.mdx

@@ -1,11 +1,11 @@
 ---
 id: get-catalogs
 title: "List Catalogs"
-description: "List Catalogs"
+description: "Returns a list of all registered catalogs (data sources). Catalogs provide metadata about schemas and tables available from external data sources."
 sidebar_label: "List Catalogs"
 hide_title: true
 hide_table_of_contents: true
-api: eJydVNtu2zAM/RWBL90A1UkKDNj8VnQXFOjT0D2lQavITKxOllSJThsY/veBinNrAgzbkw2RPDw8vHRAapmgnMJXRSohJZhJ8AGjIuPdbQUlLJEetSJl/TKBhKCiapAwclgHTjUIJSyib0CCcVDCS4txDRIqTDqawEBQwndjOUhsocR8LZJvo0bxAYtlIcVFCkajMhcfC5AQ8aU1ESsoF8omlJB0jY2CsgNaB2TOiaJxS5DgWmth1vczDkvBu4SJHa/GY/4cE7kziYRfiIOatHeEjthXhWCNztWPnhMHdCeZwc+fUdMRyelWgizITEKILCOZDZNs3AMMzPvB/dTQSyBDlp9uNjx/DoXdEjYciG+qCeww3aLDoN+WxP6hnzEevtFIp9XZivaEdrjw4BhXMtaDG6Dk8H1w0DPJT+cUvnWE0SkrEsYVRoEx+ii81m2MWInX2lgUIXqNKRm3/J9OHBLtICeAEq6daB2+BdSE1V/TUo371H2f6zkzKjd7dg1S7YedyKtANZQwWk1GByVsit5sRxstlFAThXI0sl4rW/tE5efxl/HJgtyxWVS4QutDg44G+Qpx493CLNuI4tVQLZ4uLxnxqQAe+IS6jYbWOZ8K5vE38v+MbcYtfG7yMEqxdWQaPEl9X6PIja3E3sUajS5lfYdxug5K13h5VTB5U6EjszAYjy29BC5/AzwpJpNifNm6RGpukY3BJ2qUO4B9r/IRt92E5vENVhnHKFnYbujAFFYTnp0txEwCy8yGrpurhL+i7Xt+3pwmVqoyiRntz8u7rLtB/OfDdZZvbsr2RKyUbdkl92+losnacM8k1KgqlnTaDTHXWmOgg6iTvWCU3WT++HYPff8Hq48ByA==
+api: eJzNVUuP2zYQ/ivEXJIFtLazQIFWt8UiKRbIqUhPXiMeU2OLKUUy5EhZQ9B/L4amYzm7RR+nniSI5DffY4YagfGQoF7DAzJaf0iwqaChpKMJbLyDGn4j7qNLCpU1iZXfK7RWRTqYxBSpUbocVW8bZFTJ91FTulmoM6YK0Q+mIdURY96DO9+zSrqlDpNC1yjGnaWkcEBj5VXto+8UPTNFh1bNkRdQgQ8UUQg+NlDDgfjzmQVUEDBiR0xRlI3gsCOoQQChAiOavvYUj/Cj0g/GyqGLoN2x1FRvaXFYVOpNCkYTmjc3QiLS195EaqDeo01UwUkQ1CPwMZDYmjgad4AKXG8tbKZpI8dS8C5Rko13q5U8rol8LEbPNGnvmBzLXgzBGp3VL78kOTC+qAwYI4pCw9Sl2Xe/+0KaX0gvUSnj9j52GVvFHDw1YgO3pLbL4d3yTGmryDXBG8fXTqzPPmfXNxWEKFmxOcnNixc23+25ZvOppWL8srROFDuERKl/DmRbAtlWats7w8ftDUyl+D8qIzt/wIZpqoANW7oY8+j2Pn+nZ+yCrKzPYqBQOGu+fJg2AkTPvNRpeDWlQmyOC09OcCvBenIFqirPJweTsPjpta55dGVYEsWBoqIYfVRe6z7KmH5rjSUZRU0pGXf4L901JzpCLgA13DvVO3oOpJmavy07czqJGtHTEbe+THIeYG6hhnm/QQUnWaeZ7qOFGlrmUC+X1mu0rU9c/7z6ZfUi5o+yrBoayPrQkeNi0EI9eLc3hz6S+ma4VdvbW0HcLkDGNJHuo+FjrofBfP6D5H0jazImOcbSJbF3bDp6vZElukZdtlijyaXsYGmY+4C6pdu7hZA3DTk2e0PxemWqQOSfgO8Wq8Xqtncp35uyFnziDt0MNd8iDxf/rqiNl8z/nzd8mZA8PsGicSIyxz6W/ljD8E56d/bnkiaQhXHcYaLfo50m+Xy67iXHxiSpfbmy/9KUf/szeJVvbpnzjTig7WVL7q4Bo8nRSUdV0BI2Evh6LGfutabAs1Mv5lJQvs/Nr+8/wTT9CdNotfY=
 sidebar_class_name: "get api-method"
 info_path: docs/api/HTTP/runtime
 custom_edit_url: null
@@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes";
 import OperationTabs from "@theme/OperationTabs";
 import TabItem from "@theme/TabItem";
 import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
 
 <Heading
   as={"h1"}
@@ -37,33 +38,30 @@ import Heading from "@theme/Heading";
 
 
 
-List Catalogs
+Returns a list of all registered catalogs (data sources). Catalogs provide metadata about schemas and tables available from external data sources.
 
 <Heading
   id={"request"}
   as={"h2"}
   className={"openapi-tabs__heading"}
-  children={"Request"}
 >
+  <Translate id="theme.openapi.request.title">Request</Translate>
 </Heading>
 
 <ParamsDetails
-  parameters={[{"name":"from","in":"query","description":"Filters catalogs by source (e.g., 'spiceai').","required":false,"schema":{"type":["string","null"]}}]}
+  {...require("./get-catalogs.ParamsDetails.json")}
 >
 
 </ParamsDetails>
 
 <RequestSchema
-  title={"Body"}
-  body={undefined}
+  {...require("./get-catalogs.RequestSchema.json")}
 >
 
 </RequestSchema>
 
 <StatusCodes
-  id={undefined}
-  label={undefined}
-  responses={{"200":{"description":"List of catalogs","content":{"application/json":{"schema":{"type":"object","required":["from","name"],"properties":{"from":{"type":"string"},"name":{"type":"string"}},"title":"CatalogResponseItem"},"example":[{"from":"spiceai","name":"spiceai"}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name\nspiceai,spiceai\n"}}},"500":{"description":"Internal server error occurred while processing catalogs","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred while processing the catalogs"}}}}}}
+  {...require("./get-catalogs.StatusCodes.json")}
 >
 
 </StatusCodes>

website/docs/api/HTTP/get-config.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body"}

website/docs/api/HTTP/get-config.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"200":{"description":"API configuration retrieved successfully","content":{"application/json":{"schema":{},"example":{"overrides":{},"defaults":{},"endpoints":["GET /v1/iceberg/namespaces","HEAD /v1/iceberg/namespaces/{namespace}","GET /v1/iceberg/namespaces/{namespace}/tables","HEAD /v1/iceberg/namespaces/{namespace}/tables/{table}","GET /v1/iceberg/namespaces/{namespace}/tables/{table}"]}}}}}}

website/docs/api/HTTP/get-config.api.mdx

@@ -5,7 +5,7 @@ description: "This endpoint returns the Iceberg Catalog API configuration, inclu
 sidebar_label: "Get Iceberg API config"
 hide_title: true
 hide_table_of_contents: true
-api: eJzNVE1v2zAM/SsCz0qc9LT5VnRFV2CHHbJTELSKxMTaZEmTKK+B4f8+0HHdL3RAb/NFgkg9ku89uQdSxwz1Fm417jEdYSfBYNbJRrLBQw2bxmaB3sRgPYmEVJLPghoU0xVxpUi5cBSX32+FDv5gjyUpvi2F9doVY/1RGCRlXRZqHwqJ0GFK1mCWwuBBFUdZCuWNUJ2yTu0dziXzEiSEiGfIWwM1HJHuzoVAQsIcg8+Yoe7hYrXi5eUEb/riKZLFDo3IRWvM+VCcO4EEHTyhJ8ZQMTqrx/zqZ2agHrJusFVQ94MEfFBtdMjH8zTnyONEU97jHMzyzfVGVN26smfqKq9azFFpzCDh6/Xll3eiVT/vB5D/gHmeWBET+QHk6ULVj+uHC833dgN/ElqkJkyCgYSoqIEanuPNKmZMHSbmqIeSHNTQEMW6qlzQyjUhU/1p9XkFr935jcPCYIcuxBY9iTPSUlxNiqP4Y6kR94sFI94vYdhxOV2SpdNYT0V79wt5v+OY9YfAqpIllhdS8WRbfFN606DI0Wo04inFWY0+j65gfth9UekGFxdLbt4a9GQPFtPLyCCBxz8Dr5fr9XK1KD6PfHIwhkyt8s9gb5DmB/hk8NdN9k+O/j8eMp0id0/4QFV0ynqebhS8n/yxhW7NTE3/o/FN8mQ7CWwDTuj7vcr4I7lh4OPfBdOonoROJTtyxlpKaFAZpnrbwygwXGqNkb3YKVe4kTevnB0w+/bmegPD8BdITMss
+api: eJzNVE1v2zAM/SsCz0qc9rT5VnRFV2CHHbJTEbSKxMTcZEmTaK+F4f8+0PHcL2xAb/NFgkg9ku89eQA2xwL1LdxY3GM+wk6Dw2IzJaYYoIZtQ0VhcClSYJWRuxyK4gbVfEVdGjY+HtXF1xtlYzjQsctGbmtFwfrOUTgqh2zIF2X2sWMVe8yZHBatHB5M57loZYJTpjfkzd7jUrKsQUNMeIK8cVDDEfnuVAg0ZCwphoIF6gHONxtZXk7wpi+ZIhP26FTprMVSDp33j6DBxsAYWDBMSp7slF99LwI0QLENtgbqYdSAD6ZNHuV4meYU+TPRnPdnDmH5+mqrqv6sohN1VTAtlmQsFtDw+eri01+i1bDsR9D/gHmeWLEQ+Q7k+UI1TOu7Cy33dqN8GlrkJs6CgYZkuIEanuMtKhbMPWbhaIAue6ihYU51VflojW9i4frD5uMGXrvzi4SVwx59TC0GViektbqcFUf1i7hR96uVIN6vYdxJOdtl4sepnkl09wNlv5MYhUMUVZlY5IXcBaYW35TeNqhKIotOPaV4shjK5ArhR9yXjG1wdb6W5slhYDoQ5peRUYOMfwI+X2/Wm1UXykSnxFIs3JrwDPUaeXl/T/5+3ePwZOj/4x3zY5LuGR+4St5QkOkmvYfZHrfQnwlR8+9oepIy2U6DuEAShmFvCn7Lfhzl+GeHeRJPQ28yTZyJlBoaNE6Yvh1g0hcurMUkVuyN76SRN49cDLDY9vpqC+P4G7n+yvs=
 sidebar_class_name: "get api-method"
 info_path: docs/api/HTTP/runtime
 custom_edit_url: null
@@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes";
 import OperationTabs from "@theme/OperationTabs";
 import TabItem from "@theme/TabItem";
 import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
 
 <Heading
   as={"h1"}
@@ -46,16 +47,13 @@ This endpoint returns the Iceberg Catalog API configuration, including details a
 </ParamsDetails>
 
 <RequestSchema
-  title={"Body"}
-  body={undefined}
+  {...require("./get-config.RequestSchema.json")}
 >
 
 </RequestSchema>
 
 <StatusCodes
-  id={undefined}
-  label={undefined}
-  responses={{"200":{"description":"API configuration retrieved successfully","content":{"application/json":{"schema":{},"example":{"overrides":{},"defaults":{},"endpoints":["GET /v1/iceberg/namespaces","HEAD /v1/iceberg/namespaces/{namespace}","GET /v1/iceberg/namespaces/{namespace}/tables","HEAD /v1/iceberg/namespaces/{namespace}/tables/{table}","GET /v1/iceberg/namespaces/{namespace}/tables/{table}"]}}}}}}
+  {...require("./get-config.StatusCodes.json")}
 >
 
 </StatusCodes>

website/docs/api/HTTP/get-datasets.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"status","in":"query","description":"Whether to include the status field in the response. When `true`, the response includes\nthe current status of each dataset (e.g., `ready`, `initializing`, `refreshing`, `error`).\nDefaults to `false`.","required":false,"schema":{"type":"boolean"}},{"name":"format","in":"query","description":"The format of the response. Possible values are 'json' (default) or 'csv'.","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}},{"name":"source","in":"query","description":"Filters datasets by source (e.g., `postgres:aidemo_messages`).","required":false,"schema":{"type":["string","null"]}}]}

website/docs/api/HTTP/get-datasets.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body"}

website/docs/api/HTTP/get-datasets.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"200":{"description":"List of datasets. When `status=true` is specified, each dataset includes `status` and error metadata (`error`, `error_message`) when applicable.","content":{"application/json":{"schema":{"type":"object","description":"Dataset information returned by the `/v1/datasets` endpoint.","required":["from","name","replication_enabled","acceleration_enabled"],"properties":{"acceleration_enabled":{"type":"boolean","description":"Whether acceleration is enabled for the dataset"},"error":{"oneOf":[{"type":"null"},{"description":"An optional error type/code for the dataset status.\nOnly populated when `status=true` and the dataset status is `Error`.\nExample:\n`{ \"category\": \"dataset\", \"type\": \"auth\", \"code\": \"dataset.auth\" }`.","type":"object","required":["category","type","code"],"properties":{"category":{"description":"High-level component category where the error originated.","type":"string","enum":["dataset","model","worker","runtime"],"title":"ComponentErrorCategory"},"code":{"type":"string","description":"Stable machine-readable code (`{category}.{type}`), e.g. `dataset.auth`."},"type":{"description":"Canonical error type intended for programmatic handling.","type":"string","enum":["auth","connection","timeout","validation","not_found","permission","rate_limit","internal","unknown"],"title":"ComponentErrorType"}},"title":"ComponentError"}]},"error_message":{"type":["string","null"],"description":"An optional error message describing why the dataset entered an error state.\nOnly populated when `status=true`, the dataset status is `Error`, and an error message was recorded.\nThis value is intended for user-visible display."},"from":{"type":"string","description":"The source where the dataset is located (e.g., `postgres:syncs`)"},"name":{"type":"string","description":"The name of the dataset"},"properties":{"type":"object","description":"Custom properties for the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"replication_enabled":{"type":"boolean","description":"Whether replication is enabled for the dataset"},"status":{"oneOf":[{"type":"null"},{"description":"The current status of the dataset. Only included when `status=true` query parameter is specified.\nPossible values: `Initializing`, `Ready`, `Disabled`, `Error`, `Refreshing`, `ShuttingDown`.","oneOf":[{"type":"string","description":"The component is initializing and not yet ready","enum":["Initializing"]},{"type":"string","description":"The component is ready to accept connections","enum":["Ready"]},{"type":"string","description":"The component is disabled and not running","enum":["Disabled"]},{"type":"object","description":"An error occurred in the component, with an optional error message","required":["Error"],"properties":{"Error":{"type":["string","null"],"description":"An error occurred in the component, with an optional error message"}}},{"type":"string","description":"The component is in the process of refreshing its state","enum":["Refreshing"]},{"type":"string","description":"The component is in the process of shutting down","enum":["ShuttingDown"]}],"example":"Ready","title":"String"}]}},"title":"DatasetInfo"},"example":[{"from":"postgres:syncs","name":"daily_journal_accelerated","replication_enabled":false,"acceleration_enabled":true,"status":"Ready","error":null,"error_message":null},{"from":"databricks:hive_metastore.default.messages","name":"messages_accelerated","replication_enabled":false,"acceleration_enabled":true,"status":"Error","error":{"category":"dataset","type":"auth","code":"dataset.auth"},"error_message":"Unable to authenticate with datasource credentials"},{"from":"postgres:aidemo_messages","name":"general","replication_enabled":false,"acceleration_enabled":false,"status":"Initializing","error":null,"error_message":null}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name,replication_enabled,acceleration_enabled,status,error,error_message\npostgres:syncs,daily_journal_accelerated,false,true,Ready,,\ndatabricks:hive_metastore.default.messages,messages_accelerated,false,true,Error,dataset.auth,Unable to authenticate with datasource credentials\npostgres:aidemo_messages,general,false,false,Initializing,,\n"}}},"500":{"description":"Internal server error occurred while processing datasets","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing datasets"}}}}}