Keep response contracts consistent

text

List endpoints should return a predictable structure for data, pagination, and errors.

Explanation

Consistency lowers cognitive load and makes SDKs, docs, and client code easier to maintain.

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Same sheet · prioritizing Best practices

Make support and debugging easier.

Open In sheethttpsame section

Prefer explicit timezone-aware datetime strings.

Open In sheettextsame section

Help clients back off safely.

Open In sheethttpsame section

Show real requests and responses in docs.

Open In sheetbashsame section

Avoid route names that duplicate the HTTP method.

Open In sheettext1 tag match

Use HTTP status codes meaningfully.

Open In sheettext1 tag match