@epilot/entity-client 4.21.0-rc.2 → 4.21.0

package/dist/openapi.json

@@ -32,7 +32,11 @@
     },
     {
       "name": "Taxonomy",
-      "description": "Entity classification with Taxonomies"
+      "description": "Taxonomies and Classifications"
+    },
+    {
+      "name": "Elastic Cluster Assignment",
+      "description": "Elastic Cluster assignment for organizations"
     }
   ],
   "security": [
@@ -218,6 +222,24 @@
             "schema": {
               "type": "number"
             }
+          },
+          {
+            "in": "query",
+            "name": "fields",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "example": [
+                "id",
+                "attributes",
+                "capabilites"
+              ]
+            }
           }
         ],
         "responses": {
@@ -443,6 +465,60 @@
         }
       }
     },
+    "/v1/entity/{slug}:validate": {
+      "post": {
+        "operationId": "validateEntity",
+        "summary": "validateEntity",
+        "description": "Validates an entity against the schema.",
+        "tags": [
+          "Entities"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntitySlugPathPriceParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Entity"
+              },
+              "examples": {
+                "Valid Price": {
+                  "$ref": "#/components/examples/PriceEntity"
+                },
+                "Invalid Price": {
+                  "$ref": "#/components/examples/EmptyGenericEntity"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationResultSuccess"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationResultError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/entity/{slug}:upsert": {
       "patch": {
         "operationId": "upsertEntity",
@@ -1746,12 +1822,24 @@
     },
     "/v1/entity/listTaxonomies": {
       "get": {
+        "deprecated": true,
         "operationId": "listTaxonomies",
         "summary": "listTaxonomies",
         "description": "List taxonomies in an organisation",
         "tags": [
           "Taxonomy"
         ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "include_disabled",
+            "description": "Include disabled taxonomies",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
         "responses": {
           "200": {
             "description": "Returns list of taxonomies in an organisation",
@@ -1774,6 +1862,115 @@
         }
       }
     },
+    "/v1/entity/taxonomies": {
+      "get": {
+        "operationId": "listTaxonomies",
+        "summary": "listTaxonomies",
+        "description": "List taxonomies in an organization",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "include_disabled",
+            "description": "Include disabled taxonomies",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
+        "tags": [
+          "Taxonomy"
+        ],
+        "responses": {
+          "200": {
+            "description": "Returns list of taxonomies in an organization",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/Taxonomy"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createTaxonomy",
+        "summary": "createTaxonomy",
+        "description": "Create a new taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "slug": {
+                    "$ref": "#/components/schemas/TaxonomySlug"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag",
+                    "example": "Purpose"
+                  },
+                  "plural": {
+                    "type": "string",
+                    "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.",
+                    "example": "Purposes"
+                  },
+                  "icon": {
+                    "type": "string",
+                    "description": "Icon name for the taxonomy (from epilot360/icons icon set)",
+                    "example": "purpose"
+                  },
+                  "color": {
+                    "type": "string",
+                    "description": "HEX Color code for the taxonomy",
+                    "example": "#FF5733"
+                  }
+                },
+                "required": [
+                  "slug",
+                  "name"
+                ],
+                "example": {
+                  "slug": "product-category",
+                  "name": "Product Category",
+                  "plural": "Product Categories",
+                  "icon": "product-hub",
+                  "color": "#FF5733"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Taxonomy created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Taxonomy"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Taxonomy already exists"
+          }
+        }
+      }
+    },
     "/v1/entity/taxonomies/{taxonomySlug}": {
       "get": {
         "operationId": "getTaxonomy",
@@ -1799,6 +1996,100 @@
             }
           }
         }
+      },
+      "put": {
+        "operationId": "updateTaxonomy",
+        "summary": "updateTaxonomy",
+        "description": "Update a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag",
+                    "example": "Purpose"
+                  },
+                  "plural": {
+                    "type": "string",
+                    "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.",
+                    "example": "Purposes"
+                  },
+                  "icon": {
+                    "type": "string",
+                    "description": "Icon name for the taxonomy (from epilot360/icons icon set)",
+                    "example": "purpose"
+                  },
+                  "color": {
+                    "type": "string",
+                    "description": "HEX Color code for the taxonomy",
+                    "example": "#FF5733"
+                  },
+                  "enabled": {
+                    "type": "boolean",
+                    "description": "Whether the taxonomy is enabled or not",
+                    "example": true
+                  }
+                },
+                "example": {
+                  "name": "Product Category",
+                  "plural": "Product Categories",
+                  "icon": "product-hub",
+                  "color": "#FF5733",
+                  "enabled": true
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Taxonomy updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Taxonomy"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteTaxonomy",
+        "summary": "deleteTaxonomy",
+        "description": "Delete a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          },
+          {
+            "in": "query",
+            "name": "permanent",
+            "description": "If true, the taxonomy will be permanently deleted",
+            "schema": {
+              "type": "boolean"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Taxonomy deleted"
+          }
+        }
       }
     },
     "/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
@@ -1856,7 +2147,7 @@
       "post": {
         "operationId": "taxonomiesClassificationsSearch",
         "summary": "taxonomiesClassificationsSearch",
-        "description": "List taxonomy classifications in an organisation based on taxonomy slug",
+        "description": "List taxonomy classifications in an organization based on taxonomy slug",
         "tags": [
           "Taxonomy"
         ],
@@ -1884,7 +2175,7 @@
         },
         "responses": {
           "200": {
-            "description": "Returns list of taxonomy classifications",
+            "description": "Returns the classifications for the taxonomy slug provided",
             "content": {
               "application/json": {
                 "schema": {
@@ -1908,7 +2199,7 @@
       "post": {
         "operationId": "updateClassificationsForTaxonomy",
         "summary": "updateClassificationsForTaxonomy",
-        "description": "Update taxonomies in an organisation based in taxonomy slug",
+        "description": "Update the classifications for a taxonomy",
         "tags": [
           "Taxonomy"
         ],
@@ -1959,6 +2250,148 @@
           }
         }
       }
+    },
+    "/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}": {
+      "get": {
+        "operationId": "getTaxonomyClassification",
+        "summary": "getTaxonomyClassification",
+        "description": "Gets the classification of a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          },
+          {
+            "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Taxonomy classification",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaxonomyClassification"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Taxonomy classification not found"
+          }
+        }
+      },
+      "post": {
+        "operationId": "createTaxonomyClassification",
+        "summary": "createTaxonomyClassification",
+        "description": "Create a new classification for a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TaxonomyClassification"
+              }
+            }
+          }
+        },
+        "response": {
+          "201": {
+            "description": "Taxonomy classification created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaxonomyClassification"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Taxonomy classification already exists\""
+          }
+        }
+      },
+      "put": {
+        "operationId": "updateTaxonomyClassification",
+        "summary": "updateTaxonomyClassification",
+        "description": "Update a classification for a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TaxonomyClassification"
+              }
+            }
+          }
+        },
+        "response": {
+          "200": {
+            "description": "Taxonomy classification updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaxonomyClassification"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Taxonomy classification not found"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteTaxonomyClassification",
+        "summary": "deleteTaxonomyClassification",
+        "description": "Delete a classification for a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          },
+          {
+            "in": "path",
+            "name": "classificationId",
+            "description": "The classification id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/ClassificationId"
+            }
+          },
+          {
+            "in": "query",
+            "name": "permanent",
+            "description": "If true, the classification will be permanently deleted",
+            "schema": {
+              "type": "boolean"
+            }
+          }
+        ],
+        "response": {
+          "204": {
+            "description": "Taxonomy classification deleted"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -2176,10 +2609,12 @@
                   "example": "FF_MY_FEATURE_FLAG",
                   "description": "This group should only be active when the feature flag is enabled"
                 },
-                "setting_flag": {
-                  "type": "string",
-                  "example": "MY_SETTING",
-                  "description": "This group should only be active when the setting is enabled"
+                "settings_flag": {
+                  "type": "array",
+                  "description": "This group should only be active when all the settings have the correct value",
+                  "items": {
+                    "$ref": "#/components/schemas/SettingFlag"
+                  }
                 },
                 "info_tooltip_title": {
                   "type": "object",
@@ -2509,10 +2944,12 @@
             "example": "FF_MY_FEATURE_FLAG",
             "description": "This attribute should only be active when the feature flag is enabled"
           },
-          "setting_flag": {
-            "type": "string",
-            "example": "MY_SETTING",
-            "description": "This attribute should only be active when the setting is enabled"
+          "settings_flag": {
+            "type": "array",
+            "description": "This attribute should only be active when all the settings have the correct value",
+            "items": {
+              "$ref": "#/components/schemas/SettingFlag"
+            }
           },
           "value_formatter": {
             "type": "string"
@@ -3098,9 +3535,12 @@
                       "type": "string",
                       "description": "Name of the feature flag that enables this action"
                     },
-                    "setting_flag": {
-                      "type": "string",
-                      "description": "Name of the setting flag that enables this action"
+                    "settings_flag": {
+                      "type": "array",
+                      "description": "This action should only be active when all the settings have the correct value",
+                      "items": {
+                        "$ref": "#/components/schemas/SettingFlag"
+                      }
                     },
                     "new_entity_item": {
                       "type": "object",
@@ -3561,9 +4001,12 @@
             "type": "string",
             "description": "Binds summary field visibility to the feature flag state."
           },
-          "setting_flag": {
-            "type": "string",
-            "description": "Binds summary field visibility to the setting flag state."
+          "settings_flag": {
+            "type": "array",
+            "description": "This summary attribute should only be visible when all the settings have the correct value",
+            "items": {
+              "$ref": "#/components/schemas/SettingFlag"
+            }
           }
         },
         "required": [
@@ -3686,14 +4129,12 @@
             "example": "FF_MY_FEATURE_FLAG",
             "description": "This capability should only be active when the feature flag is enabled"
           },
-          "setting_flag": {
-            "type": "string",
-            "example": "MY_SETTING",
-            "description": "This capability should only be active when the setting is enabled"
-          },
-          "legacy": {
-            "type": "boolean",
-            "description": "Only show capability for legacy tenants (ivy)"
+          "settings_flag": {
+            "type": "array",
+            "description": "This capability should only be active when all the settings have the correct value",
+            "items": {
+              "$ref": "#/components/schemas/SettingFlag"
+            }
           }
         },
         "required": [
@@ -3720,65 +4161,20 @@
               "default"
             ]
           },
-          "dropdown_items": {
+          "row_actions": {
             "type": "array",
             "items": {
-              "allOf": [
+              "oneOf": [
                 {
-                  "type": "object",
-                  "properties": {
-                    "feature_flag": {
-                      "type": "string",
-                      "example": "FF_MY_FEATURE_FLAG",
-                      "description": "This dropdown item should only be active when the feature flag is enabled"
-                    },
-                    "legacy": {
-                      "type": "boolean",
-                      "description": "Only show item for legacy tenants (ivy)"
-                    }
-                  }
+                  "type": "string"
                 },
                 {
-                  "oneOf": [
-                    {
-                      "type": "object",
-                      "properties": {
-                        "type": {
-                          "type": "string",
-                          "enum": [
-                            "entity"
-                          ]
-                        },
-                        "entity": {
-                          "$ref": "#/components/schemas/EntitySlug"
-                        }
-                      }
-                    },
-                    {
-                      "type": "object",
-                      "properties": {
-                        "type": {
-                          "type": "string",
-                          "enum": [
-                            "link"
-                          ]
-                        },
-                        "title": {
-                          "type": "string",
-                          "example": "Opportunities"
-                        },
-                        "uri": {
-                          "type": "string",
-                          "format": "uri-reference"
-                        }
-                      }
-                    }
-                  ]
+                  "$ref": "#/components/schemas/EntityAction"
                 }
               ]
             }
           },
-          "row_actions": {
+          "bulk_actions": {
             "type": "array",
             "items": {
               "oneOf": [
@@ -4123,14 +4519,93 @@
           }
         ]
       },
-      "HydratedEntityItem": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/BaseEntity"
+      "EntityValidationError": {
+        "type": "object",
+        "description": "Validation error for an entity attribute",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Error code identifier",
+            "example": "custom"
           },
-          {
-            "$ref": "#/components/schemas/HydratedEntity"
+          "params": {
+            "type": "object",
+            "description": "Additional parameters for the error",
+            "properties": {
+              "type": {
+                "type": "string",
+                "description": "The type of the error",
+                "example": "missing_field"
+              }
+            }
+          },
+          "path": {
+            "type": "array",
+            "description": "The path to the attribute that failed validation",
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "first_name"
+            ]
+          },
+          "message": {
+            "type": "string",
+            "description": "A human-readable message describing the error",
+            "example": "Invalid input"
           }
+        },
+        "required": [
+          "code",
+          "params",
+          "path",
+          "message"
+        ]
+      },
+      "EntityValidationResultSuccess": {
+        "type": "object",
+        "description": "Validation result for a successful validation",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "success"
+            ]
+          },
+          "errors": {
+            "type": "array",
+            "maxItems": 0,
+            "items": {
+              "$ref": "#/components/schemas/EntityValidationError"
+            }
+          }
+        },
+        "required": [
+          "status",
+          "errors"
+        ]
+      },
+      "EntityValidationResultError": {
+        "type": "object",
+        "description": "Validation result for a failed validation",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "error"
+            ]
+          },
+          "errors": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "$ref": "#/components/schemas/EntityValidationError"
+            }
+          }
+        },
+        "required": [
+          "status",
+          "errors"
         ]
       },
       "GetRelationsResp": {
@@ -4632,7 +5107,9 @@
           "name": {
             "description": "User-friendly identifier for the saved view",
             "type": "string",
-            "example": "View listing German"
+            "example": "View listing German",
+            "minLength": 1,
+            "maxLength": 100
           },
           "org": {
             "description": "Organisation ID a view belongs to",
@@ -4719,22 +5196,57 @@
           },
           "plural": {
             "type": "string",
-            "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags",
+            "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.",
             "example": "Purposes"
           },
+          "kind": {
+            "readonly": true,
+            "type": "string",
+            "enum": [
+              "system",
+              "user_defined"
+            ],
+            "description": "Kind of taxonomy e.g. system or user_defined. By default, it's empty, which means 'user_defined'",
+            "example": "system"
+          },
+          "icon": {
+            "type": "string",
+            "description": "Icon name for the taxonomy (from epilot360/icons icon set)",
+            "example": "purpose"
+          },
+          "color": {
+            "type": "string",
+            "description": "HEX Color code for the taxonomy",
+            "example": "#FF5733"
+          },
           "created_at": {
+            "readonly": true,
             "type": "string",
             "format": "date-time"
           },
           "updated_at": {
+            "readonly": true,
             "type": "string",
             "format": "date-time"
+          },
+          "deleted_at": {
+            "readonly": true,
+            "type": "string",
+            "format": "date-time",
+            "description": "Date when the taxonomy was soft-deleted (enabled: false)"
+          },
+          "created_by": {
+            "readonly": true,
+            "type": "string",
+            "description": "User ID of the creator",
+            "example": "10598"
+          },
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether the taxonomy is enabled or not",
+            "example": true
           }
