@takeshape/schema 7.194.0

package/examples/v3_6_0/blog-schema.json

@@ -0,0 +1,405 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "projectId": "project-id",
+  "defaultLocale": "en",
+  "locales": [
+    "en",
+    "es"
+  ],
+  "version": 1,
+  "apiVersion": "2",
+  "author": "<userId>",
+  "workflows": {},
+  "queries": {
+    "getHomepage": {
+      "shape": "Homepage",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Homepage"
+        }
+      },
+      "description": "Get a Homepage by ID",
+      "args": "TSGetSingletonArgs<Homepage>"
+    },
+    "getPost": {
+      "shape": "Post",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Post"
+        }
+      },
+      "description": "Get a Post by ID",
+      "args": "TSGetArgs<Post>"
+    },
+    "getPostList": {
+      "shape": "PaginatedList<Post>",
+      "resolver": {
+        "name": "takeshape:list",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Post"
+        }
+      },
+      "description": "Returns a list Post in natural order.",
+      "args": "TSListArgs<Post>"
+    },
+    "getTag": {
+      "shape": "Tag",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Tag"
+        }
+      },
+      "description": "Get a Tag by ID",
+      "args": "TSGetArgs<Tag>"
+    },
+    "getTagList": {
+      "shape": "PaginatedList<Tag>",
+      "resolver": {
+        "name": "takeshape:list",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Tag"
+        }
+      },
+      "description": "Returns a list Tag in natural order.",
+      "args": "TSListArgs<Tag>"
+    }
+  },
+  "mutations": {
+    "updateHomepage": {
+      "shape": "UpdateResult<Homepage>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Homepage"
+        }
+      },
+      "description": "Update Homepage",
+      "args": "UpdateArgs<Homepage>"
+    },
+    "updatePost": {
+      "shape": "UpdateResult<Post>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Post"
+        }
+      },
+      "description": "Update Post",
+      "args": "UpdateArgs<Post>"
+    },
+    "createPost": {
+      "shape": "CreateResult<Post>",
+      "resolver": {
+        "name": "takeshape:create",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Post"
+        }
+      },
+      "description": "Create Post",
+      "args": "CreateArgs<Post>"
+    },
+    "duplicatePost": {
+      "shape": "DuplicateResult<Post>",
+      "resolver": {
+        "name": "takeshape:duplicate",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Post"
+        }
+      },
+      "description": "Duplicate Post",
+      "args": "DuplicateArgs<Post>"
+    },
+    "deletePost": {
+      "shape": "DeleteResult<Post>",
+      "resolver": {
+        "name": "takeshape:delete",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Post"
+        }
+      },
+      "description": "Delete Post",
+      "args": "DeleteArgs<Post>"
+    },
+    "updateTag": {
+      "shape": "UpdateResult<Tag>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Tag"
+        }
+      },
+      "description": "Update Tag",
+      "args": "UpdateArgs<Tag>"
+    },
+    "createTag": {
+      "shape": "CreateResult<Tag>",
+      "resolver": {
+        "name": "takeshape:create",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Tag"
+        }
+      },
+      "description": "Create Tag",
+      "args": "CreateArgs<Tag>"
+    },
+    "duplicateTag": {
+      "shape": "DuplicateResult<Tag>",
+      "resolver": {
+        "name": "takeshape:duplicate",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Tag"
+        }
+      },
+      "description": "Duplicate Tag",
+      "args": "DuplicateArgs<Tag>"
+    },
+    "deleteTag": {
+      "shape": "DeleteResult<Tag>",
+      "resolver": {
+        "name": "takeshape:delete",
+        "service": "takeshape:local",
+        "options": {
+          "model": "Tag"
+        }
+      },
+      "description": "Delete Tag",
+      "args": "DeleteArgs<Tag>"
+    }
+  },
+  "schemaVersion": "3.6.0",
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "shapes": {
+    "Homepage": {
+      "id": "<homepageContentTypeId>",
+      "name": "Homepage",
+      "title": "Home Page",
+      "model": {
+        "type": "single"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "headline": {
+            "type": "string",
+            "@l10n": true,
+            "minLength": 1,
+            "@mapping": "takeshape:local:Homepage.headlineId"
+          },
+          "hero": {
+            "@mapping": "takeshape:local:Homepage.heroId",
+            "$ref": "#/shapes/HomepageHero/schema"
+          }
+        },
+        "required": [
+          "headline"
+        ]
+      }
+    },
+    "HomepageHero": {
+      "id": "heroId",
+      "name": "HomepageHero",
+      "title": "Home Page Hero",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "image": {
+            "title": "Image",
+            "@l10n": true,
+            "@mapping": "takeshape:local:HomepageHero.imageId",
+            "$ref": "#/shapes/TSRelationship/schema",
+            "@relationship": {
+              "shapeIds": [
+                "ASSET"
+              ],
+              "type": "single"
+            }
+          },
+          "featuredPosts": {
+            "@l10n": true,
+            "@mapping": "takeshape:local:HomepageHero.featuredPostsId",
+            "type": "array",
+            "items": {
+              "$ref": "#/shapes/TSRelationship/schema"
+            },
+            "@relationship": {
+              "shapeIds": [
+                "<postContentTypeId>"
+              ],
+              "type": "multiple",
+              "relatedName": "heroFeaturedPosts"
+            }
+          }
+        }
+      }
+    },
+    "Post": {
+      "id": "<postContentTypeId>",
+      "name": "Post",
+      "title": "Post",
+      "model": {
+        "type": "multiple"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string",
+            "@l10n": true,
+            "@mapping": "takeshape:local:Post.titleId"
+          },
+          "body": {
+            "type": "string",
+            "@l10n": true,
+            "pattern": "\\w",
+            "@mapping": "takeshape:local:Post.bodyId"
+          },
+          "rating": {
+            "type": "integer",
+            "@mapping": "takeshape:local:Post.ratingId"
+          },
+          "otherStuff": {
+            "@mapping": "takeshape:local:Post.otherStuffId",
+            "$ref": "#/shapes/PostOtherStuff/schema"
+          },
+          "tags": {
+            "@mapping": "takeshape:local:Post.tagsId",
+            "type": "array",
+            "items": {
+              "$ref": "#/shapes/TSRelationship/schema"
+            },
+            "@relationship": {
+              "shapeIds": [
+                "<tagContentTypeId>"
+              ],
+              "type": "multiple",
+              "relatedName": "firstTags"
+            }
+          }
+        },
+        "required": [
+          "title"
+        ]
+      }
+    },
+    "PostOtherStuffCommentsAuthors": {
+      "id": "authorsId",
+      "name": "PostOtherStuffCommentsAuthors",
+      "title": "Post OtherStuff Comments Authors",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "@mapping": "takeshape:local:PostOtherStuffCommentsAuthors.nameId"
+          }
+        }
+      }
+    },
+    "PostOtherStuffComments": {
+      "id": "commentsId",
+      "name": "PostOtherStuffComments",
+      "title": "Post OtherStuff Comments",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "text": {
+            "type": "string",
+            "@mapping": "takeshape:local:PostOtherStuffComments.textId"
+          },
+          "authors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/shapes/PostOtherStuffCommentsAuthors/schema"
+            },
+            "@mapping": "takeshape:local:PostOtherStuffComments.authorsId"
+          }
+        }
+      }
+    },
+    "PostOtherStuff": {
+      "id": "otherStuffId",
+      "name": "PostOtherStuff",
+      "title": "Post OtherStuff",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "comments": {
+            "type": "array",
+            "@l10n": true,
+            "@syncLocaleStructure": true,
+            "items": {
+              "$ref": "#/shapes/PostOtherStuffComments/schema"
+            },
+            "@mapping": "takeshape:local:PostOtherStuff.commentsId"
+          }
+        }
+      }
+    },
+    "Tag": {
+      "id": "<tagContentTypeId>",
+      "name": "Tag",
+      "title": "Tag",
+      "model": {
+        "type": "multiple"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "@mapping": "takeshape:local:Tag.nameId"
+          }
+        },
+        "required": [
+          "name"
+        ]
+      }
+    }
+  },
+  "forms": {
+    "Homepage": {
+      "default": {
+        "order": [
+          "headline",
+          "hero"
+        ]
+      }
+    },
+    "Post": {
+      "default": {
+        "order": [
+          "title",
+          "body",
+          "rating",
+          "otherStuff",
+          "tags"
+        ]
+      }
+    },
+    "Tag": {
+      "default": {
+        "order": [
+          "name"
+        ]
+      }
+    }
+  },
+  "dataKey": "supersecret"
+}