BigOven · Example Payload

Note_Put

Note

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

Top-level fields

operationIdmethodpathtagssummaryparametersrequestBodyresponse

Example Payload

Raw ↑ 
{
  "operationId": "Note_Put",
  "method": "PUT",
  "path": "/recipe/{recipeId}/note/{noteId}",
  "tags": [
    "Note"
  ],
  "summary": "HTTP PUT (update) a Recipe note (RecipeNote).",
  "parameters": [
    {
      "name": "recipeId",
      "in": "path",
      "required": true,
      "description": "",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "noteId",
      "in": "path",
      "required": true,
      "description": "",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "$ref": "#/components/schemas/API2.Controllers.WebAPI.NoteController.NoteRequest"
    }
  },
  "response": {
    "status": 200,
    "contentType": "application/json",
    "schema": {
      "$ref": "#/components/schemas/BigOven.Model.API.RecipeNote"
    }
  }
}