Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"responses":{"200":{"description":"Namespaces retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["namespaces"],"properties":{"namespaces":{"type":"array","items":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}},"title":"NamespacesResponse"},"example":{"namespaces":[{"parts":["catalog_a"]},{"parts":["catalog_b","schema_1"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Invalid namespace request","type":"BadRequestException","code":400}}}}},"404":{"description":"Namespace not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Namespace provided does not exist","type":"NoSuchNamespaceException","code":404}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Internal Server Error: DF_SCHEMA_NOT_FOUND","type":"InternalServerError","code":500}}}}}}}
{"responses":{"200":{"description":"Namespaces retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["namespaces"],"properties":{"namespaces":{"type":"array","items":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}},"title":"NamespacesResponse"},"example":{"namespaces":[{"parts":["catalog_a"]},{"parts":["catalog_b","schema_1"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","NoSuchTableException","BadRequestException","ServiceUnavailableException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Invalid namespace request","type":"BadRequestException","code":400}}}}},"404":{"description":"Namespace not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","NoSuchTableException","BadRequestException","ServiceUnavailableException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Namespace provided does not exist","type":"NoSuchNamespaceException","code":404}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","NoSuchTableException","BadRequestException","ServiceUnavailableException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Internal Server Error: DF_SCHEMA_NOT_FOUND","type":"InternalServerError","code":500}}}}}}}
2 changes: 1 addition & 1 deletion website/docs/api/HTTP/get-iceberg-namespaces.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This endpoint retrieves namespaces available in the Iceberg catalo
sidebar_label: "List Iceberg namespaces"
hide_title: true
hide_table_of_contents: true
api: eJztV99v2zYQ/leIe1ZsJ0uBTW9Zm24GOhdo0ifPcGjqbF1HkSxJKQkM/e/D6Yclz0ZaoAOGFX2ycUfe3ffdR+q4hyh3AdIlzBVu0O9glUCGQXlykayBFO5zCgJN5iyZKDxGT1hhEEYWGJxUGISsJGm50SjIiJij6IIJJaPUdjf508y3QooHJz2a+DDsFRSE87aiDLNEUBSPpLXQFGITR+Wks3Gm0mToG1dwqGhLmIk26AQSsA695LLnGaSww7imtpD1EAIScNLLAiN6Br4H9kEKbRhIgBj15xL9M5xygV26EYStt4V4zEnlItoDQSe1c4EeP5fkMYN0K3XABILKsZCQ7iE+O67Cbj6hikdLl1xaDNwZ5xliJAy8pTUPe6X3kmumiMXYHqIns4O6rhOIFDXbFn1dUNcrzhacNaGNezWb8c8x9MXQhB5iJkKpFIawLbXmxMqayByme5DOaVJNM6afAkfYfyXYUatOEI98X4b9X1B5zhw+dORCnQA+ycKx/xjM8lDCErpDs5awqpMz9g30ullfwqpe1U3a63NN+1VmgtFjiP9We9B7608JbM1f2FtgCHKHkLSruKIMT2M11iEUmYg79JDA1vpCxtb00xUkUJChoiwgndXJIfppt7p8J44E0PDuJSzsXanyQ8tunxS2HCbM4YeWwrF1biJ6I/Ud+gr9bU9K3/zuAmzs95xzrIyx85yj10u34Eg0B54PaGFuKqlpdNWMWt7hPY+h5fl6Nqt7CV2/cO6FsVFsbWmyH1L6XqU0NLv/KIvM8rfeRoFPNJbUCzB7XV13unp17mrqUYvQwBZtNT+U9Z0q69DuthbRbEvFm7fru9e/3/5xs168v1+/ff9x8WaQ2Lnye3W96m6thtKY227ga6a7mEMK0+pyejT1tTprv7Wl15BCHqNLp1NtldS5DTH9efbL7GTme8dukWGF2rqCR7820kS8tmZLu9KjeKSYi4eLC474MAGeqAKq0lN8bvJJR+u/kP+v2Edma5tGd5T60kQq8Oy4GRwpzMSwRJNCHibSw+R646TK8eJqwsVThibyYOyPPXUCDL8NfDWZTWYXpQmRp3b2ORtiIc0o6jsewvtB/ojJoyL3w4n9Pz0VOolFfIpTpyUZJqGRxb5T0BKqS0j+MY6yTNi1329kwI9e1zWb29cCdzqjwOiGCf8Fsr7tLXEWQSOy4SlTSV3yokaRlfTUtJtVmECOMmORLPfdrhvFN8do18n9y1EOp+2323uo678BoET2hw==
api: eJztV99vGzcM/lcEPl9sJ0uB7d7SNt0MdC7QOE+e4cg62sdOJ6mSzklg3P9e8H74zrORFuiAYUCeEpAi9X3kdzS1hyi3AdIFTBWu0W9hmUCGQXlykayBFOY5BYEmc5ZMFB6jJ9xhEEYWGJxUGITcSdJyrVGQETFH0SYTSkap7Xb0l5luhBQPTno08aGPFRSE83ZHGWaJoCgeSWuhKcQ6j8pJZ8ObSpOhr13BoaINYSaapCNIwDr0kmFPM0hhi3FFDZBVnwIScNLLAiN6Jr4H9kEKTRpIgJj11xL9M5zWAtvrBhQ23hbiMSeVi2gPBTrBzgA9fi3JYwbpRuqACQSVYyEh3UN8dozCrr+gikdHFwwtBu6M80wxEgYOacx9rPReMmaKWAztIXoyW6iqKoFIUbNt1uGCqlrybcFZE5q8V5MJ/zmmPuub0FHMRCiVwhA2pdZ8sbImcg3TPUjnNKm6GeMvgTPsf5DsoFUnjAe+79P+L0p5zhw+t8WFKgF8koVj/zGZxQHCAtqPZiVhWSVn7GvodLO6hGW1rOprr8817a3MBLPHEP+t9qD31p8WsDF/J7bAEOQWIWlOMaIMT3PV1j4VmYhb9JDAxvpCxsb0yxUkUJChoiwgnVTJIftpt9r7ThwJoOHoBczsXanyQ8tunxQ2NUxa15zH29D8Vmafm8oOrXfod6Tw3hxG4tA7NRG9kZpPob/tKtkppp2atX3OQIdyGjrPOTqRtQeOlHZozqFEMDU7qWkwnwY6aYt0nmHTnOvJpOp0d/3CsBDGRrGxpcle9feqv4H+eoV0P/8is7xV2CjwiYY6fKE2nRivWzG+OTcEO9Yi1LRFg+ZVjq9yHI7DViMNFlGHpeL9h9Xduz9u/7xZzT7NVx8+3c/e97o8B7+T5Jt2PtZ9iLlt99F6+Yw5pDDeXY6PltJGnM0qUHoNKeQxunQ81lZJndsQ018nv01OVtKP7BYZ7lBbV/Bm2mQaiXfWbGhbehSPFHPxcHHBGR9GwAtfQFV6is/1fdLR6m/k/5fsI7OxtTrakvrSRCrw7DYcHCnMRH9Ek0LeddLDYn3jpMrx4mrE4ClDE3lv98eeKgGm3yS+Gk1Gk4vShMiSYZ+zIRbSDLJ+5DdC9844quQRyH3/mf+fXjKtxCI+xbHTkgwXoZbFvlXQAnaXkPxjW2aZsGu/X8uA915XFZubxwx3OqPA7PoHyAvF+rmnzlkGtcj6l9ZO6pIP1YrcSU91u1mFCeQoMxbJYt9G3SieHIOok6HNWQ5f2++3c6iqb00MMZc=
sidebar_class_name: "get api-method"
info_path: docs/api/HTTP/runtime
custom_edit_url: null
Expand Down
2 changes: 1 addition & 1 deletion website/docs/api/HTTP/get-namespace.StatusCodes.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"responses":{"200":{"description":"Namespace exists"},"400":{"description":"Invalid namespace format"},"404":{"description":"Namespace does not exist"}}}
{"responses":{"200":{"description":"Namespace exists","content":{"application/json":{"schema":{"type":"object","description":"The Iceberg REST `GetNamespaceResponse`.","required":["namespace"],"properties":{"namespace":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"},"properties":{"type":["object","null"],"description":"Always `null`: Spice does not store namespace properties, and the spec\nasks a server without them to return `null` rather than `{}`.","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}}},"title":"GetNamespaceResponse"},"example":{"namespace":["spice","public"],"properties":null}}}},"400":{"description":"Invalid namespace format"},"404":{"description":"Namespace does not exist"}}}
Comment thread
krinart marked this conversation as resolved.
Resolved
12 changes: 6 additions & 6 deletions website/docs/api/HTTP/get-namespace.api.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: get-namespace
title: "Check if a namespace exists."
description: "This endpoint returns a 200 OK response if the namespace exists, otherwise it returns a 404 Not Found response."
sidebar_label: "Check if a namespace exists."
title: "Load an Iceberg namespace"
description: "Returns the namespace if it exists. Spice does not store namespace properties, so `properties` is `null`."
sidebar_label: "Load an Iceberg namespace"
hide_title: true
hide_table_of_contents: true
api: eJzFUsFu2zAM/RWBZ8V2gxw23YZiK4IO3SU7FUGr2ExE1JY0iXZbGP73gUmXpOmw604SRPK9R703AttdBnMPyxo3mHaw1tBgrhNFpuDBwMpRVuibGMizSsh98llZNa8q9eNWJcwx+IyKtoodKm87zNHWqPCFMmetAjtMzyQt5/OLaqHuAqtvoffNEaYADSFissK+bMDADvnhCAoa/nRmMCPMq0qO94rvLiTApGHxt8alH2xLzZnmbUid5cPA4l/ITcCsfOADBUyThg7ZhTfFoCFadmCgHK7KI34ux+N9Ag0Z04BJ/n+EPrVgwDFHU5ZtqG3rQmbzqfpcwaUn36WsGhywDbFDz+qAVKjr4Le06xOqZ2KnHmczQXwsYFoLXd0n4tc9n4308IRyX0uN/DbIwkzcIhhIvWfq8AP1yqHKkWps1KmlpRp9RpmX/cDAl2hrh7N5IeKpQc+0JUzvK5MGWf8APC+qopr1PrPdtCi1GDJ31p+hXjusnyRp9kPOikulI9TBM3r+Lxnm1yiCGV+4jK0lLwvtLR7fknEPwxVoOGUDNJhT0NcaxH/pG8eNzfgztdMkz796THvbNAw20f63xMSzBN58XcE0/QbWuFKi
api: eJy9VEtv2zAM/isCz86jRQ+bb8NQFAWKYWi7UxY0jM3EamVJlei0geH/PlDxnEeDDbvsZFkUX9/3kS0wriPkM7gtaElhDfMMSopF0J61s5DDPXETbFRckbJYU/RYkNIrpVnRu44cx+rB64JU6Sgq61hFduHwsQ/OU2BNMVPRqcX+f6F0VAvbGLMYQwZyjZL3toQc1sRPQxDIIFD0zkaKkLdwOZ3K57jWb0PKXWWQQeEsk2V5i94bXaT4k+coDi3EoqIa5cRbT5CDWz5TwXCKwmNFqodI3V8/PKrFDfGQ7r6vLDUR6LXRgUpBdV/+PIN925JvbzqT/DCGx8Dxo//ueu+LIeAWMtBM9eF95KDtGrquy4A1GzrECbrTsDuv2b4UIeejKr6YN9z+pi7/FwGgLZOWoqfip8X4EhWqSGFDQb1prlzDYq8VOxWS9vosKiBXFBRXaNWi7RLYWJZaSkLz/UwbQ/NDl9vU+l/gOUetxKB3rL2hE/ZmEKV7yMA3S6OLU6qk+C7Fvzqn2Vu7QaPLA7RWLtTIkByu/iTyAe+kdpAUNXHl+uGRipAryGGyuZgM8eOkHc4dZLDDXpZAC00wkEPF7PPJxLgCTeUi55+mn6cfRuJOzKqkDRnna7LcszhWX51d6XUTKBGqFqORRFyMoZtLuqIJmrcpH3r99EJynotN25VL3PREhMayrunsNCbQS7V/YnRBQlTPjojUY1HR6HIsxeuSLOuVpnBs6TKQ9neBL8fT8XTU2Mi4NLvpcJFrtAdR7xyWCu2wDg5X1FGZ7X75/Nct2iub6Z0n3qC20kditu0FMYPNhYz2IAnIID/aVUK7vGvbJUb6EUzXyfVrQyGxlcEGg04gCXcZVISlQDtrIREKX4qCvGhwg6ZJC+p0/Qrjg15vrh+h634BBdRK4g==
Comment thread
krinart marked this conversation as resolved.
Resolved
sidebar_class_name: "get api-method"
info_path: docs/api/HTTP/runtime
custom_edit_url: null
Expand All @@ -24,7 +24,7 @@ import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Check if a namespace exists."}
children={"Load an Iceberg namespace"}
>
</Heading>

