@boxa-devops/depo-shared 1.0.5 → 1.1.0

package/error_codes.json

@@ -134,6 +134,7 @@
     "MEASURED_NOT_SYSTEM",
     "MISSING_FIELD",
     "NAIVE_TIMESTAMP",
+    "NOMENCLATURE_NOT_FOUND",
     "NOT_A_MEMBER",
     "NOT_FOUND",
     "NOT_FROM_TERMINAL",
@@ -178,6 +179,7 @@
     "SELF_TARGET",
     "SERIAL_NOT_ALLOWED",
     "SERIES_EXISTS",
+    "SERIES_NOT_FOUND",
     "SESSION_INVALID",
     "SESSION_MISSING",
     "SESSION_NOT_COUNTING",
@@ -480,6 +482,9 @@
       "routers/work_orders/read.py",
       "services/events.py"
     ],
+    "NOMENCLATURE_NOT_FOUND": [
+      "routers/admin_refs/series_positions.py"
+    ],
     "NOT_A_MEMBER": [
       "services/scrap_acts.py"
     ],
@@ -649,6 +654,9 @@
     "SERIES_EXISTS": [
       "routers/admin_refs/crud.py"
     ],
+    "SERIES_NOT_FOUND": [
+      "routers/admin_refs/series_positions.py"
+    ],
     "SESSION_INVALID": [
       "routers/admin_auth.py"
     ],

package/openapi.json

@@ -3682,6 +3682,259 @@
         }
       }
     },
+    "/api/v1/admin/refs/loco-series/{code}/positions": {
+      "get": {
+        "tags": [
+          "admin-refs"
+        ],
+        "summary": "List Series Positions",
+        "description": "Every type bound to this series, with the list it carries there.\n\nTypes with no binding are deliberately absent rather than listed with their\nglobal list: the visualization has to be able to tell «this series says so»\nfrom «the type says so», and a merged view cannot.",
+        "operationId": "list_series_positions_api_v1_admin_refs_loco_series__code__positions_get",
+        "parameters": [
+          {
+            "name": "code",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "title": "Code"
+            }
+          },
+          {
+            "name": "x-debug-person-id",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "X-Debug-Person-Id"
+            }
+          },
+          {
+            "name": "depo_admin_session",
+            "in": "cookie",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Depo Admin Session"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/LocoSeriesPositionOut"
+                  },
+                  "title": "Response List Series Positions Api V1 Admin Refs Loco Series  Code  Positions Get"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/v1/admin/refs/loco-series/{code}/positions/{nomenclature_id}": {
+      "put": {
+        "tags": [
+          "admin-refs"
+        ],
+        "summary": "Bind Series Positions",
+        "description": "Create or replace the binding. Idempotent by (series, type).",
+        "operationId": "bind_series_positions_api_v1_admin_refs_loco_series__code__positions__nomenclature_id__put",
+        "parameters": [
+          {
+            "name": "code",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "title": "Code"
+            }
+          },
+          {
+            "name": "nomenclature_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "Nomenclature Id"
+            }
+          },
+          {
+            "name": "x-debug-person-id",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "X-Debug-Person-Id"
+            }
+          },
+          {
+            "name": "depo_admin_session",
+            "in": "cookie",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Depo Admin Session"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/LocoSeriesPositionIn"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/LocoSeriesPositionOut"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "admin-refs"
+        ],
+        "summary": "Unbind Series Positions",
+        "description": "Drop the binding: the type falls back to its global positions list.\n\nAbsent binding is not an error — the operator's intent («this series has no\nlist of its own») already holds.",
+        "operationId": "unbind_series_positions_api_v1_admin_refs_loco_series__code__positions__nomenclature_id__delete",
+        "parameters": [
+          {
+            "name": "code",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "title": "Code"
+            }
+          },
+          {
+            "name": "nomenclature_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "Nomenclature Id"
+            }
+          },
+          {
+            "name": "x-debug-person-id",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "X-Debug-Person-Id"
+            }
+          },
+          {
+            "name": "depo_admin_session",
+            "in": "cookie",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Depo Admin Session"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Successful Response"
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/v1/admin/refs/{entity}": {
       "get": {
         "tags": [
@@ -13194,6 +13447,93 @@
         }
       }
     },
+    "/api/v1/refs/loco-series-positions": {
+      "get": {
+        "tags": [
+          "refs"
+        ],
+        "summary": "Loco Series Positions",
+        "description": "Per-series mount positions, for the terminal's chips.\n\nA small dictionary by design: only the types whose positions differ from\nthe global `nomenclature.positions` have a row. The client applies it as an\noverride — series row first, global list otherwise.",
+        "operationId": "loco_series_positions_api_v1_refs_loco_series_positions_get",
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Authorization"
+            }
+          },
+          {
+            "name": "x-debug-person-id",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "X-Debug-Person-Id"
+            }
+          },
+          {
+            "name": "depo_admin_session",
+            "in": "cookie",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Depo Admin Session"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/LocoSeriesPositionRef"
+                  },
+                  "title": "Response Loco Series Positions Api V1 Refs Loco Series Positions Get"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/v1/refs/nomenclature": {
       "get": {
         "tags": [
@@ -30288,6 +30628,91 @@
         "title": "LocoSeriesOut",
         "description": "Series dictionary + its picture key (terminal caches both offline)."
       },
+      "LocoSeriesPositionIn": {
+        "properties": {
+          "positions": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array",
+            "maxItems": 24,
+            "minItems": 1,
+            "title": "Positions"
+          }
+        },
+        "type": "object",
+        "required": [
+          "positions"
+        ],
+        "title": "LocoSeriesPositionIn",
+        "description": "Bind a part type to a series with that machine's own position list.\n\nNormalised by the same validator as nomenclature.positions, so a list means\nthe same thing wherever it was typed. An empty list is rejected: «no\nper-series list» is expressed by DELETEing the binding, which falls the\ntype back to its global list, not by saving emptiness that would read as\n«this series has no positions»."
+      },
+      "LocoSeriesPositionOut": {
+        "properties": {
+          "loco_series": {
+            "type": "string",
+            "title": "Loco Series"
+          },
+          "nomenclature_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "Nomenclature Id"
+          },
+          "code": {
+            "type": "string",
+            "title": "Code"
+          },
+          "name": {
+            "type": "string",
+            "title": "Name"
+          },
+          "positions": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array",
+            "title": "Positions"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loco_series",
+          "nomenclature_id",
+          "code",
+          "name",
+          "positions"
+        ],
+        "title": "LocoSeriesPositionOut",
+        "description": "One binding as the admin visualization draws it."
+      },
+      "LocoSeriesPositionRef": {
+        "properties": {
+          "loco_series": {
+            "type": "string",
+            "title": "Loco Series"
+          },
+          "nomenclature_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "Nomenclature Id"
+          },
+          "positions": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array",
+            "title": "Positions",
+            "default": []
+          }
+        },
+        "type": "object",
+        "required": [
+          "loco_series",
+          "nomenclature_id"
+        ],
+        "title": "LocoSeriesPositionRef",
+        "description": "One binding: what positions a part type has on ONE series.\n\nOverrides NomenclatureRef.positions for that series only. A type with no\nrow here keeps the global list, so this dictionary is usually short and a\ndepot that never needs per-series lists syncs an empty one."
+      },
       "LocoUnitCard": {
         "properties": {
           "series": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxa-devops/depo-shared",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Wire contract between depo-api, depo-terminal and depo-admin: generated API types, design tokens, shared guards.",
   "type": "module",
   "license": "UNLICENSED",