DatoCMS client v0.2.3 DatoCMS.Client.MenuItem
Summary
Functions
Calls POST /menu-items
Calls DELETE /menu-items/{(%2Fschemata%2Fmenu_item%23%2Fdefinitions%2Fmenu_item%2Fdefinitions%2Fidentity)}
Calls GET /menu-items/{(%2Fschemata%2Fmenu_item%23%2Fdefinitions%2Fmenu_item%2Fdefinitions%2Fidentity)}
Calls GET /menu-items
Calls PUT /menu-items/{(%2Fschemata%2Fmenu_item%23%2Fdefinitions%2Fmenu_item%2Fdefinitions%2Fidentity)}
Functions
Calls POST /menu-items
params
is JSON encoded and passed as the request body.
params Schema
{
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": false,
"properties": {
"attributes": {
"additionalProperties": false,
"description": "JSON API attributes",
"properties": {
"label": {
"description": "The label of the menu item",
"example": "Posts",
"type": "string"
},
"position": {
"description": "Ordering index",
"example": 1,
"type": "integer"
}
},
"required": [
"label",
"position"
],
"type": "object"
},
"relationships": {
"additionalProperties": false,
"properties": {
"item_type": {
"additionalProperties": false,
"description": "item type associated with the menu item",
"properties": {
"data": {
"anyOf": [
{
"additionalProperties": false,
"description": "JSON API data",
"properties": {
"id": {
"description": "ID of item type",
"example": "44",
"type": "string"
},
"type": {
"description": "JSON API type field",
"example": "item_type",
"pattern": "^item_type$",
"type": [
"string"
]
}
},
"required": [
"type",
"id"
],
"type": "object"
},
{
"type": [
"null"
]
}
]
}
},
"required": [
"data"
],
"type": "object"
},
"parent": {
"additionalProperties": false,
"description": "Parent menu item",
"properties": {
"data": {
"anyOf": [
{
"type": [
"null"
]
},
{
"additionalProperties": false,
"description": "JSON API data",
"properties": {
"id": {
"description": "ID of menu item",
"example": "34",
"type": "string"
},
"type": {
"description": "JSON API type field",
"example": "menu_item",
"pattern": "^menu_item$",
"type": [
"string"
]
}
},
"required": [
"type",
"id"
],
"type": "object"
}
],
"example": null
}
},
"required": [
"data"
],
"type": "object"
}
},
"type": "object"
},
"type": {
"description": "JSON API type field",
"example": "menu_item",
"pattern": "^menu_item$",
"type": [
"string"
]
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
Calls DELETE /menu-items/{(%2Fschemata%2Fmenu_item%23%2Fdefinitions%2Fmenu_item%2Fdefinitions%2Fidentity)}
Calls GET /menu-items/{(%2Fschemata%2Fmenu_item%23%2Fdefinitions%2Fmenu_item%2Fdefinitions%2Fidentity)}
Calls PUT /menu-items/{(%2Fschemata%2Fmenu_item%23%2Fdefinitions%2Fmenu_item%2Fdefinitions%2Fidentity)}
params
is JSON encoded and passed as the request body.
params Schema
{
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": false,
"properties": {
"attributes": {
"additionalProperties": false,
"description": "JSON API attributes",
"properties": {
"label": {
"description": "The label of the menu item",
"example": "Posts",
"type": "string"
},
"position": {
"description": "Ordering index",
"example": 1,
"type": "integer"
}
},
"required": [
"label",
"position"
],
"type": "object"
},
"id": {
"description": "ID of menu item",
"example": "34",
"type": "string"
},
"relationships": {
"additionalProperties": false,
"properties": {
"item_type": {
"additionalProperties": false,
"description": "item type associated with the menu item",
"properties": {
"data": {
"anyOf": [
{
"additionalProperties": false,
"description": "JSON API data",
"properties": {
"id": {
"description": "ID of item type",
"example": "44",
"type": "string"
},
"type": {
"description": "JSON API type field",
"example": "item_type",
"pattern": "^item_type$",
"type": [
"string"
]
}
},
"required": [
"type",
"id"
],
"type": "object"
},
{
"type": [
"null"
]
}
]
}
},
"required": [
"data"
],
"type": "object"
},
"parent": {
"additionalProperties": false,
"description": "Parent menu item",
"properties": {
"data": {
"anyOf": [
{
"type": [
"null"
]
},
{
"additionalProperties": false,
"description": "JSON API data",
"properties": {
"id": {
"description": "ID of menu item",
"example": "34",
"type": "string"
},
"type": {
"description": "JSON API type field",
"example": "menu_item",
"pattern": "^menu_item$",
"type": [
"string"
]
}
},
"required": [
"type",
"id"
],
"type": "object"
}
],
"example": null
}
},
"required": [
"data"
],
"type": "object"
}
},
"type": "object"
},
"type": {
"description": "JSON API type field",
"example": "menu_item",
"pattern": "^menu_item$",
"type": [
"string"
]
}
},
"required": [
"type",
"id",
"attributes",
"relationships"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}