Struct PackSummary

Source

pub struct PackSummary {Show 14 fields
    pub categories: Vec<PublishingCategory>,
    pub certified: Option<bool>,
    pub cover_url: Option<String>,
    pub description: PackSummaryDescription,
    pub example_images: Vec<PackImageFile>,
    pub id: f64,
    pub logo_url: Option<String>,
    pub name: PackSummaryName,
    pub privacy_policy_url: Option<String>,
    pub short_description: PackSummaryShortDescription,
    pub source_code_visibility: Option<PackSourceCodeVisibility>,
    pub support_email: Option<PackSummarySupportEmail>,
    pub terms_of_service_url: Option<String>,
    pub workspace_id: String,
}

Expand description

Summary of a Pack.

JSON schema

{
 "description": "Summary of a Pack.",
 "type": "object",
 "required": [
   "categories",
   "description",
   "id",
   "name",
   "shortDescription",
   "workspaceId"
 ],
 "properties": {
   "categories": {
     "description": "Publishing categories associated with this Pack.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/PublishingCategory"
     }
   },
   "certified": {
     "description": "Denotes if the pack is certified by Coda.",
     "type": "boolean"
   },
   "coverUrl": {
     "description": "The link to the cover photo of the Pack.",
     "type": "string",
     "format": "url"
   },
   "description": {
     "description": "The full description of the Pack.",
     "examples": [
       "This Pack allows users to calculate the surface area and volume
of a few common 3D shapes, like cubes and pyramids."
     ],
     "type": "string",
     "maxLength": 8192
   },
   "exampleImages": {
     "description": "The example images for the Pack.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/PackImageFile"
     }
   },
   "id": {
     "description": "ID of the Pack.",
     "examples": [
       1003
     ],
     "type": "number"
   },
   "logoUrl": {
     "description": "The link to the logo of the Pack.",
     "type": "string",
     "format": "url"
   },
   "name": {
     "description": "The name of the Pack.",
     "examples": [
       "Cool Geometry Formulas"
     ],
     "type": "string",
     "maxLength": 128
   },
   "privacyPolicyUrl": {
     "description": "A Privacy Policy URL for the Pack.",
     "type": "string",
     "format": "url",
     "maxLength": 512
   },
   "shortDescription": {
     "description": "A short version of the description of the Pack.",
     "examples": [
       "Calculate cool geometric formulas like surface area."
     ],
     "type": "string",
     "maxLength": 256
   },
   "sourceCodeVisibility": {
     "$ref": "#/components/schemas/PackSourceCodeVisibility"
   },
   "supportEmail": {
     "description": "A contact email for the Pack.",
     "examples": [
       "user@email.com"
     ],
     "type": "string",
     "maxLength": 512
   },
   "termsOfServiceUrl": {
     "description": "A Terms of Service URL for the Pack.",
     "type": "string",
     "format": "url",
     "maxLength": 512
   },
   "workspaceId": {
     "description": "The parent workspace for the Pack.",
     "examples": [
       "ws-asdf"
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "PackSummary"
}