Content
View differences
Updated by Robin Wagner over 5 years ago
**As** a developer
**I want** to know when an API endpoint expects a payload
**so that** I can make sure to properly get the most out of the API
**Acceptance criteria**
- Link objects specify whether they expect a payload to be transmitted
- This doesn’t have to be realised via the existing payload attribute
- A separate (boolean) attribute can be sufficient.
- Link objects which use the HTTP verbs GET or DELETE cannot receive a payload and therefore don’t necessarily need to specify that they do not expect one.
- This should be explained at a rather prominent position within the API documentation.
**I want** to know when an API endpoint expects a payload
**so that** I can make sure to properly get the most out of the API
**Acceptance criteria**
- Link objects specify whether they expect a payload to be transmitted
- This doesn’t have to be realised via the existing payload attribute
- A separate (boolean) attribute can be sufficient.
- Link objects which use the HTTP verbs GET or DELETE cannot receive a payload and therefore don’t necessarily need to specify that they do not expect one.
- This should be explained at a rather prominent position within the API documentation.