@takeshape/schema 7.194.0

package/examples/v3_2_0/user-schema-no-required.json

@@ -0,0 +1,174 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "version": 1,
+  "apiVersion": "1",
+  "author": "<userId>",
+  "projectId": "project-id",
+  "locales": ["en-us"],
+  "defaultLocale": "en-us",
+  "workflows": {},
+  "queries": {
+    "getUser": {
+      "shape": "User",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Get a User by ID",
+      "args": "TSGetArgs<User>"
+    },
+    "getUserList": {
+      "shape": "PaginatedList<User>",
+      "resolver": {
+        "name": "takeshape:list",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Returns a list User in natural order.",
+      "args": "TSListArgs<User>"
+    }
+  },
+  "mutations": {
+    "updateUser": {
+      "shape": "UpdateResult<User>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Update User",
+      "args": "UpdateArgs<User>"
+    },
+    "createUser": {
+      "shape": "CreateResult<User>",
+      "resolver": {
+        "name": "takeshape:create",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Create User",
+      "args": "CreateArgs<User>"
+    },
+    "duplicateUser": {
+      "shape": "DuplicateResult<User>",
+      "resolver": {
+        "name": "takeshape:duplicate",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Duplicate User",
+      "args": "DuplicateArgs<User>"
+    },
+    "deleteUser": {
+      "shape": "DeleteResult<User>",
+      "resolver": {
+        "name": "takeshape:delete",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Delete User",
+      "args": "DeleteArgs<User>"
+    }
+  },
+  "schemaVersion": "3.2.0",
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "shapes": {
+    "User": {
+      "id": "<userContentTypeId>",
+      "name": "User",
+      "title": "User",
+      "model": {
+        "type": "multiple"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "firstName": {
+            "type": "string",
+            "@mapping": "takeshape:local:User.firstNameId"
+          },
+          "lastName": {
+            "type": "string",
+            "@mapping": "takeshape:local:User.lastNameId"
+          },
+          "username": {
+            "type": "string",
+            "default": "dude",
+            "maxLength": 16,
+            "minLength": 3,
+            "pattern": "^[a-z0-9_-]+$",
+            "@mapping": "takeshape:local:User.usernameId"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "@mapping": "takeshape:local:User.emailId"
+          },
+          "password": {
+            "type": "string",
+            "@sensitive": true,
+            "maxLength": 16,
+            "minLength": 3,
+            "@mapping": "takeshape:local:User.passwordId"
+          },
+          "roles": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "@mapping": "takeshape:local:User.rolesId"
+          },
+          "locations": {
+            "type": "array",
+            "items": {
+              "$ref": "#/shapes/UserLocations/schema"
+            },
+            "@mapping": "takeshape:local:User.locationsId"
+          }
+        },
+        "required": []
+      }
+    },
+    "UserLocations": {
+      "id": "locationsId",
+      "name": "UserLocations",
+      "title": "User Locations",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "lat": {
+            "type": "number",
+            "default": 40.694598,
+            "@mapping": "takeshape:local:UserLocations.latId"
+          },
+          "lon": {
+            "type": "number",
+            "default": 73.983119,
+            "@mapping": "takeshape:local:UserLocations.lonId"
+          }
+        }
+      }
+    }
+  },
+  "forms": {
+    "User": {
+      "default": {
+        "order": ["firstName", "lastName", "username", "email", "password", "roles", "locations"]
+      }
+    }
+  }
+}

package/examples/v3_2_0/user-schema-with-defaults.json

@@ -0,0 +1,187 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "version": 1,
+  "author": "<userId>",
+  "projectId": "project-id",
+  "locales": ["en-us"],
+  "defaultLocale": "en-us",
+  "apiVersion": "1",
+  "workflows": {},
+  "queries": {
+    "getUser": {
+      "shape": "User",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Get a User by ID",
+      "args": "TSGetArgs<User>"
+    },
+    "getUserList": {
+      "shape": "PaginatedList<User>",
+      "resolver": {
+        "name": "takeshape:list",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Returns a list User in natural order.",
+      "args": "TSListArgs<User>"
+    }
+  },
+  "mutations": {
+    "updateUser": {
+      "shape": "UpdateResult<User>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Update User",
+      "args": "UpdateArgs<User>"
+    },
+    "createUser": {
+      "shape": "CreateResult<User>",
+      "resolver": {
+        "name": "takeshape:create",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Create User",
+      "args": "CreateArgs<User>"
+    },
+    "duplicateUser": {
+      "shape": "DuplicateResult<User>",
+      "resolver": {
+        "name": "takeshape:duplicate",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Duplicate User",
+      "args": "DuplicateArgs<User>"
+    },
+    "deleteUser": {
+      "shape": "DeleteResult<User>",
+      "resolver": {
+        "name": "takeshape:delete",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Delete User",
+      "args": "DeleteArgs<User>"
+    }
+  },
+  "schemaVersion": "3.2.0",
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "shapes": {
+    "User": {
+      "id": "<userContentTypeId>",
+      "name": "User",
+      "title": "User",
+      "model": {
+        "type": "multiple"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "firstName": {
+            "type": "string",
+            "@l10n": true,
+            "@mapping": "takeshape:local:User.firstNameId"
+          },
+          "lastName": {
+            "type": "string",
+            "@l10n": true,
+            "@mapping": "takeshape:local:User.lastNameId"
+          },
+          "age": {
+            "type": "number",
+            "@mapping": "takeshape:local:User.ageId"
+          },
+          "username": {
+            "type": "string",
+            "default": "dude",
+            "maxLength": 16,
+            "minLength": 3,
+            "pattern": "^[a-z0-9_-]+$",
+            "@mapping": "takeshape:local:User.usernameId"
+          },
+          "email": {
+            "type": "string",
+            "@l10n": false,
+            "format": "email",
+            "@mapping": "takeshape:local:User.emailId"
+          },
+          "password": {
+            "type": "string",
+            "@sensitive": true,
+            "maxLength": 16,
+            "minLength": 3,
+            "@mapping": "takeshape:local:User.passwordId"
+          },
+          "roles": {
+            "type": "array",
+            "@l10n": true,
+            "items": {
+              "type": "string"
+            },
+            "@mapping": "takeshape:local:User.rolesId"
+          },
+          "locations": {
+            "type": "array",
+            "@l10n": true,
+            "@syncLocaleStructure": true,
+            "items": {
+              "$ref": "#/shapes/UserLocations/schema"
+            },
+            "@mapping": "takeshape:local:User.locationsId"
+          }
+        },
+        "required": ["firstName", "lastName", "username", "email", "password", "roles", "locations"]
+      }
+    },
+    "UserLocations": {
+      "id": "locationsId",
+      "name": "UserLocations",
+      "title": "User Locations",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "lat": {
+            "type": "string",
+            "default": "40.694598",
+            "@l10n": true,
+            "@mapping": "takeshape:local:UserLocations.latId"
+          },
+          "lon": {
+            "type": "string",
+            "default": "73.983119",
+            "@l10n": true,
+            "@mapping": "takeshape:local:UserLocations.lonId"
+          }
+        },
+        "required": ["lat", "lon"]
+      }
+    }
+  },
+  "forms": {
+    "User": {
+      "default": {
+        "order": ["firstName", "lastName", "age", "username", "email", "password", "roles", "locations"]
+      }
+    }
+  }
+}