Expand All @@ -38,7 +38,7 @@ import Translate from "@docusaurus/Translate";



This endpoint returns a 200 OK response if the namespace exists, otherwise it returns a 404 Not Found response.
Returns the namespace if it exists. Spice does not store namespace properties, so `properties` is `null`.

<ParamsDetails>

Expand Down
2 changes: 1 addition & 1 deletion website/docs/api/HTTP/get-table.StatusCodes.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"responses":{"200":{"description":"Table exists","content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"object","required":["format-version","table-uuid","location","schemas","last-updated-ms","last-column-id","last-sequence-number","current-schema-id","partition-specs","default-spec-id","last-partition-id","sort-orders","default-sort-order-id"],"properties":{"current-schema-id":{"type":"integer","format":"int32","minimum":0},"default-sort-order-id":{"type":"integer","format":"int32","minimum":0},"default-spec-id":{"type":"integer","format":"int32","minimum":0},"format-version":{"type":"string","enum":["V2"],"title":"TableFormatVersion"},"last-column-id":{"type":"integer","format":"int32","minimum":0},"last-partition-id":{"type":"integer","format":"int32","minimum":0},"last-sequence-number":{"type":"integer","format":"int64","minimum":0},"last-updated-ms":{"type":"integer","format":"int64"},"location":{"type":"string"},"partition-specs":{"type":"object"},"schemas":{"type":"object","description":"Iceberg schemas, see `<https://apache.github.io/iceberg/spec/#schemas>`."},"sort-orders":{"type":"object"},"table-uuid":{"type":"string","example":"2b9da507-2c07-4bb3-9f0b-8df66a5e9e53"}},"title":"TableMetadata"}},"title":"LoadTableResponse"}}}},"404":{"description":"Table does not exist"},"500":{"description":"An internal server error occurred while getting the table","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Request failed. An internal server error occurred while getting the table.","r#type":"InternalServerError","code":500}}}}}}}
{"responses":{"200":{"description":"The Iceberg table Spice reads the table from","content":{"application/json":{"schema":{"type":"object","description":"The Iceberg REST `LoadTableResult`: the table's metadata and where it is\nstored. No `config` or `storage-credentials`: a client reads the table's\nfiles with its own credentials.","required":["metadata"],"properties":{"metadata":{"type":"object","description":"Iceberg table metadata, see `<https://iceberg.apache.org/spec/#table-metadata>`."},"metadata-location":{"type":["string","null"]}},"title":"LoadTableResponse"}}}},"400":{"description":"The table cannot be read as an Iceberg table","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","NoSuchTableException","BadRequestException","ServiceUnavailableException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Failed to load table 'spice.public.orders' as an Iceberg table: it is accelerated, so Spice answers queries from its acceleration rather than from an Iceberg table that Iceberg clients can read directly. Query it with SQL through Spice instead, over HTTP (`/v1/sql`) or Arrow Flight SQL. See: https://spiceai.org/docs/api/HTTP/get-table","type":"BadRequestException","code":400}}}}},"404":{"description":"Table does not exist","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","NoSuchTableException","BadRequestException","ServiceUnavailableException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Table 'spice.public.orders' does not exist","type":"NoSuchTableException","code":404}}}}},"503":{"description":"The table's Iceberg catalog could not be reached","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","NoSuchTableException","BadRequestException","ServiceUnavailableException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"}}}}}}
Loading
Loading