@epilot/cli 0.1.9 → 0.1.11

package/definitions/entity.json

@@ -66,6 +66,102 @@
             "in": "query",
             "name": "unpublished",
             "description": "Return unpublished draft schemas",
+            "deprecated": true,
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "latest",
+            "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "exclude",
+            "description": "List of schema slugs to exclude from the results. Accepts a comma-separated list of slugs to exclude from the results.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "style": "form",
+            "explode": false
+          },
+          {
+            "in": "query",
+            "name": "include",
+            "description": "List of schema slugs to include in the results. When provided, only these schemas are returned. Accepts a comma-separated list of slugs.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "style": "form",
+            "explode": false
+          }
+        ],
+        "tags": [
+          "Schemas"
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/EntitySchemaItem"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v2/entity/schemas": {
+      "get": {
+        "operationId": "listSchemasV2",
+        "summary": "listSchemasV2",
+        "description": "Get the latest versions of all schemas.\nReturns summary schemas by default (only summary attributes, no capabilities).\nUse ?full=true for complete schemas.\n",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "full",
+            "description": "Return full schemas including all attributes and capabilities",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "unpublished",
+            "description": "Return unpublished draft schemas",
+            "deprecated": true,
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "latest",
+            "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
             "schema": {
               "type": "boolean",
               "default": false
@@ -83,6 +179,19 @@
             },
             "style": "form",
             "explode": false
+          },
+          {
+            "in": "query",
+            "name": "include",
+            "description": "List of schema slugs to include in the results. When provided, only these schemas are returned. Accepts a comma-separated list of slugs.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "style": "form",
+            "explode": false
           }
         ],
         "tags": [
@@ -114,7 +223,7 @@
       "get": {
         "operationId": "getSchema",
         "summary": "getSchema",
-        "description": "By default gets the latest version of the Schema and to get the specific version of schema pass the id.",
+        "description": "By default gets the current version of the Schema (frozen version if frozen, otherwise latest).\nPass ?latest=true to get the latest version when the schema is frozen.\nPass ?id= to get a specific version by ID.\n",
         "tags": [
           "Schemas"
         ],
@@ -128,6 +237,15 @@
             "schema": {
               "$ref": "#/components/schemas/SchemaId"
             }
+          },
+          {
+            "in": "query",
+            "name": "latest",
+            "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
           }
         ],
         "responses": {
@@ -149,7 +267,7 @@
       "put": {
         "operationId": "putSchema",
         "summary": "putSchema",
-        "description": "Create or update a schema with a new version",
+        "description": "Create or update a schema with a new version.\nWhen the schema is frozen, writes update the latest version without affecting the frozen version.\n",
         "tags": [
           "Schemas"
         ],
@@ -160,6 +278,7 @@
           {
             "in": "query",
             "name": "draft",
+            "deprecated": true,
             "schema": {
               "default": false,
               "type": "boolean"
@@ -657,6 +776,7 @@
                       }
                     },
                     "drafts": {
+                      "deprecated": true,
                       "type": "array",
                       "items": {
                         "$ref": "#/components/schemas/EntitySchemaItem"
@@ -667,8 +787,13 @@
                       "type": "boolean"
                     },
                     "drafts_more": {
+                      "deprecated": true,
                       "description": "Pagination: Whether more drafts are available",
                       "type": "boolean"
+                    },
+                    "frozen_version": {
+                      "description": "The version ID that is currently frozen, if any",
+                      "$ref": "#/components/schemas/SchemaId"
                     }
                   },
                   "required": [
@@ -682,6 +807,81 @@
         }
       }
     },
+    "/v1/entity/schemas/{slug}/freeze": {
+      "post": {
+        "operationId": "freezeSchema",
+        "summary": "freezeSchema",
+        "description": "Freeze a schema at its current version, or at a specific version.\nWhen frozen, getSchema returns the frozen version by default.\nNew edits via putSchema update the latest version without affecting the frozen version.\n",
+        "tags": [
+          "Schemas"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntitySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "version_id": {
+                    "description": "Freeze to a specific version ID. Defaults to the current version.",
+                    "$ref": "#/components/schemas/SchemaId"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Schema frozen successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntitySchemaItem"
+                }
+              }
+            }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          }
+        }
+      }
+    },
+    "/v1/entity/schemas/{slug}/unfreeze": {
+      "post": {
+        "operationId": "unfreezeSchema",
+        "summary": "unfreezeSchema",
+        "description": "Unfreeze a schema. Promotes the latest version to the current version for all users.\n",
+        "tags": [
+          "Schemas"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntitySlugPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Schema unfrozen successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntitySchemaItem"
+                }
+              }
+            }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          }
+        }
+      }
+    },
     "/v1/entity/schemas/{slug}/capabilities/available": {
       "get": {
         "operationId": "listAvailableCapabilities",
@@ -3074,7 +3274,7 @@
                       }
                     },
                     "deleted": {
-                      "type": "object",
+                      "type": "array",
                       "items": {
                         "$ref": "#/components/schemas/ClassificationId"
                       }
@@ -3468,7 +3668,7 @@
               "description": "ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).",
               "type": "string",
               "format": "date-time",
-              "example": "2023-01-01T00:00:00.000Z"
+              "example": "2023-01-01T00:00:00Z"
             }
           },
           {
@@ -4474,6 +4674,7 @@
             "example": false
           },
           "draft": {
+            "deprecated": true,
             "type": "boolean",
             "example": false
           },
