Struct DocPublish

pub struct DocPublish {
    pub category_names: Vec<String>,
    pub discoverable: Option<bool>,
    pub earn_credit: Option<bool>,
    pub mode: Option<DocPublishMode>,
    pub slug: Option<String>,
}

Payload for publishing a doc or or updating its publishing information.

JSON schema

{
 "description": "Payload for publishing a doc or or updating its
publishing information.",
 "type": "object",
 "properties": {
   "categoryNames": {
     "description": "The names of categories to apply to the document.",
     "examples": [
       [
         "Project management"
       ]
     ],
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "discoverable": {
     "description": "If true, indicates that the doc is discoverable.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "earnCredit": {
     "description": "If true, new users may be required to sign in to
view content within this document. You will receive Coda credit for each
user who signs up via your doc.\n",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "mode": {
     "$ref": "#/components/schemas/DocPublishMode"
   },
   "slug": {
     "description": "Slug for the published doc.",
     "examples": [
       "my-doc"
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "DocPublish"
}

Fields

category_names: Vec<String>

The names of categories to apply to the document.

discoverable: Option<bool>

If true, indicates that the doc is discoverable.

earn_credit: Option<bool>

If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.

mode: Option<DocPublishMode>

slug: Option<String>

Slug for the published doc.

Trait Implementations

impl Clone for DocPublish

fn clone(&self) -> DocPublish

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocPublish

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

Formats the value using the given formatter.

impl Default for DocPublish

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocPublish

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DocPublish> for DocPublish

fn from(value: &DocPublish) -> Self

Converts to this type from the input type.

impl Serialize for DocPublish

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

where __S: Serializer,

Serialize this value into the given Serde serializer.