Event Photo Upload Policy

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An event photo upload policy.",
  "properties": {
    "expiration": {
      "description": "The generated policy is valid until this time.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "maxFileSize": {
      "description": "The maximum file size in bytes allowed for upload.",
      "readOnly": true,
      "type": "integer"
    },
    "postParams": {
      "description": "Parameters that must be included as parameters in the upload\nrequest.\n\nIn general, these parameter should be sent, unmodified, with the\nrequest. The exception is when any of the values contain a template\nvariables, as noted.",
      "properties": {
        "AWSAccessKeyId": {
          "description": "The AWS Access Key ID for the `.uploadUrl`.",
          "type": "string"
        },
        "Content-Type": {
          "description": "The media type of the file to be uploaded.",
          "enum": [
            "image/jpeg"
          ],
          "type": "string"
        },
        "acl": {
          "description": "The AWS access control level to be used for the upload.",
          "enum": [
            "private"
          ],
          "type": "string"
        },
        "key": {
          "description": "The storage key for the file, to be used by the `.uploadUrl` for\nstoring the uploaded image.\n\nThis value contains the template variable `${random_folder}`\nwhich must be a random 32-character hexadecimal value generated\nby the client and replaced before sending the request to the\n`.uploadUrl`.\n\nThis value also contains the template variable `${filename}`,\nwhich MUST NOT be replaced and should remain intact when sending\nthe request to the `.uploadUrl`.",
          "type": "string"
        },
        "policy": {
          "description": "The encoded policy document generated for the upload request.",
          "type": "string"
        },
        "signature": {
          "description": "The encoded signature to send with the request to `.uploadUrl`.",
          "type": "string"
        },
        "success_action_status": {
          "description": "The HTTP status code expected in a successful response from the\nrequest to `.uploadUrl'.",
          "enum": [
            201
          ],
          "type": "integer"
        }
      },
      "readOnly": true,
      "required": [
        "AWSAccessKeyId",
        "key",
        "acl",
        "Content-Type",
        "policy",
        "success_action_status",
        "signature"
      ],
      "type": "object"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "event-photo-upload-policy"
      ],
      "readOnly": true,
      "type": "string"
    },
    "uploadUrl": {
      "description": "The URL to which a POST request may be made to upload an image for\nthe event.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "type",
    "maxFileSize",
    "uploadUrl",
    "postParams"
  ],
  "title": "Event Photo Upload Policy",
  "type": "object"
}