Skip to content

REST spec: Add Optional UUID for Namespaces to OpenAPI spec #15317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
talatuyarer wants to merge 2 commits into
base: main
Choose a base branch
from
Open

REST spec: Add Optional UUID for Namespaces to OpenAPI spec #15317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c02b515
feat: Add optional namespace-uuid to namespace responses.
talatuyarer Feb 12, 2026
1376c8b
Updated docs for namespace-uuid
talatuyarer Feb 12, 2026
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
10 changes: 10 additions & 0 deletions open-api/rest-catalog-open-api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,11 @@ class Config:

class CreateNamespaceResponse(BaseModel):
namespace: Namespace
namespace_uuid: str | None = Field(
Copy link
Contributor

@nastra nastra Feb 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to put this under the Namespace itself as an optional field, similar to how it's done for TableMetadata/ViewMetadata. We will then most likely need a separate NamespaceParser that reads/writes that optional uuid. Right now we only have a NamespaceSerializer and NamespaceDeserializer which serDe the levels of the namespace directly

None,
alias='namespace-uuid',
description='Optional UUID representing the unique identifier for the namespace. This is tied to the actual entity, not the name, which can be reused.',
)
properties: dict[str, str] | None = Field(
{},
description='Properties stored on the namespace, if supported by the server.',
Expand All @@ -740,6 +745,11 @@ class CreateNamespaceResponse(BaseModel):

class GetNamespaceResponse(BaseModel):
namespace: Namespace
namespace_uuid: str | None = Field(
None,
alias='namespace-uuid',
description='Optional UUID representing the unique identifier for the namespace. This is tied to the actual entity, not the name, which can be reused.',
)
properties: dict[str, str] | None = Field(
{},
description='Properties stored on the namespace, if supported by the server. If the server does not support namespace properties, it should return null for this field. If namespace properties are supported, but none are set, it should return an empty object.',
Expand Down
6 changes: 6 additions & 0 deletions open-api/rest-catalog-open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4102,6 +4102,9 @@ components:
properties:
namespace:
$ref: '#/components/schemas/Namespace'
namespace-uuid:
type: string
description: "Optional UUID representing the unique identifier for the namespace. This is tied to the actual entity, not the name, which can be reused."
properties:
type: object
additionalProperties:
Expand All @@ -4118,6 +4121,9 @@ components:
properties:
namespace:
$ref: '#/components/schemas/Namespace'
namespace-uuid:
type: string
description: "Optional UUID representing the unique identifier for the namespace. This is tied to the actual entity, not the name, which can be reused."
properties:
type: object
description:
Expand Down