-        },
-        "required": [
-          "slug",
-          "name"
-        ]
+        }
       },
       "TaxonomyClassification": {
         "type": "object",
@@ -4742,6 +5254,11 @@
           "id": {
             "$ref": "#/components/schemas/ClassificationId"
           },
+          "slug": {
+            "type": "string",
+            "description": "URL-friendly identifier for the classification",
+            "example": "wallbox-pv"
+          },
           "name": {
             "type": "string",
             "example": "Wallbox PV"
@@ -4796,6 +5313,19 @@
             }
           }
         }
+      },
+      "SettingFlag": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "The name of the organization setting to check"
+          },
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether the setting should be enabled or not"
+          }
+        }
       }
     },
     "parameters": {
@@ -4817,6 +5347,20 @@
           "$ref": "#/components/schemas/EntitySlug"
         }
       },
+      "EntitySlugPathPriceParam": {
+        "name": "slug",
+        "description": "Entity Type",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "allOf": [
+            {
+              "$ref": "#/components/schemas/EntitySlug"
+            }
+          ],
+          "example": "price"
+        }
+      },
       "TaxonomySlugQueryParam": {
         "name": "taxonomySlug",
         "description": "Taxonomy slug",
@@ -4835,6 +5379,15 @@
           "type": "string"
         }
       },
