BigOven · Example Payload

Images_Uploadrecipeimage

Images

Images_Uploadrecipeimage is an example object payload from BigOven, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathtagssummaryparametersresponse

Example Payload

Raw ↑ 
{
  "operationId": "Images_UploadRecipeImage",
  "method": "POST",
  "path": "/recipe/{recipeId}/image",
  "tags": [
    "Images"
  ],
  "summary": "POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption\r\n             \r\n             Note that caption, lng and lat are all optional, but must go on the request URI as params because this endpoint\r\n             needs a multipart/mime content header and will not parse JSON in the body along with it.\r\n            \r\n             Testing with Postman (validated 11/20/2015):\r\n             1) Remove the Content-Type header; add authentication information\r\n             2) On the request, click Body and choose \"form-data\", then add a line item with \"key\" column set to \"file\" and on the right,\r\n             change the type of the input from Text to File.  Browse and choose a JPG.",
  "parameters": [
    {
      "name": "recipeId",
      "in": "path",
      "required": true,
      "description": "",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "caption",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "lat",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "format": "double",
        "type": "number"
      }
    },
    {
      "name": "lng",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "format": "double",
        "type": "number"
      }
    }
  ],
  "response": {
    "status": 200,
    "contentType": "application/json",
    "schema": {
      "$ref": "#/components/schemas/System.Object"
    }
  }
}