Struct PageUpdate

pub struct PageUpdate {
    pub content_update: Option<PageUpdateContentUpdate>,
    pub icon_name: Option<String>,
    pub image_url: Option<String>,
    pub is_hidden: Option<bool>,
    pub name: Option<String>,
    pub subtitle: Option<String>,
}

Payload for updating a page.

JSON schema

{
 "description": "Payload for updating a page.",
 "type": "object",
 "properties": {
   "contentUpdate": {
     "allOf": [
       {
         "description": "Content with which to update an existing
page.",
         "type": "object",
         "additionalProperties": false
       },
       {
         "$ref": "#/components/schemas/PageContentUpdate"
       }
     ]
   },
   "iconName": {
     "description": "Name of the icon.",
     "examples": [
       "rocket"
     ],
     "type": "string"
   },
   "imageUrl": {
     "description": "Url of the cover image to use.",
     "examples": [
       "https://example.com/image.jpg"
     ],
     "type": "string"
   },
   "isHidden": {
     "description": "Whether the page is hidden or not. Note that for
pages that cannot be hidden, like the sole top-level page in a doc, this
will be ignored.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "name": {
     "description": "Name of the page.",
     "examples": [
       "Launch Status"
     ],
     "type": "string"
   },
   "subtitle": {
     "description": "Subtitle of the page.",
     "examples": [
       "See the status of launch-related tasks."
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "PageUpdate"
}

Fields

content_update: Option<PageUpdateContentUpdate>

icon_name: Option<String>

Name of the icon.

image_url: Option<String>

Url of the cover image to use.

is_hidden: Option<bool>

Whether the page is hidden or not. Note that for pages that cannot be hidden, like the sole top-level page in a doc, this will be ignored.

name: Option<String>

Name of the page.

subtitle: Option<String>

Subtitle of the page.

Trait Implementations

impl Clone for PageUpdate

fn clone(&self) -> PageUpdate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PageUpdate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PageUpdate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PageUpdate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PageUpdate> for PageUpdate

fn from(value: &PageUpdate) -> Self

Converts to this type from the input type.

impl Serialize for PageUpdate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.