Struct UpdatePackRequest

Source

pub struct UpdatePackRequest {
    pub cover_asset_id: Option<String>,
    pub description: Option<UpdatePackRequestDescription>,
    pub example_images: Option<Vec<UpdatePackRequestExampleImagesItem>>,
    pub logo_asset_id: Option<String>,
    pub name: Option<UpdatePackRequestName>,
    pub overall_rate_limit: Option<UpdatePackRequestOverallRateLimit>,
    pub per_connection_rate_limit: Option<UpdatePackRequestPerConnectionRateLimit>,
    pub privacy_policy_url: Option<String>,
    pub short_description: Option<UpdatePackRequestShortDescription>,
    pub source_code_visibility: Option<PackSourceCodeVisibility>,
    pub support_email: Option<UpdatePackRequestSupportEmail>,
    pub terms_of_service_url: Option<String>,
}

Expand description

Payload for updating a Pack.

JSON schema

{
 "description": "Payload for updating a Pack.",
 "type": "object",
 "properties": {
   "coverAssetId": {
     "description": "The asset id of the Pack's cover image, returned by
[`#PackAssetUploadComplete`](#operation/packAssetUploadComplete)
endpoint.",
     "type": [
       "string",
       "null"
     ]
   },
   "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",
       "null"
     ],
     "items": {
       "type": "object",
       "required": [
         "assetId",
         "filename"
       ],
       "properties": {
         "assetId": {
           "description": "The asset id of the Pack's example image,
returned by
[`#PackAssetUploadComplete`](#operation/packAssetUploadComplete)
endpoint.",
           "type": "string"
         },
         "filename": {
           "description": "The filename for the image.",
           "type": "string"
         },
         "mimeType": {
           "description": "The media type of the image being sent.",
           "examples": [
             "image/jpeg"
           ],
           "type": "string"
         }
       },
       "additionalProperties": false
     }
   },
   "logoAssetId": {
     "description": "The asset id of the Pack's logo, returned by
[`#PackAssetUploadComplete`](#operation/packAssetUploadComplete)
endpoint.",
     "type": [
       "string",
       "null"
     ]
   },
   "name": {
     "description": "The name of the Pack.",
     "examples": [
       "Cool Geometry Formulas"
     ],
     "type": "string",
     "maxLength": 128
   },
   "overallRateLimit": {
     "description": "Rate limit in Pack settings.",
     "type": [
       "object",
       "null"
     ],
     "required": [
       "intervalSeconds",
       "operationsPerInterval"
     ],
     "properties": {
       "intervalSeconds": {
         "description": "The rate limit interval in seconds.",
         "examples": [
           3600
         ],
         "type": "integer",
         "maximum": 86400.0,
         "minimum": 1.0
       },
       "operationsPerInterval": {
         "description": "The maximum number of Pack operations that can
be performed in a given interval.",
         "examples": [
           20
         ],
         "type": "integer",
         "minimum": 0.0
       }
     },
     "additionalProperties": false,
     "x-schema-name": "PackRateLimit"
   },
   "perConnectionRateLimit": {
     "description": "Rate limit in Pack settings.",
     "type": [
       "object",
       "null"
     ],
     "required": [
       "intervalSeconds",
       "operationsPerInterval"
     ],
     "properties": {
       "intervalSeconds": {
         "description": "The rate limit interval in seconds.",
         "examples": [
           3600
         ],
         "type": "integer",
         "maximum": 86400.0,
         "minimum": 1.0
       },
       "operationsPerInterval": {
         "description": "The maximum number of Pack operations that can
be performed in a given interval.",
         "examples": [
           20
         ],
         "type": "integer",
         "minimum": 0.0
       }
     },
     "additionalProperties": false,
     "x-schema-name": "PackRateLimit"
   },
   "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
   }
 },
 "additionalProperties": false,
 "x-schema-name": "UpdatePackRequest"
}