Skip to content

Instantly share code, notes, and snippets.

@JohnMAustin78

JohnMAustin78/CMS-schema.json

Created April 28, 2025 17:36
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save JohnMAustin78/0129b8d20e62f59b83e43c53cfba55cd to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save JohnMAustin78/0129b8d20e62f59b83e43c53cfba55cd to your computer and use it in GitHub Desktop.
Download ZIP
Conditional API requirements modeled in your favorite CMS
Raw
CMS-schema.json
[
{
"changelogSdk": {
"sys": {
"id": "changelogSdk",
"type": "ContentType"
},
"name": "Changelog Entry",
"description": "A changelog entry",
"displayField": "slug",
"fields": [
{
"id": "slug",
"name": "Slug",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "linkBack",
"name": "linkBack",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "changelogType",
"name": "Changelog Type",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"in": [
"Connect SDK",
"Mobile",
"API (Connect and Authorization)",
"Services"
]
}
],
"disabled": false,
"omitted": false
},
{
"id": "changelogDate",
"name": "Changelog Date",
"type": "Date",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "squareVersion",
"name": "Square Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "mainSdkVersion",
"name": "Main SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"size": {
"max": 16
}
}
],
"disabled": true,
"omitted": false
},
{
"id": "javaSdkVersion",
"name": "Java SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "netSdkVersion",
"name": ".NET SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"size": {
"max": 16
}
}
],
"disabled": false,
"omitted": false
},
{
"id": "nodeJsSdkVersion",
"name": "Node.JS SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "phpSdkVersion",
"name": "PHP SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "pythonSdkVersion",
"name": "Python SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "rubySdkVersion",
"name": "Ruby SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "goSdkVersion",
"name": "Go SDK Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "summary",
"name": "Summary",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "details",
"name": "Details",
"type": "Text",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "tags",
"name": "Tags",
"type": "Array",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Symbol",
"validations": [
{
"in": [
".NET",
"Android",
"App Marketplace Requirements",
"Bank Accounts API",
"BETA",
"Booking Custom Attributes API",
"Bookings API",
"Cards API",
"Cash Drawer Shifts API",
"Catalog API",
"Checkout API",
"Connect v1",
"Connect v2",
"Custom Attributes",
"Customer Custom Attributes API",
"Customer Groups API",
"Customer Segments API",
"Customers API",
"DEPRECATED",
"Devices API",
"Disputes API",
"Documentation",
"Employees API",
"Events API",
"Flutter",
"GA",
"Gift Card Activities API",
"Gift Cards API",
"GraphQL",
"In-App Payments SDK",
"Inventory API",
"Invoices API",
"iOS",
"Java",
"Labor API",
"Location Custom Attributes API",
"Locations API",
"Loyalty API",
"Merchant Custom Attributes API",
"Merchants API",
"Mobile Authorization API",
"Mobile Payments SDK",
"Mobile Web",
"Node.js",
"OAuth API",
"Online",
"Order Custom Attributes API",
"Orders API",
"Payments API",
"Payouts API",
"PHP",
"Point of Sale API",
"Python",
"React Native",
"Reader SDK",
"Refunds API",
"RETIRED",
"Ruby",
"Sites API",
"Snippets API",
"Square",
"Square Bridge",
"Square Integrations",
"Square Payment Form",
"Square SDK",
"Subscriptions API",
"Team API",
"Terminal API",
"Transactions API",
"Vendors API",
"Web Payments SDK",
"Webhook Subscriptions API",
"Webhooks"
]
}
]
}
},
{
"id": "constantSets",
"name": "Constant Sets",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"constantSet"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"constant": {
"sys": {
"id": "constant",
"type": "ContentType"
},
"name": "Constant",
"description": "Reusable content referenced from a page's markdown",
"displayField": "token",
"fields": [
{
"id": "token",
"name": "Token",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "value",
"name": "Value",
"type": "Text",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
},
{
"markdownBlock": {
"sys": {
"id": "markdownBlock",
"type": "ContentType"
},
"name": "Markdown - Block",
"description": "",
"displayField": "name",
"fields": [
{
"id": "name",
"name": "Name",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "markdown",
"name": "Markdown",
"type": "Text",
"localized": false,
"required": false,
"validations": [
{
"prohibitRegexp": {
"pattern": "squareupstaging.com",
"flags": null
},
"message": "squareupstaging.com is not allowed"
}
],
"disabled": false,
"omitted": false
},
{
"id": "programmingLanguage",
"name": "Programming Language",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"in": [
".NET",
"All",
"Bash",
"Build a Shift request",
"Check for an open shift",
"cURL",
"Java",
"Javascript/HTML",
"Kotlin",
"Node.js",
"Objective C",
"Orders API Integration",
"PHP (5.x)",
"PHP (7.x)",
"PowerShell",
"Python",
"Ruby",
"Swift",
"Swift+UIkit",
"Swift+SwiftUI",
"Custom Processing"
]
}
],
"defaultValue": {
"en": "All"
},
"disabled": false,
"omitted": false
},
{
"id": "platform",
"name": "Platform",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"in": [
"All",
"Android",
"Command Line",
"HTTP",
"iOS",
"Scenario",
"SDK"
]
}
],
"defaultValue": {
"en": "All"
},
"disabled": false,
"omitted": false
},
{
"id": "constantSets",
"name": "Constant Sets",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"constantSet"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"requirementsDomain": {
"sys": {
"id": "requirementsDomain",
"type": "ContentType"
},
"name": "Requirements Domain",
"description": "Represents a certain domain (i.e. API) which will contain questions and generated requirements",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "title",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "topLevelQuestions",
"name": "top_level_questions",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirementQuestionMultipleChoice",
"requirementQuestionShortAnswer",
"requirementQuestionTrueOrFalse"
]
}
],
"linkType": "Entry"
}
},
{
"id": "defaultRequirements",
"name": "default_requirements",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirement",
"requirementSet"
]
}
],
"linkType": "Entry"
}
},
{
"id": "apiUsageDescription",
"name": "api usage description",
"type": "Text",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "usageRequired",
"name": "required for integration check",
"type": "Boolean",
"localized": false,
"required": false,
"validations": [],
"defaultValue": {
"en": false
},
"disabled": false,
"omitted": false
}
]
}
},
{
"releaseTrain": {
"sys": {
"id": "releaseTrain",
"type": "ContentType"
},
"name": "Release Train",
"description": "",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "slug",
"name": "Slug",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "released",
"name": "Released?",
"type": "Boolean",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "contentToPublish",
"name": "Content to publish",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"constantSet",
"navigationCategory",
"navigationSubCategory",
"navigationText",
"referenceSpecification",
"routeConfiguration",
"titledLink",
"requirement",
"requirementOption",
"requirementQuestionMultipleChoice",
"requirementQuestionShortAnswer",
"requirementQuestionTrueOrFalse",
"requirementSet",
"requirementsDomain"
]
}
],
"linkType": "Entry"
}
},
{
"id": "review",
"name": "Review",
"type": "Object",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
},
{
"requirementSet": {
"sys": {
"id": "requirementSet",
"type": "ContentType"
},
"name": "Requirement Set",
"description": "A set of requirements bundled and managed together.",
"displayField": "contentId",
"fields": [
{
"id": "contentId",
"name": "content_id",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "title",
"name": "title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "requirements",
"name": "requirements",
"type": "Array",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirement"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"requirement": {
"sys": {
"id": "requirement",
"type": "ContentType"
},
"name": "Requirement",
"description": "Represents a single requirement for a partner",
"displayField": "contentId",
"fields": [
{
"id": "contentId",
"name": "content_id",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "displayValue",
"name": "display_value",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "documentationUrl",
"name": "documentation_url",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
},
{
"requirementOption": {
"sys": {
"id": "requirementOption",
"type": "ContentType"
},
"name": "Requirement Option",
"description": "Represents a multiple choice option which may lead to followup questions and/or requirements",
"displayField": "contentId",
"fields": [
{
"id": "contentId",
"name": "content_id",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "displayValue",
"name": "display_value",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "followupQuestions",
"name": "followup_questions",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirementQuestionMultipleChoice",
"requirementQuestionShortAnswer",
"requirementQuestionTrueOrFalse"
]
}
],
"linkType": "Entry"
}
},
{
"id": "requirements",
"name": "requirements",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirement",
"requirementSet"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"requirementQuestionMultipleChoice": {
"sys": {
"id": "requirementQuestionMultipleChoice",
"type": "ContentType"
},
"name": "Requirement Question Multiple Choice",
"description": "Represents a multiple choice question as part of App Launch",
"displayField": "contentId",
"fields": [
{
"id": "contentId",
"name": "content_id",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "question",
"name": "question",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
},
{
"size": {
"min": 0,
"max": 1000
},
"message": "Too Many characters"
}
],
"disabled": false,
"omitted": false
},
{
"id": "dashboardSpecific",
"name": "dashboard_specific",
"type": "Boolean",
"localized": false,
"required": true,
"validations": [],
"defaultValue": {
"en": false
},
"disabled": false,
"omitted": false
},
{
"id": "multiSelect",
"name": "multi_select",
"type": "Boolean",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "options",
"name": "options",
"type": "Array",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirementOption"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"requirementQuestionTrueOrFalse": {
"sys": {
"id": "requirementQuestionTrueOrFalse",
"type": "ContentType"
},
"name": "Requirement Question True Or False",
"description": "Represents a true/false question as part of App Launch",
"displayField": "contentId",
"fields": [
{
"id": "contentId",
"name": "content_id",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "question",
"name": "question",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"size": {
"min": null,
"max": 1000
},
"message": "Too long contact #dex-tag"
}
],
"disabled": false,
"omitted": false
},
{
"id": "dashboardSpecific",
"name": "dashboard_specific",
"type": "Boolean",
"localized": false,
"required": true,
"validations": [],
"defaultValue": {
"en": false
},
"disabled": false,
"omitted": false
},
{
"id": "trueFollowups",
"name": "true_followups",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirementQuestionShortAnswer",
"requirementQuestionMultipleChoice",
"requirementQuestionTrueOrFalse"
]
}
],
"linkType": "Entry"
}
},
{
"id": "falseFollowups",
"name": "false_followups",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirementQuestionMultipleChoice",
"requirementQuestionShortAnswer",
"requirementQuestionTrueOrFalse"
]
}
],
"linkType": "Entry"
}
},
{
"id": "trueRequirements",
"name": "true_requirements",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirement",
"requirementSet"
]
}
],
"linkType": "Entry"
}
},
{
"id": "falseRequirements",
"name": "false_requirements",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"requirement",
"requirementSet"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"requirementQuestionShortAnswer": {
"sys": {
"id": "requirementQuestionShortAnswer",
"type": "ContentType"
},
"name": "Requirement Question Short Answer",
"description": "Represents a short answer question as part of App Launch",
"displayField": "contentId",
"fields": [
{
"id": "contentId",
"name": "content_id",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "question",
"name": "question",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "dashboardSpecific",
"name": "dashboard_specific",
"type": "Boolean",
"localized": false,
"required": true,
"validations": [],
"defaultValue": {
"en": true
},
"disabled": false,
"omitted": false
}
]
}
},
{
"heading": {
"sys": {
"id": "heading",
"type": "ContentType"
},
"name": "Heading",
"description": "",
"displayField": "title",
"fields": [
{
"id": "releaseStatus",
"name": "Release Status",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"in": [
"PUBLIC",
"BETA",
"DEPRECATED",
"DEPRECATED and RESTRICTED",
"NEW",
"CAPABILITY"
]
}
],
"disabled": false,
"omitted": false
},
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "browserTitle",
"name": "Browser Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"size": {
"min": null,
"max": 60
}
}
],
"disabled": false,
"omitted": false
},
{
"id": "eyebrow",
"name": "Eyebrow",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "summary",
"name": "Summary",
"type": "Text",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
},
{
"docPage": {
"sys": {
"id": "docPage",
"type": "ContentType"
},
"name": "Doc Page",
"description": "A generic documentation page.",
"displayField": "slug",
"fields": [
{
"id": "slug",
"name": "Slug",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"regexp": {
"pattern": "^[a-z0-9][a-z0-9\\-\\/]*[a-z0-9]$",
"flags": null
},
"message": "Slug must contain lowercase letters separated by \"-\" or \"/\". example: payments/in-app-payments-sdk/quickstart/step3"
}
],
"disabled": false,
"omitted": false
},
{
"id": "searchSummary",
"name": "Search Summary",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"size": {
"max": 155,
"min": 50
},
"message": "Search summaries should be between 140 and 160 characters to align with common search platforms."
}
],
"disabled": false,
"omitted": false
},
{
"id": "heading",
"name": "Heading",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"heading"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "content",
"name": "Content",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"infoWidgetBlock",
"markdownBlock",
"multiLanguageBlock",
"nextStepsBlock",
"articleBottomNav",
"walkthroughBlock"
]
}
],
"linkType": "Entry"
}
},
{
"id": "relatedPages",
"name": "Related Pages",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"relatedPages"
]
}
],
"linkType": "Entry"
}
},
{
"id": "languagesSupported",
"name": "Languages Covered",
"type": "Array",
"localized": false,
"required": true,
"validations": [],
"defaultValue": {
"en": [
"All"
]
},
"disabled": false,
"omitted": false,
"items": {
"type": "Symbol",
"validations": [
{
"in": [
".NET",
"All",
"Build a Shift request",
"Check for an open shift",
"cURL",
"Java",
"Javascript/HTML",
"Kotlin",
"Node.js",
"Objective C",
"Orders API Integration",
"PHP (5.x)",
"PHP (7.x)",
"PowerShell",
"Python",
"Ruby",
"Swift",
"Custom Processing"
]
}
]
}
},
{
"id": "platforms",
"name": "Platforms Covered",
"type": "Array",
"localized": false,
"required": true,
"validations": [],
"defaultValue": {
"en": [
"All"
]
},
"disabled": false,
"omitted": false,
"items": {
"type": "Symbol",
"validations": [
{
"in": [
"All",
"Android",
"Command Line",
"HTTP",
"iOS",
"Scenario",
"SDK"
]
}
]
}
},
{
"id": "constantSets",
"name": "Constant Sets",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"constantSet"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"routeConfiguration": {
"sys": {
"id": "routeConfiguration",
"type": "ContentType"
},
"name": "Route Configuration",
"description": "Route configurations for Routable Pages",
"displayField": "slug",
"fields": [
{
"id": "slug",
"name": "Slug",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
},
{
"regexp": {
"pattern": "^[a-z0-9][a-z0-9\\-\\/]*[a-z0-9]$",
"flags": null
},
"message": "example: payments/in-app-payments-sdk/quickstart/step3"
}
],
"disabled": false,
"omitted": false
},
{
"id": "defaultPage",
"name": "Default Page",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"changelogSdk",
"changelogSet",
"docPage",
"marketingPage",
"redirect"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "featureFlag",
"name": "Feature Flag",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"changelogDetails",
"changelogSummary",
"featureFlag"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "featureFlagOverridePage",
"name": "Feature Flag Override Page",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"changelogPage",
"docPage",
"marketingPage"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "review",
"name": "Review",
"type": "Object",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "leftNav",
"name": "Left Nav",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"navigationSubCategory"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"constantSet": {
"sys": {
"id": "constantSet",
"type": "ContentType"
},
"name": "Constant Set",
"description": "",
"displayField": "description",
"fields": [
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "token",
"name": "Token",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "constants",
"name": "Constants",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"constant"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"imageWrapper": {
"sys": {
"id": "imageWrapper",
"type": "ContentType"
},
"name": "ImageWrapper",
"description": "Use this as a wrapper on images so you can see which markdown blocks the image is embedded in.",
"displayField": "name",
"fields": [
{
"id": "name",
"name": "name",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "image",
"name": "image",
"type": "Link",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"linkType": "Asset"
}
]
}
},
{
"titledLink": {
"sys": {
"id": "titledLink",
"type": "ContentType"
},
"name": "Titled Link",
"description": "A link with url information and a title",
"displayField": "url",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "url",
"name": "URL",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"regexp": {
"pattern": "^(http|\\/)",
"flags": null
},
"message": "Must start with / if it's an internal link or http if it's external"
}
],
"disabled": false,
"omitted": false
},
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "iconComponent",
"name": "iconComponent",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkMimetypeGroup": [
"image"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Asset"
},
{
"id": "featureFlag",
"name": "Feature Flag",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"featureFlag"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"redirect": {
"sys": {
"id": "redirect",
"type": "ContentType"
},
"name": "Redirect",
"description": "",
"displayField": "description",
"fields": [
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "redirectTo",
"name": "Redirect To",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"routeConfiguration"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "anchor",
"name": "Anchor",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
},
{
"referenceSpecification": {
"sys": {
"id": "referenceSpecification",
"type": "ContentType"
},
"name": "Reference Specification",
"description": "Stores a JSON document and metadata about it that can be used to render a technical reference for a product, such as the Square API, Marketplaces API, or Square Payment Form.",
"displayField": "name",
"fields": [
{
"id": "name",
"name": "Name",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "namespace",
"name": "Namespace",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"in": [
"square",
"marketplaces",
"connect-v1",
"alpha"
],
"message": "Please use a valid namespace: \"square\", \"connect-v1\", or \"marketplaces\"."
}
],
"disabled": false,
"omitted": false
},
{
"id": "square_version",
"name": "Square Version",
"type": "Date",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "client_version",
"name": "Client Version",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"regexp": {
"pattern": "\\d+\\.\\d+\\.\\d+",
"flags": null
}
}
],
"disabled": false,
"omitted": false
},
{
"id": "json_spec_grammar",
"name": "Spec Grammar",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"in": [
"open-api-3",
"examples"
],
"message": "Only the \"open-api-3\" grammar is supported at this time."
}
],
"disabled": false,
"omitted": false
},
{
"id": "compressed_spec",
"name": "Compressed Spec",
"type": "Object",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "required_feature_flag",
"name": "Required Feature Flag",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"featureFlag"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"navigationText": {
"sys": {
"id": "navigationText",
"type": "ContentType"
},
"name": "Navigation Text",
"description": "A piece of text in the navigation without a link",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "type",
"name": "Type",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [
{
"in": [
"h1",
"h2",
"divider"
]
}
],
"disabled": false,
"omitted": false
},
{
"id": "featureFlag",
"name": "Feature Flag",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"featureFlag"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"navigationSubCategory": {
"sys": {
"id": "navigationSubCategory",
"type": "ContentType"
},
"name": "Navigation Sub Category",
"description": "",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "url",
"name": "URL",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "navigationItems",
"name": "Navigation Items",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"navigationCategory",
"navigationSubCategory",
"navigationText",
"titledLink"
]
}
],
"linkType": "Entry"
}
},
{
"id": "featureFlag",
"name": "Feature Flag",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"featureFlag"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"navigationSet": {
"sys": {
"id": "navigationSet",
"type": "ContentType"
},
"name": "Navigation Set",
"description": "A top-level collection of Navigation Categories, Navigation Items, and Navigation Texts.",
"displayField": "name",
"fields": [
{
"id": "name",
"name": "Name",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "navigationItems",
"name": "Navigation Items",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"navigationCategory",
"navigationSubCategory",
"navigationText",
"titledLink"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"infoWidget": {
"sys": {
"id": "infoWidget",
"type": "ContentType"
},
"name": "Info Widget",
"description": "A widget that contains information, that can be styled with markdown, and add an SVG icon",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "text",
"name": "Text",
"type": "Text",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "icon",
"name": "icon",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkMimetypeGroup": [
"image"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Asset"
}
]
}
},
{
"infoWidgetBlock": {
"sys": {
"id": "infoWidgetBlock",
"type": "ContentType"
},
"name": "Info Widget Block",
"description": "A block of Info Widgets",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "infoWidgets",
"name": "Info Widgets",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"infoWidget"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"multiLanguageBlock": {
"sys": {
"id": "multiLanguageBlock",
"type": "ContentType"
},
"name": "Multi-Language - Block",
"description": "",
"displayField": "description",
"fields": [
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "javaAndroid",
"name": "Android - Java",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "kotlinAndroid",
"name": "Android - Kotlin",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "objcIOS",
"name": "iOS - Objective C",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "swiftIOS",
"name": "iOS - Swift",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "phpSdk",
"name": "SDK - PHP",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "curlCmd",
"name": "CMD - cURL",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"disabled": true,
"omitted": false,
"linkType": "Entry"
},
{
"id": "blocks",
"name": "Blocks",
"type": "Array",
"localized": false,
"required": false,
"validations": [
{
"size": {
"min": 1
},
"message": "Add at least one block"
}
],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"markdownBlock"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"navigationCategory": {
"sys": {
"id": "navigationCategory",
"type": "ContentType"
},
"name": "Navigation Category",
"description": "A grouped set of navigation items, categories, and titles",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "navigationItems",
"name": "Navigation Items",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"navigationReleaseTrainWrapper",
"navigationCategory",
"navigationSubCategory",
"navigationText",
"titledLink"
]
}
],
"linkType": "Entry"
}
},
{
"id": "featureFlag",
"name": "Feature Flag",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"featureFlag"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"apiGroup": {
"sys": {
"id": "apiGroup",
"type": "ContentType"
},
"name": "API Group",
"description": "A representation of a group of API Categories",
"displayField": "name",
"fields": [
{
"id": "name",
"name": "Name",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "description",
"name": "Description",
"type": "Text",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "categories",
"name": "Categories",
"type": "Array",
"localized": false,
"required": true,
"validations": [
{
"size": {
"min": 1
}
}
],
"disabled": false,
"omitted": false,
"items": {
"type": "Symbol",
"validations": []
}
}
]
}
},
{
"entryCopies": {
"sys": {
"id": "entryCopies",
"type": "ContentType"
},
"name": "Entry Copies",
"description": "An editorial tool used to keep track of what has been copied",
"displayField": null,
"fields": [
{
"id": "original",
"name": "Original",
"type": "Link",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "copies",
"name": "Copies",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [],
"linkType": "Entry"
}
}
]
}
},
{
"walkthroughBlock": {
"sys": {
"id": "walkthroughBlock",
"type": "ContentType"
},
"name": "Walkthrough Block",
"description": "(WIP) Block for the walkthrough demo widget for SCA changes",
"displayField": "description",
"fields": [
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "steps",
"name": "Steps",
"type": "Array",
"localized": false,
"required": true,
"validations": [
{
"size": {
"min": 1,
"max": 100
}
}
],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"walkthroughBlockStep"
],
"message": "Must be a walkthrough block step to work in the widget"
}
],
"linkType": "Entry"
}
}
]
}
},
{
"changelogSet": {
"sys": {
"id": "changelogSet",
"type": "ContentType"
},
"name": "Changelog Set",
"description": "A set of related changelogs",
"displayField": "slug",
"fields": [
{
"id": "slug",
"name": "Slug",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
},
{
"id": "heading",
"name": "Heading",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"heading"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "entryHeading",
"name": "Entry Heading",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "latestChanglog",
"name": "Latest Changlog",
"type": "Link",
"localized": false,
"required": true,
"validations": [
{
"linkContentType": [
"changelogSdk"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "changelogHistory",
"name": "Changelog History",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"changelogSdk"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"walkthroughBlockStep": {
"sys": {
"id": "walkthroughBlockStep",
"type": "ContentType"
},
"name": "Walkthrough Block Step",
"description": "Specific step for walkthrough block",
"displayField": "title",
"fields": [
{
"id": "eyebrow",
"name": "Eyebrow",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "description",
"name": "Description",
"type": "Text",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "image",
"name": "Image",
"type": "Link",
"localized": false,
"required": true,
"validations": [],
"disabled": false,
"omitted": false,
"linkType": "Asset"
}
]
}
},
{
"articleBottomNav": {
"sys": {
"id": "articleBottomNav",
"type": "ContentType"
},
"name": "Nav Block: Previous + Next",
"description": "",
"displayField": "description",
"fields": [
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "prevText",
"name": "Prev Text",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "prevPage",
"name": "Prev Page",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"navigationSubCategory",
"titledLink"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
},
{
"id": "nextText",
"name": "Next Text",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "nextPage",
"name": "Next Page",
"type": "Link",
"localized": false,
"required": false,
"validations": [
{
"linkContentType": [
"navigationSubCategory",
"titledLink"
]
}
],
"disabled": false,
"omitted": false,
"linkType": "Entry"
}
]
}
},
{
"nextStepsBlock": {
"sys": {
"id": "nextStepsBlock",
"type": "ContentType"
},
"name": "Nav Block: Next steps",
"description": "",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "description",
"name": "Description",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "steps",
"name": "Steps",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"titledLink"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"relatedPages": {
"sys": {
"id": "relatedPages",
"type": "ContentType"
},
"name": "Related Pages",
"description": "",
"displayField": "title",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "links",
"name": "Links",
"type": "Array",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false,
"items": {
"type": "Link",
"validations": [
{
"linkContentType": [
"titledLink"
]
}
],
"linkType": "Entry"
}
}
]
}
},
{
"marketingPage": {
"sys": {
"id": "marketingPage",
"type": "ContentType"
},
"name": "Marketing - Page",
"description": "",
"displayField": "slug",
"fields": [
{
"id": "slug",
"name": "slug",
"type": "Symbol",
"localized": false,
"required": false,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
},
{
"featureFlag": {
"sys": {
"id": "featureFlag",
"type": "ContentType"
},
"name": "Feature Flag",
"description": "A model that links to a feature flag in the feature service. ",
"displayField": "flag",
"fields": [
{
"id": "flag",
"name": "flag",
"type": "Symbol",
"localized": false,
"required": true,
"validations": [
{
"unique": true
}
],
"disabled": false,
"omitted": false
}
]
}
}
]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment