{"$ref":"#/definitions/Schema","definitions":{"Schema":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","default":"https://mintlify.com/schema.json"},"mintlify":{"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. You can also include a URL, but browser support may be limited for file extensions other than PNG"},"openapi":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"$ref":"#/definitions/Schema/properties/openapi/anyOf/0"}}],"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"},"disableProxy":{"type":"boolean"}},"additionalProperties":false},"request":{"type":"object","properties":{"example":{"type":"object","properties":{"showOptionalParams":{"type":"boolean"},"languages":{"type":"array","items":{"anyOf":[{"type":"string","enum":["bash","python","javascript","php","go","java","ruby"]},{"type":"string"}]}}},"additionalProperties":false}},"additionalProperties":false},"maintainOrder":{"type":"boolean"},"paramFields":{"type":"object","properties":{"expanded":{"type":"string","enum":["all","topLevel","topLevelOneOfs","none"]},"post":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"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","format":"uri","minLength":1},"default":{"type":"boolean","const":true},"locale":{"type":"string","enum":["en","cn","zh","zh-Hans","zh-Hant","zh-CN","zh-TW","es","fr","fr-CA","fr-ca","ja","jp","ja-jp","ja-JP","pt","pt-BR","de","ko","it","ru","ro","cs","id","ar","tr","hi","sv","no","da","lv","nl","uk","vi","pl","uz","he","ca","fi","hu"]}},"required":["name"],"additionalProperties":false}]},"minItems":1},"metadata":{"type":"object","additionalProperties":{"type":"string","minLength":1}},"codeBlock":{"type":"object","properties":{"mode":{"type":"string","enum":["auto","dark"]}},"additionalProperties":false},"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}]},"ultraLight":{},"ultraDark":{}},"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\" } }"},"eyebrow":{"type":"object","properties":{"display":{"type":"string","enum":["section","breadcrumbs"]}},"additionalProperties":false},"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"}},"navigation":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string","description":"The label for this group in the navigation sidebar"},"public":{"type":"boolean","description":"Whether this group is public or not"},"icon":{"type":"string"},"iconType":{"type":"string","enum":["brands","duotone","light","regular","sharp-duotone-solid","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-duotone-solid","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-duotone-solid","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}},"footer":{"type":"object","properties":{"socials":{"anyOf":[{"type":"object","additionalProperties":{"type":"string","format":"uri"},"propertyNames":{"enum":["x","website","facebook","youtube","discord","slack","github","linkedin","instagram","hacker-news","medium","telegram","twitter","x-twitter","earth-americas","bluesky","threads","reddit","podcast"]}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["x","website","facebook","youtube","discord","slack","github","linkedin","instagram","hacker-news","medium","telegram","twitter","x-twitter","earth-americas","bluesky","threads","reddit","podcast"]},"url":{"type":"string","format":"uri"}},"required":["type","url"],"additionalProperties":false}}],"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: { \"x\": \"https://x.com/mintlify\" }"},"links":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1},"links":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","pattern":"^\\/"}]}},"required":["label","url"],"additionalProperties":false},"minItems":1}},"required":["links"],"additionalProperties":false},"minItems":1,"maxItems":4}},"additionalProperties":false},"background":{"type":"object","properties":{"style":{"type":"string","enum":["gradient","grid","windows"]}},"additionalProperties":false},"backgroundImage":{"type":"string"},"font":{"anyOf":[{"type":"object","properties":{"family":{"type":"string","description":"The font family, such as \"Open Sans\", \"Playfair Display\""},"weight":{"type":"number","description":"The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts."},"url":{"type":"string","format":"uri","description":"The font url, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2"},"format":{"type":"string","enum":["woff","woff2"],"description":"The font format, can be one of woff, woff2"}},"required":["family"],"additionalProperties":false},{"type":"object","properties":{"headings":{"$ref":"#/definitions/Schema/properties/font/anyOf/0"},"body":{"$ref":"#/definitions/Schema/properties/font/anyOf/0"}},"additionalProperties":false}]},"feedback":{"type":"object","properties":{"thumbsRating":{"type":"boolean"},"suggestEdit":{"type":"boolean"},"raiseIssue":{"type":"boolean"}},"additionalProperties":false},"analytics":{"type":"object","properties":{"adobe":{"type":"object","properties":{"launchUrl":{"type":"string","format":"uri"}},"required":["launchUrl"],"additionalProperties":false},"amplitude":{"type":"object","properties":{"apiKey":{"type":"string"}},"required":["apiKey"],"additionalProperties":false},"clarity":{"type":"object","properties":{"projectId":{"type":"string"}},"required":["projectId"],"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},"hightouch":{"type":"object","properties":{"writeKey":{"type":"string"},"apiHost":{"type":"string"}},"required":["writeKey"],"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"},"region":{"type":"string","enum":["us","eu","in"]}},"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"},"sessionRecording":{"type":"boolean"}},"required":["apiKey"],"additionalProperties":false},"plausible":{"type":"object","properties":{"domain":{"type":"string"},"server":{"type":"string"}},"required":["domain"],"additionalProperties":false},"segment":{"type":"object","properties":{"key":{"type":"string"},"cdnUrl":{"type":"string","format":"uri"}},"required":["key"],"additionalProperties":false}},"additionalProperties":false},"integrations":{"type":"object","properties":{"intercom":{"type":"string","minLength":6},"frontchat":{"type":"string","minLength":6}},"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},"footerSocials":{"$ref":"#/definitions/Schema/properties/footer/properties/socials","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: { \"x\": \"https://x.com/mintlify\" }"}},"required":["name","favicon","colors","navigation"],"additionalProperties":false}},"$schema":"http://json-schema.org/draft-07/schema#"}