@@ -4743,6 +4944,18 @@
                     "type": "string"
                   }
                 }
+              },
+              "frozen": {
+                "description": "Indicates this schema is currently frozen. Present when the returned version is the frozen version.",
+                "type": "boolean"
+              },
+              "latest": {
+                "description": "Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.",
+                "type": "boolean"
+              },
+              "_summary": {
+                "description": "Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)",
+                "type": "boolean"
               }
             }
           },
@@ -5004,6 +5217,9 @@
           {
             "$ref": "#/components/schemas/NumberAttribute"
           },
+          {
+            "$ref": "#/components/schemas/TableAttribute"
+          },
           {
             "$ref": "#/components/schemas/ConsentAttribute"
           },
@@ -6244,6 +6460,77 @@
           }
         ]
       },
+      "TableAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row.",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "table"
+                ]
+              },
+              "columns": {
+                "type": "array",
+                "description": "Column definitions for the table",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "description": "The column identifier (used as object key in row data)"
+                    },
+                    "label": {
+                      "type": "string",
+                      "description": "Display label for the column header"
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The data type for cells in this column",
+                      "enum": [
+                        "string",
+                        "number",
+                        "date",
+                        "boolean"
+                      ],
+                      "default": "string"
+                    },
+                    "width": {
+                      "type": "string",
+                      "description": "Optional column width (e.g., \"100px\", \"20%\")"
+                    },
+                    "required": {
+                      "type": "boolean",
+                      "description": "Whether this column is required for each row",
+                      "default": false
+                    }
+                  },
+                  "required": [
+                    "name",
+                    "label"
+                  ]
+                }
+              },
+              "min_rows": {
+                "type": "integer",
+                "description": "Minimum number of rows required",
+                "minimum": 0,
+                "default": 0
+              },
+              "max_rows": {
+                "type": "integer",
+                "description": "Maximum number of rows allowed",
+                "minimum": 1
+              }
+            }
+          }
+        ]
+      },
       "ConsentAttribute": {
         "allOf": [
           {
@@ -6746,6 +7033,24 @@
             "items": {
               "$ref": "#/components/schemas/SettingFlag"
             }
+          },
+          "schemas": {
+            "type": "array",
+            "description": "Schema-specific configuration for the capability",
+            "items": {
+              "type": "object",
+              "additionalProperties": true,
+              "required": [
+                "schema"
+              ],
+              "properties": {
+                "schema": {
+                  "type": "string",
+                  "description": "Entity schema slug",
+                  "example": "contact"
+                }
+              }
+            }
           }
         },
         "required": [
@@ -7070,10 +7375,13 @@
         }
       },
       "NullableEntity": {
-        "nullable": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/Entity"
+          },
+          {
+            "type": "object",
+            "nullable": true
           }
         ]
       },
@@ -8467,6 +8775,20 @@
                 ]
               }
             }
+          },
+          "_workflow_origin": {
+            "type": "object",
+            "description": "Internal property for workflow origin tracking and infinite loop prevention.\nPopulated when an entity update originates from a workflow execution.\nThis allows downstream automation services to prevent circular triggering.\n",
+            "properties": {
+              "workflow_exec_id": {
+                "type": "string",
+                "description": "The ID of the workflow execution that triggered this entity update"
+              },
+              "flow_template_id": {
+                "type": "string",
+                "description": "The flow template ID - used to detect and prevent circular triggering"
+              }
+            }
           }
         },
         "required": [
@@ -10066,9 +10388,5 @@
       }
     }
   },
-  "servers": [
-    {
-      "url": "https://entity.sls.epilot.io"
-    }
-  ]
+  "servers": [{"url": "https://entity.sls.epilot.io"}]
 }