DatoCMS client v0.2.3 DatoCMS.Client.Site
Summary
Functions
Calls GET /site
params
is added to the URL as query parameters.
params Schema
{
"properties": {
"include": {
"additionalItems": true,
"description": "Type of data to include",
"example": [
"item_types"
],
"items": {
"type": "string"
},
"minItems": 0,
"type": [
"array"
]
}
},
"type": [
"object"
]
}
Calls PUT /site
params
is JSON encoded and passed as the request body.
params Schema
{
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": false,
"properties": {
"attributes": {
"additionalProperties": false,
"properties": {
"favicon": {
"properties": {
"format": {
"description": "Image format",
"enum": [
"png",
"jpg",
"gif"
],
"example": "png",
"type": [
"string"
]
},
"height": {
"description": "Image height",
"example": 500,
"type": [
"integer"
]
},
"path": {
"description": "The S3 path where the file is stored",
"example": "/7/1455102967-image.png",
"type": [
"string"
]
},
"size": {
"description": "The size of the image in bytes",
"example": 424112,
"type": [
"integer"
]
},
"width": {
"description": "Image width",
"example": 400,
"type": [
"integer"
]
}
},
"required": [
"path",
"width",
"height",
"format",
"size"
],
"type": [
"null",
"object"
]
},
"frontend_url": {
"description": "Specifies the URL of the generated static website",
"example": "https://www.my-awesome-website.com",
"type": [
"string",
"null"
]
},
"global_seo": {
"description": "Specifies default global settings",
"properties": {
"facebook_page_url": {
"description": "URL of facebook page",
"example": "http://facebook.com/awesomewebsite",
"type": [
"null",
"string"
]
},
"fallback_seo": {
"properties": {
"description": {
"example": "Default meta description",
"type": [
"string"
]
},
"image": {
"properties": {
"format": {
"description": "Image format",
"enum": [
"png",
"jpg",
"gif"
],
"example": "png",
"type": [
"string"
]
},
"height": {
"description": "Image height",
"example": 500,
"type": [
"integer"
]
},
"path": {
"description": "The S3 path where the file is stored",
"example": "/7/1455102967-image.png",
"type": [
"string"
]
},
"size": {
"description": "The size of the image in bytes",
"example": 424112,
"type": [
"integer"
]
},
"width": {
"description": "Image width",
"example": 400,
"type": [
"integer"
]
}
},
"required": [
"path",
"width",
"height",
"format",
"size"
],
"type": [
"object",
"null"
]
},
"title": {
"example": "Default meta title",
"type": [
"string"
]
}
},
"required": [
"title",
"description",
"image"
],
"type": [
"object"
]
},
"site_name": {
"description": "Site name, used in social sharing",
"example": "My Awesome Website",
"type": [
"string"
]
},
"title_suffix": {
"description": "Title meta tag suffix",
"example": " - My Awesome Website",
"type": [
"null",
"string"
]
},
"twitter_account": {
"description": "Twitter account associated to website",
"example": "@awesomewebsite",
"type": [
"null",
"string"
]
}
},
"type": [
"object",
"null"
]
},
"locales": {
"additionalItems": true,
"description": "Available locales",
"example": [
"en"
],
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"name": {
"description": "Site name",
"example": "My Awesome Website",
"type": "string"
},
"no_index": {
"description": "Whether the website needs to be indexed by search engines or not",
"example": true,
"type": "boolean"
},
"production_deploy_adapter": {
"description": "Specify the deploy adapter to use",
"example": "travis",
"type": [
"string",
"null"
]
},
"production_deploy_settings": {
"description": "Specify the deploy adapter options",
"example": {
"api_token": "XXXYYY",
"branch": "master",
"config": null,
"repo": "stefanoverna/sample-datocms-hugo-portfolio"
},
"type": [
"object",
"null"
]
},
"ssg": {
"description": "Specifies static site generator used",
"example": "hugo",
"type": [
"null",
"string"
]
},
"staging_deploy_adapter": {
"description": "Specify the deploy adapter to use",
"example": "travis",
"type": [
"string",
"null"
]
},
"staging_deploy_settings": {
"description": "Specify the deploy adapter options",
"example": {
"api_token": "XXXYYY",
"branch": "master",
"config": null,
"repo": "stefanoverna/sample-datocms-hugo-portfolio"
},
"type": [
"object",
"null"
]
},
"theme_hue": {
"description": "Specifies the hue to use primary color in Site backend",
"example": 167,
"type": "integer"
},
"timezone": {
"description": "Site default timezone",
"example": "Europe/London",
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "ID of site",
"example": "155",
"type": "string"
},
"type": {
"description": "JSON API type field",
"example": "site",
"pattern": "^site$",
"type": [
"string"
]
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}