Replace a meal

PUT

/api/v1/meals/{id}

const url = 'http://127.0.0.1:8080/api/v1/meals/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"date":"example","dishes":[{"display_name":"example","entry_id":"example","id":"example","leftover_of":"example","notes":"example","plain_items":[{"id":"example","name":"example","quantity":"example"}],"recipe_revision":1,"scale":"example"}],"meal_type":"","name":"example","notes":"example","skipped":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url http://127.0.0.1:8080/api/v1/meals/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "date": "example", "dishes": [ { "display_name": "example", "entry_id": "example", "id": "example", "leftover_of": "example", "notes": "example", "plain_items": [ { "id": "example", "name": "example", "quantity": "example" } ], "recipe_revision": 1, "scale": "example" } ], "meal_type": "", "name": "example", "notes": "example", "skipped": true }'

Authorizations

bearerToken
browserSession

Parameters

Path Parameters

required

string

Header Parameters

If-Match

string

Request Body^required

application/json

object

date

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

dishes

required

Array<object> | null

>= 1 items <= 50 items

object

display_name

required

string

>= 1 characters <= 200 characters

entry_id

string

leftover_of

string

<= 201 characters

notes

string

<= 5000 characters

plain_items

Only for a dish without entry_id.

Array<object> | null

<= 100 items

object

string

name

required

string

>= 1 characters <= 200 characters

quantity

string

<= 200 characters

recipe_image_url

string

recipe_revision

integer format: int64

>= 1

recipe_status

string

Allowed values: available trashed removed

scale

string

<= 100 characters

shopping_choices

Array<string> | null

meal_type

string

Allowed values: "" breakfast lunch dinner snack

name

string

<= 200 characters

notes

string

<= 10000 characters

skipped

boolean

Responses

200

application/json

object

created_at

required

string format: date-time

created_by

string

created_by_name

string

date

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

dishes

required

Array<object> | null

>= 1 items <= 50 items

object

display_name

required

string

>= 1 characters <= 200 characters

entry_id

string

leftover_of

string

<= 201 characters

notes

string

<= 5000 characters

plain_items

Only for a dish without entry_id.

Array<object> | null

<= 100 items

object

string

name

required

string

>= 1 characters <= 200 characters

quantity

string

<= 200 characters

recipe_image_url

string

recipe_revision

integer format: int64

>= 1

recipe_status

string

Allowed values: available trashed removed

scale

string

<= 100 characters

shopping_choices

Array<string> | null

display_title

required

string

required

string

meal_type

string

Allowed values: "" breakfast lunch dinner snack

name

string

<= 200 characters

notes

string

<= 10000 characters

revision

required

integer format: int64

>= 1

skipped

required

boolean

updated_at

required

string format: date-time

updated_by

string

updated_by_name

string

key

additional properties

any

Example

{
  "dishes": [
    {
      "recipe_status": "available"
    }
  ],
  "meal_type": ""
}

Headers

ETag

Validates this representation, including the recipe and shopping details it reads. If-Match takes the revision instead.

string

Location

string

400

Bad Request

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

401

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

application/problem+json

object

code

required

string

detail

required

string

status

required

integer format: int64

title

required

string

type

required

string

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not Found

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

412

Precondition Failed

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

422

Unprocessable Entity

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

428

Precondition Required

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

500

Internal Server Error

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Replace a meal

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

Headers

400

Example

401

Examplegenerated

404

Example

412

Example

422

Example

428

Example

500

Example

Request Body^required

Example^generated