@x12i/memorix-service 3.10.0 → 3.11.1

package/openapi/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Memorix Service API",
-    "version": "3.7.8",
+    "version": "3.11.1",
     "description": "One versioned product API over accepted Memorix packages. Scope: orgId + agentIds[]. Headers x-memorix-org-id and x-memorix-agent-ids (comma-separated). MX-CALLER-01: every /api request requires x-memorix-caller (calling app id). Intelligence never auto-installs. Relationships /links is forbidden. IntegrationsRegistry (Stage −1) and RestrictedStore (FG-A3 dual-mode blob)."
   },
   "servers": [
@@ -2567,6 +2567,17 @@
               "type": "string"
             },
             "description": "Optional SafeSort JSON"
+          },
+          {
+            "name": "count",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "enum": [
+                "true"
+              ]
+            },
+            "description": "When true, and every filter is eq, in, or exists on a path this agent's live property index names, the response is { count } and does not return the population. Unindexed filters ignore this and return the list."
           }
         ],
         "responses": {
@@ -2619,6 +2630,10 @@
                     "pageInfo": {
                       "$ref": "#/components/schemas/PageInfo"
                     },
+                    "count": {
+                      "type": "integer",
+                      "description": "Present when count=true is served from a live property index. The population is not returned."
+                    },
                     "currentRevision": {
                       "type": "integer",
                       "nullable": true
@@ -14020,7 +14035,7 @@
                   "definition": {
                     "type": "object",
                     "additionalProperties": true,
-                    "description": "An analytics definition (same shape as a pack analytics[] item)"
+                    "description": "An analytics definition (same shape as a pack analytics[] item). A measure, group, or split may name abstractType, or objectType plus contentType and a stored property path."
                   },
                   "replace": {
                     "type": "boolean",
@@ -14377,6 +14392,384 @@
         }
       }
     },
+    "/api/analytics/indexes": {
+      "get": {
+        "operationId": "analyticsIndexesList",
+        "summary": "List property indexes for the caller's agent ids",
+        "description": "Another agent's indexes are not listed. An agent that has declared nothing gets an empty list.",
+        "tags": [
+          "Analytics"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/XMemorixCaller"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixOrgId"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixAgentIds"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Indexes for this agent set",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "items"
+                  ],
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/AnalyticsIndex"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Analytics unavailable (no Mongo, or MEMORIX_ANALYTICS=0)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "analyticsIndexesRegister",
+        "summary": "Declare the stored paths Memorix indexes for this agent",
+        "description": "Names an object type, content type, and stored paths. No abstract. The caller's agent ids are the scope. The same definition does not scan again. A different definition needs replace: true.",
+        "tags": [
+          "Analytics"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/XMemorixCaller"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixOrgId"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixAgentIds"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "definition"
+                ],
+                "properties": {
+                  "definition": {
+                    "type": "object",
+                    "required": [
+                      "id",
+                      "objectType",
+                      "contentType",
+                      "properties"
+                    ],
+                    "properties": {
+                      "id": {
+                        "type": "string",
+                        "description": "Stable name for this agent set. Ids starting with @ are reserved."
+                      },
+                      "objectType": {
+                        "type": "string"
+                      },
+                      "contentType": {
+                        "type": "string"
+                      },
+                      "properties": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "description": "Stored paths, such as data.responsePriority. They do not have to be declared fields."
+                      }
+                    }
+                  },
+                  "replace": {
+                    "type": "boolean",
+                    "description": "Required when this id already exists with a different definition. Rebuilds that index only."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "Accepted. Backfill scans that population once, then the index stays current from writes.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "id",
+                    "status",
+                    "index"
+                  ],
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    },
+                    "index": {
+                      "$ref": "#/components/schemas/AnalyticsIndex"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Definition invalid (error.details.issues). A body that includes abstractType is META-ANALYTICS.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Definition differs without replace, or the same id belongs to another agent set",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Analytics unavailable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/analytics/indexes/validate": {
+      "post": {
+        "operationId": "analyticsIndexesValidate",
+        "summary": "Validate a property index without registering it",
+        "tags": [
+          "Analytics"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/XMemorixCaller"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixOrgId"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixAgentIds"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "definition": {
+                    "type": "object",
+                    "additionalProperties": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Validation result",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "ok",
+                    "issues"
+                  ],
+                  "properties": {
+                    "ok": {
+                      "type": "boolean"
+                    },
+                    "issues": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Analytics unavailable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/analytics/indexes/{id}": {
+      "get": {
+        "operationId": "analyticsIndexGet",
+        "summary": "One property index for the caller's agent ids",
+        "tags": [
+          "Analytics"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/XMemorixCaller"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixOrgId"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixAgentIds"
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Index",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AnalyticsIndex"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not declared for this agent set",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Analytics unavailable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "analyticsIndexDelete",
+        "summary": "Drop this agent's property index",
+        "tags": [
+          "Analytics"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/XMemorixCaller"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixOrgId"
+          },
+          {
+            "$ref": "#/components/parameters/XMemorixAgentIds"
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Removed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "removed": {
+                      "type": "boolean"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not declared for this agent set",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Analytics unavailable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorEnvelope"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/analytics/source-census": {
       "get": {
         "operationId": "analyticsSourceCensus",
@@ -16874,6 +17267,85 @@
           }
         }
       },
+      "AnalyticsIndex": {
+        "type": "object",
+        "required": [
+          "id",
+          "objectType",
+          "contentType",
+          "properties",
+          "status",
+          "generation",
+          "hash",
+          "agentIds",
+          "backfill"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "objectType": {
+            "type": "string"
+          },
+          "contentType": {
+            "type": "string"
+          },
+          "properties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "backfilling",
+              "live",
+              "error"
+            ]
+          },
+          "generation": {
+            "type": "integer"
+          },
+          "hash": {
+            "type": "string"
+          },
+          "agentIds": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "backfill": {
+            "type": "object",
+            "additionalProperties": true
+          },
+          "registeredAt": {
+            "type": "string"
+          },
+          "registeredBy": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "updatedAt": {
+            "type": "string"
+          },
+          "liveAt": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "error": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        }
+      },
       "AnalyticsCounter": {
         "type": "object",
         "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x12i/memorix-service",
-  "version": "3.10.0",
+  "version": "3.11.1",
   "description": "Memorix production service composition root — one versioned API over accepted packages.",
   "type": "module",
   "main": "./dist/index.js",