permdock 0.0.0 → 0.1.0

package/schemas/catalog-v1.json

@@ -0,0 +1,507 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://permdock.dev/schemas/catalog-v1.json",
+  "type": "object",
+  "required": [
+    "$schema",
+    "version",
+    "generatedAt",
+    "generator",
+    "resources",
+    "permissions"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "version": {
+      "const": 1
+    },
+    "generatedAt": {
+      "type": "string"
+    },
+    "generator": {
+      "type": "string"
+    },
+    "fingerprint": {
+      "type": "string"
+    },
+    "resources": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "required": ["id", "schema"],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "schema": {},
+          "definedIn": {
+            "type": "string"
+          },
+          "relations": {
+            "type": "object"
+          },
+          "version": {
+            "type": "string"
+          },
+          "restricted": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "roles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["key"],
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "on": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9_]*$"
+          },
+          "assignable": {
+            "type": "boolean"
+          },
+          "min": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "max": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "transferOnly": {
+            "const": true
+          },
+          "assigns": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "for": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "exclusiveWith": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "audience": {
+            "type": "string"
+          },
+          "activation": {
+            "type": "object",
+            "required": ["justification"],
+            "properties": {
+              "maxDuration": {
+                "type": "string"
+              },
+              "justification": {
+                "enum": ["required", "optional"]
+              },
+              "approval": {
+                "type": "boolean"
+              },
+              "assurance": {
+                "type": "object"
+              }
+            }
+          },
+          "supportAccess": {
+            "type": "object",
+            "required": ["actorRequired", "group", "durations"],
+            "properties": {
+              "actorRequired": {
+                "type": "boolean"
+              },
+              "group": {
+                "type": "string"
+              },
+              "durations": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "scopes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "key"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9_]*$"
+          },
+          "key": {
+            "type": "string"
+          },
+          "within": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "plans": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["key"],
+        "properties": {
+          "key": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "permissions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "key",
+          "scope",
+          "resource",
+          "action",
+          "arity",
+          "meta",
+          "usages",
+          "rowConditions"
+        ],
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "scope": {
+            "type": "string"
+          },
+          "resource": {
+            "type": "string"
+          },
+          "action": {
+            "type": "string"
+          },
+          "arity": {
+            "enum": ["instance", "collection"]
+          },
+          "meta": {
+            "type": "object"
+          },
+          "usages": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["file", "line", "call"],
+              "properties": {
+                "file": {
+                  "type": "string"
+                },
+                "line": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "call": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "renamedFrom": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "hostable": {
+            "const": true
+          },
+          "rowConditions": {
+            "type": "boolean"
+          },
+          "approvals": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "const": "human"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "by": {},
+                    "mode": {
+                      "enum": ["any", "all", "sequential"]
+                    },
+                    "stages": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": ["by"],
+                        "properties": {
+                          "by": {},
+                          "quorum": {
+                            "type": "integer",
+                            "minimum": 1
+                          }
+                        }
+                      }
+                    },
+                    "distinct": {
+                      "type": "boolean"
+                    },
+                    "staleOn": {
+                      "const": "resource-change"
+                    },
+                    "quorum": {
+                      "type": "integer",
+                      "minimum": 1
+                    },
+                    "ttl": {
+                      "type": "string"
+                    },
+                    "escalation": {
+                      "type": "object",
+                      "required": ["after", "to"],
+                      "properties": {
+                        "after": {
+                          "type": "string"
+                        },
+                        "to": {}
+                      }
+                    }
+                  }
+                }
+              ]
+            }
+          },
+          "breakGlass": {
+            "type": "object",
+            "required": ["overrides", "reason", "obligations"],
+            "properties": {
+              "overrides": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "purpose": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "reason": {
+                "type": "boolean"
+              },
+              "maxDuration": {
+                "type": "string"
+              },
+              "obligations": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "grants": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["permission", "effect", "role", "to", "scope"],
+        "properties": {
+          "permission": {
+            "type": "string"
+          },
+          "effect": {
+            "enum": ["allow", "deny"]
+          },
+          "role": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "const": null
+              }
+            ]
+          },
+          "to": {},
+          "scope": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "required": ["resource"],
+                "properties": {
+                  "resource": {
+                    "type": "string"
+                  }
+                }
+              }
+            ]
+          },
+          "where": {},
+          "check": {},
+          "approval": {
+            "oneOf": [
+              {
+                "const": "human"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "by": {},
+                  "mode": {
+                    "enum": ["any", "all", "sequential"]
+                  },
+                  "stages": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "required": ["by"],
+                      "properties": {
+                        "by": {},
+                        "quorum": {
+                          "type": "integer",
+                          "minimum": 1
+                        }
+                      }
+                    }
+                  },
+                  "distinct": {
+                    "type": "boolean"
+                  },
+                  "staleOn": {
+                    "const": "resource-change"
+                  },
+                  "quorum": {
+                    "type": "integer",
+                    "minimum": 1
+                  },
+                  "ttl": {
+                    "type": "string"
+                  },
+                  "escalation": {
+                    "type": "object",
+                    "required": ["after", "to"],
+                    "properties": {
+                      "after": {
+                        "type": "string"
+                      },
+                      "to": {}
+                    }
+                  }
+                }
+              }
+            ]
+          },
+          "fields": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "validity": {
+            "type": "object",
+            "properties": {
+              "from": {
+                "type": "integer"
+              },
+              "until": {
+                "type": "integer"
+              }
+            }
+          },
+          "name": {
+            "type": "string"
+          },
+          "purpose": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "limit": {
+            "type": "object",
+            "required": ["count", "per"],
+            "properties": {
+              "count": {
+                "type": "integer",
+                "minimum": 1
+              },
+              "per": {
+                "type": "string"
+              },
+              "mode": {
+                "enum": ["hard", "soft"]
+              }
+            }
+          },
+          "portable": {
+            "const": false
+          }
+        }
+      }
+    },
+    "delegations": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["from", "to", "permissions"],
+        "properties": {
+          "from": {},
+          "to": {
+            "type": "object",
+            "required": ["kind"],
+            "properties": {
+              "kind": {
+                "type": "string"
+              },
+              "id": {
+                "type": "string"
+              }
+            }
+          },
+          "permissions": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "validity": {
+            "type": "object",
+            "properties": {
+              "from": {
+                "type": "integer"
+              },
+              "until": {
+                "type": "integer"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}