OpenAPI: Add description for AssignUUID (#8753)

apache · Oct 11, 2023 · aa43e1f · aa43e1f
1 parent b3ebccc
commit aa43e1f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/open-api/rest-catalog-open-api.py b/open-api/rest-catalog-open-api.py
@@ -230,6 +230,10 @@ class BaseUpdate(BaseModel):
 
 
 class AssignUUIDUpdate(BaseUpdate):
+    """
+    Assigning a UUID to a table/view should only be done when creating the table/view. It is not safe to re-assign the UUID if a table/view already has a UUID assigned
+    """
+
     uuid: str
 
 

diff --git a/open-api/rest-catalog-open-api.yaml b/open-api/rest-catalog-open-api.yaml
@@ -1696,6 +1696,7 @@ components:
             - remove-properties
 
     AssignUUIDUpdate:
+      description: Assigning a UUID to a table/view should only be done when creating the table/view. It is not safe to re-assign the UUID if a table/view already has a UUID assigned
       allOf:
         - $ref: '#/components/schemas/BaseUpdate'
         - type: object