@tulipes/cli 0.1.1 → 0.2.0-rc.2

package/templates/app/docs/agent-manifest.json

@@ -0,0 +1,724 @@
+{
+  "app": {
+    "name": "tulipes-example"
+  },
+  "authorization": "acl",
+  "modules": [
+    {
+      "name": "auth",
+      "tools": [
+        "auth_register",
+        "auth_login",
+        "auth_refresh",
+        "auth_logout",
+        "auth_me",
+        "auth_sessions",
+        "auth_session-end",
+        "auth_password"
+      ]
+    },
+    {
+      "name": "users",
+      "tools": [
+        "users_read",
+        "users_delete",
+        "users_read-deleted",
+        "users_create",
+        "users_ping",
+        "users_demo-missing",
+        "users_demo-boom"
+      ]
+    },
+    {
+      "name": "hello",
+      "summary": "Greets callers and counts how often each greeting is used.",
+      "tools": [
+        "hello_greet",
+        "hello_greet-name",
+        "hello_list-greetings",
+        "hello_use-greeting",
+        "hello_reset-counts"
+      ]
+    },
+    {
+      "name": "config",
+      "tools": [
+        "config_read",
+        "config_describe",
+        "config_write"
+      ]
+    }
+  ],
+  "tools": [
+    {
+      "name": "auth_register",
+      "module": "auth",
+      "permission": "auth:register",
+      "title": "Register",
+      "description": "Create an account and its credential",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "body": {
+            "type": "object",
+            "properties": {
+              "email": {
+                "type": "string",
+                "format": "email",
+                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+              },
+              "password": {
+                "type": "string",
+                "minLength": 8
+              }
+            },
+            "required": [
+              "email",
+              "password"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "body"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/api/v1/auth/register"
+      }
+    },
+    {
+      "name": "auth_login",
+      "module": "auth",
+      "permission": "auth:login",
+      "title": "Log in",
+      "description": "Exchange email and password for a token pair",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "body": {
+            "type": "object",
+            "properties": {
+              "email": {
+                "type": "string",
+                "format": "email",
+                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+              },
+              "password": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "email",
+              "password"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "body"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/api/v1/auth/login"
+      }
+    },
+    {
+      "name": "auth_refresh",
+      "module": "auth",
+      "permission": "auth:refresh",
+      "title": "Refresh tokens",
+      "description": "Rotate a refresh token for a new pair",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "body": {
+            "type": "object",
+            "properties": {
+              "refresh_token": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "refresh_token"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "body"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/api/v1/auth/refresh"
+      }
+    },
+    {
+      "name": "auth_logout",
+      "module": "auth",
+      "permission": "auth:logout",
+      "title": "Log out",
+      "description": "Revoke this session immediately",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/api/v1/auth/logout"
+      }
+    },
+    {
+      "name": "auth_me",
+      "module": "auth",
+      "permission": "auth:me",
+      "title": "Who am I",
+      "description": "The caller and the session behind this request",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/auth/me"
+      }
+    },
+    {
+      "name": "auth_sessions",
+      "module": "auth",
+      "permission": "auth:sessions",
+      "title": "List sessions",
+      "description": "Every device this account is signed in on",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/auth/sessions"
+      }
+    },
+    {
+      "name": "auth_session-end",
+      "module": "auth",
+      "permission": "auth:session-end",
+      "title": "End a session",
+      "description": "Sign one other device out",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "params": {
+            "type": "object",
+            "properties": {
+              "sid": {
+                "type": "string",
+                "format": "uuid",
+                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+              }
+            },
+            "required": [
+              "sid"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "params"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "DELETE",
+        "path": "/api/v1/auth/sessions/:sid"
+      }
+    },
+    {
+      "name": "auth_password",
+      "module": "auth",
+      "permission": "auth:password",
+      "title": "Change password",
+      "description": "Set a new password and end every other session",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "body": {
+            "type": "object",
+            "properties": {
+              "password": {
+                "type": "string",
+                "minLength": 8
+              }
+            },
+            "required": [
+              "password"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "body"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/api/v1/auth/password"
+      }
+    },
+    {
+      "name": "users_read",
+      "module": "users",
+      "permission": "users:read",
+      "title": "List users",
+      "description": "Page through accounts, clamped by the shared bounds",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "query": {
+            "type": "object",
+            "properties": {
+              "page": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 9007199254740991
+              },
+              "per_page": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 100
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/users/"
+      }
+    },
+    {
+      "name": "users_delete",
+      "module": "users",
+      "permission": "users:delete",
+      "title": "Soft-delete a user",
+      "description": "Flags the account; ordinary queries stop returning it",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "params": {
+            "type": "object",
+            "properties": {
+              "email": {
+                "type": "string",
+                "format": "email",
+                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+              }
+            },
+            "required": [
+              "email"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "params"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "DELETE",
+        "path": "/users/:email"
+      }
+    },
+    {
+      "name": "users_read-deleted",
+      "module": "users",
+      "permission": "users:read-deleted",
+      "title": "List soft-deleted users",
+      "description": "List soft-deleted users",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/users/deleted"
+      }
+    },
+    {
+      "name": "users_create",
+      "module": "users",
+      "permission": "users:create",
+      "title": "Create a user",
+      "description": "Adds the account and queues its welcome email",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "body": {
+            "type": "object",
+            "properties": {
+              "email": {
+                "type": "string",
+                "format": "email",
+                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+              }
+            },
+            "required": [
+              "email"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "body"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/users/"
+      }
+    },
+    {
+      "name": "users_ping",
+      "module": "users",
+      "permission": "users:ping",
+      "title": "Users module status",
+      "description": "Users module status",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/users/ping"
+      }
+    },
+    {
+      "name": "users_demo-missing",
+      "module": "users",
+      "permission": "users:demo-missing",
+      "title": "HttpError demo",
+      "description": "HttpError demo",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/users/missing"
+      }
+    },
+    {
+      "name": "users_demo-boom",
+      "module": "users",
+      "permission": "users:demo-boom",
+      "title": "Unhandled error demo",
+      "description": "Unhandled error demo",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/users/boom"
+      }
+    },
+    {
+      "name": "hello_greet",
+      "module": "hello",
+      "permission": "hello:greet",
+      "title": "Greet",
+      "description": "A greeting in the caller's language",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/hello"
+      }
+    },
+    {
+      "name": "hello_greet-name",
+      "module": "hello",
+      "permission": "hello:greet-name",
+      "title": "Greet by name",
+      "description": "Greet by name",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "params": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "params"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/hello/:name"
+      }
+    },
+    {
+      "name": "hello_list-greetings",
+      "module": "hello",
+      "permission": "hello:list-greetings",
+      "title": "List greetings",
+      "description": "The stored greetings, with how often each was used",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/greetings"
+      }
+    },
+    {
+      "name": "hello_use-greeting",
+      "module": "hello",
+      "permission": "hello:use-greeting",
+      "title": "Use a greeting",
+      "description": "Queues a job that counts the use",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "params": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "params"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "POST",
+        "path": "/api/v1/greetings/:name/use"
+      }
+    },
+    {
+      "name": "hello_reset-counts",
+      "module": "hello",
+      "permission": "hello:reset-counts",
+      "description": "Reset the usage counter of every greeting to zero",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "confirm": {
+            "description": "Set to true to confirm the reset",
+            "type": "boolean",
+            "const": true
+          }
+        },
+        "required": [
+          "confirm"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "action"
+      }
+    },
+    {
+      "name": "config_read",
+      "module": "config",
+      "permission": "config:read",
+      "title": "Describe the app",
+      "description": "Every module in load order: manifest, declared variables (names, types, sources; secrets never), settings with schema, live values and stored version, endpoints with the roles that reach them",
+      "input_schema": {
+        "type": "object",
+        "properties": {},
+        "required": [],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/config/"
+      }
+    },
+    {
+      "name": "config_describe",
+      "module": "config",
+      "permission": "config:describe",
+      "title": "Describe one module",
+      "description": "The same description for one module",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "params": {
+            "type": "object",
+            "properties": {
+              "module": {
+                "type": "string",
+                "pattern": "^[a-z][a-z0-9-]*$"
+              }
+            },
+            "required": [
+              "module"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "params"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": true,
+      "transport": {
+        "kind": "http",
+        "method": "GET",
+        "path": "/api/v1/config/:module"
+      }
+    },
+    {
+      "name": "config_write",
+      "module": "config",
+      "permission": "config:write",
+      "title": "Change a module's settings",
+      "description": "A patch over the stored values, validated by the module's schema; a stale version is refused; applied at once in every replica, except fields tagged restart, which apply on the next boot",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "params": {
+            "type": "object",
+            "properties": {
+              "module": {
+                "type": "string",
+                "pattern": "^[a-z][a-z0-9-]*$"
+              }
+            },
+            "required": [
+              "module"
+            ],
+            "additionalProperties": false
+          },
+          "body": {
+            "type": "object",
+            "properties": {
+              "values": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string"
+                },
+                "additionalProperties": {}
+              },
+              "version": {
+                "type": "integer",
+                "exclusiveMinimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "values"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "params",
+          "body"
+        ],
+        "additionalProperties": false
+      },
+      "read_only": false,
+      "transport": {
+        "kind": "http",
+        "method": "PATCH",
+        "path": "/api/v1/config/:module"
+      }
+    }
+  ]
+}