+      "TaxonomyClassificationSlugPathParam": {
+        "name": "taxonomyClassificationSlug",
+        "description": "Taxonomy Classification slug",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      },
       "SavedViewIdPathParam": {
         "name": "id",
         "description": "View id",
@@ -4893,7 +5446,7 @@
       },
       "IncludeReverseDeprecatedQueryParam": {
         "name": "include_reverse",
-        "description": "When true, includes reverse relations in response (other entities pointing to this entity)  \n*It gets overriden by mode query parameter.*\n",
+        "description": "When true, includes reverse relations in response (other entities pointing to this entity)\n*It gets overriden by mode query parameter.*\n",
         "in": "query",
         "deprecated": true,
         "schema": {
@@ -4942,7 +5495,7 @@
       },
       "EntityRelationsModeQueryParam": {
         "name": "mode",
-        "description": "Options to determine how relations will be included in the result.  \n*It overrides the include_reverse query param.*  \nExplanation of possible options:    \n- direct: include relations to which the searched entity refers  \n- reverse: include relations that refer to the entity you are looking for  \n- both: both direct and reverse relations\n",
+        "description": "Options to determine how relations will be included in the result.\n*It overrides the include_reverse query param.*\nExplanation of possible options:\n- direct: include relations to which the searched entity refers\n- reverse: include relations that refer to the entity you are looking for\n- both: both direct and reverse relations\n",
         "in": "query",
         "required": false,
         "schema": {
@@ -4966,6 +5519,10 @@
       }
     },
     "examples": {
+      "EmptyGenericEntity": {
+        "description": "Example of an empty, generic entity",
+        "value": {}
+      },
       "TaxEntity": {
         "description": "Example of a Tax Rate entity",
         "value": {
@@ -5188,6 +5745,7 @@
           "code": "MODEL_375KW_PREMIUM",
           "type": "One Time",
           "description": "Solar Panel 375 kWp Premium",
+          "internal_description": "Solar Panel 375 kWp Premium",
           "billing_scheme": "per_unit",
           "unit_amount": "€ 28500",
           "tiers_mode": "Standard"
@@ -5578,6 +6136,37 @@
             ]
           }
         }
+      },
+      "EntityValidationError": {
+        "description": "Example of an entity validation error",
+        "value": {
+          "code": "string",
+          "params": {
+            "type": "string"
+          },
+          "path": [
+            "string"
+          ],
+          "message": "string"
+        }
+      },
+      "EntityValidationResultSuccess": {
+        "description": "Example of a successful entity validation result",
+        "value": {
+          "status": "success",
+          "errors": []
+        }
+      },
+      "EntityValidationResultError": {
+        "description": "Example of a failed entity validation result",
+        "value": {
+          "status": "error",
+          "errors": [
+            {
+              "$ref": "#/components/examples/EntityValidationError"
+            }
+          ]
+        }
       }
     }
   },