schema.json

{"$ref":"#/definitions/Schema","definitions":{"Schema":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","default":"schema"},"Massive":{"type":"string"},"name":{"type":"string","minLength":1},"logo":{"anyOf":[{"type":"string","minLength":3},{"type":"object","properties":{"light":{"type":"string"},"dark":{"type":"string"},"href":{"type":"string"}},"required":["light","dark"],"additionalProperties":false}]},"theme":{"type":"string","enum":["venus","quill","prism"]},"layout":{"type":"string","enum":["topnav","sidenav","solidSidenav"]},"favicon":{"type":"string","description":"A path pointing to the favicon file in your docs folder, including the file extension. We recommend using an .svg or .png file. The favicon will automatically be resized to the appropriate sizes"},"openapi":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A string or an array of strings of absolute or relative urls pointing to your OpenAPI files"},"topbar":{"type":"object","properties":{"style":{"type":"string","enum":["gradient","default"]}},"additionalProperties":false},"sidebar":{"type":"object","properties":{"items":{"type":"string","enum":["container","card","border","undecorated"]}},"additionalProperties":false},"rounded":{"type":"string","enum":["default","sharp"]},"api":{"type":"object","properties":{"baseUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"array","items":{"type":"string","format":"uri"}}]},"auth":{"type":"object","properties":{"method":{"type":"string","enum":["bearer","basic","key","cobo"]},"name":{"type":"string"},"inputPrefix":{"type":"string"}},"additionalProperties":false},"playground":{"type":"object","properties":{"mode":{"type":"string","enum":["show","simple","hide"],"default":"show"}},"additionalProperties":false},"request":{"type":"object","properties":{"example":{"type":"object","properties":{"showOptionalParams":{"type":"boolean","default":false}},"additionalProperties":false}},"additionalProperties":false},"maintainOrder":{"type":"boolean"}},"additionalProperties":false},"modeToggle":{"type":"object","properties":{"default":{"type":"string","enum":["light","dark"]},"isHidden":{"type":"boolean"}},"additionalProperties":false},"versions":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"name":{"type":"string","minLength":1},"url":{"type":"string","minLength":1}},"required":["name","url"],"additionalProperties":false}]},"minItems":1},"metadata":{"type":"object","additionalProperties":{"type":"string","minLength":1}},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"light":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"},"dark":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"},"background":{"type":"object","properties":{"light":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"},"dark":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"}},"additionalProperties":false},"anchors":{"anyOf":[{"$ref":"#/definitions/Schema/properties/colors/properties/primary"},{"type":"object","properties":{"from":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"},"via":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"},"to":{"$ref":"#/definitions/Schema/properties/colors/properties/primary"}},"required":["from","to"],"additionalProperties":false}]}},"required":["primary"],"additionalProperties":false,"description":"The colors to use in your documentation. At the very least, you must define the primary color. For example: { \"colors\": { \"primary\": \"#ff0000\" } }"},"topbarCtaButton":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"link"},"name":{"type":"string"},"url":{"type":"string","minLength":1},"style":{"type":"string","enum":["pill","roundedRectangle"]},"arrow":{"type":"boolean"}},"required":["name","url"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"github"},"url":{"type":"string","format":"uri","description":"A link to your GitHub repository"}},"required":["type","url"],"additionalProperties":false}],"description":"An object containing the configuration for a Call-to-Action button. The object can have { \"type\": \"link\" } (the default) if you define a url and a name. For links to your GitHub repo, use { \"type\": \"github\" }"},"topbarLinks":{"type":"array","items":{"$ref":"#/definitions/Schema/properties/topbarCtaButton"},"description":"An object containing the configuration for a Call-to-Action button. The object can have { \"type\": \"link\" } (the default) if you define a url and a name. For links to your GitHub repo, use { \"type\": \"github\" }"},"navigation":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string","description":"The label for this group in the navigation sidebar"},"icon":{"type":"string"},"iconType":{"type":"string","enum":["brands","duotone","light","regular","sharp-light","sharp-regular","sharp-solid","sharp-thin","solid","thin"]},"version":{"type":"string"},"pages":{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/Schema/properties/navigation/items"},{"type":"string","minLength":1}]},"minItems":1}},"required":["group","pages"],"additionalProperties":false},"minItems":1},"primaryTab":{"type":"object","properties":{"name":{"type":"string"},"isDefaultHidden":{"type":"boolean"}},"required":["name"],"additionalProperties":false},"topAnchor":{"type":"object","properties":{"name":{"type":"string"},"icon":{"type":"string"},"iconType":{"type":"string","enum":["brands","duotone","light","regular","sharp-light","sharp-regular","sharp-solid","sharp-thin","solid","thin"]}},"required":["name"],"additionalProperties":false},"anchors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"url":{"type":"string","minLength":1},"icon":{"type":"string"},"iconType":{"type":"string","enum":["brands","duotone","light","regular","sharp-light","sharp-regular","sharp-solid","sharp-thin","solid","thin"]},"color":{"$ref":"#/definitions/Schema/properties/colors/properties/anchors"},"isDefaultHidden":{"type":"boolean"},"version":{"type":"string"},"openapi":{"type":"string","minLength":1}},"required":["name","url"],"additionalProperties":false}},"tabs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"url":{"type":"string","minLength":1},"version":{"type":"string"},"isDefaultHidden":{"type":"boolean"},"openapi":{"$ref":"#/definitions/Schema/properties/anchors/items/properties/openapi"}},"required":["name","url"],"additionalProperties":false}},"footerSocials":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["type","url"],"additionalProperties":false}},{"type":"object","additionalProperties":{"type":"string","format":"uri"},"propertyNames":{"minLength":1}}],"description":"An object in which each key is the name of a social media platform, and each value is the url to your profile. For example: { \"twitter\": \"https://twitter.com/joinmasse\" }"},"background":{"type":"object","properties":{"style":{"type":"string","enum":["gradient","grid","windows"]}},"additionalProperties":false},"backgroundImage":{"type":"string"},"feedback":{"type":"object","properties":{"thumbsRating":{"type":"boolean"},"suggestEdit":{"type":"boolean"},"raiseIssue":{"type":"boolean"}},"additionalProperties":false},"analytics":{"type":"object","properties":{"amplitude":{"type":"object","properties":{"apiKey":{"type":"string"}},"required":["apiKey"],"additionalProperties":false},"clearbit":{"type":"object","properties":{"publicApiKey":{"type":"string"}},"required":["publicApiKey"],"additionalProperties":false},"fathom":{"type":"object","properties":{"siteId":{"type":"string"}},"required":["siteId"],"additionalProperties":false},"ga4":{"type":"object","properties":{"measurementId":{"type":"string","pattern":"^G"}},"required":["measurementId"],"additionalProperties":false},"gtm":{"type":"object","properties":{"tagId":{"type":"string","pattern":"^G"}},"required":["tagId"],"additionalProperties":false},"heap":{"type":"object","properties":{"appId":{"type":"string"}},"required":["appId"],"additionalProperties":false},"hotjar":{"type":"object","properties":{"hjid":{"type":"string"},"hjsv":{"type":"string"}},"required":["hjid","hjsv"],"additionalProperties":false},"koala":{"type":"object","properties":{"publicApiKey":{"type":"string","minLength":2}},"required":["publicApiKey"],"additionalProperties":false},"logrocket":{"type":"object","properties":{"appId":{"type":"string"}},"required":["appId"],"additionalProperties":false},"mixpanel":{"type":"object","properties":{"projectToken":{"type":"string"}},"required":["projectToken"],"additionalProperties":false},"pirsch":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"posthog":{"type":"object","properties":{"apiKey":{"type":"string","pattern":"^phc\\_"},"apiHost":{"type":"string","format":"uri"}},"required":["apiKey"],"additionalProperties":false},"plausible":{"type":"object","properties":{"domain":{"type":"string"}},"required":["domain"],"additionalProperties":false}},"additionalProperties":false},"integrations":{"type":"object","properties":{"intercom":{"type":"string","minLength":6},"frontchat":{"type":"string","minLength":6},"osano":{"type":"string","allOf":[{"pattern":"^https\\:\\/\\/cmp\\.osano\\.com\\/"},{"pattern":"\\/osano\\.js$"}]}},"additionalProperties":false},"isWhiteLabeled":{"type":"boolean"},"search":{"type":"object","properties":{"prompt":{"type":"string"},"location":{"type":"string","enum":["side","top"]}},"additionalProperties":false},"redirects":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"destination":{"type":"string"},"permanent":{"type":"boolean"}},"required":["source","destination"],"additionalProperties":false}},"seo":{"type":"object","properties":{"indexHiddenPages":{"type":"boolean"}},"additionalProperties":false}},"required":["name","favicon","colors","navigation"],"additionalProperties":false}},"$schema":"http://json-schema.org/draft-07/schema#"}