# Feature OP-2011 - [API] Specify expectance of Payload

Project: OpenProject
Status: new
URL: https://community.openproject.org/work_packages/OP-2011

## Planning

| Attribute | Value |
| --- | --- |
| Date |  |
| Priority | Medium |
| Target versions | Wish List |
| Sprint |  |
| Backlog bucket |  |
| Votes | 1 |
| List |  |
| Roadmap |  |
| Relevance |  |

## OPEN POINTS / FEEDBACK

_No work packages_

## Features and Chunks

_No work packages_

## Bugs and other work packages

_No work packages_

## Technical Details

| Attribute | Value |
| --- | --- |
| Module |  |
| Feature Flag |  |
| Requires doc change | No |
| Enterprise plan |  |

## Details

| Attribute | Value |
| --- | --- |
| Pull preview |  |
| Mockups |  |
| Accessibility | No |

## People

| Attribute | Value |
| --- | --- |
| Assignee |  |
| Accountable |  |
| Product manager |  |
| Feature Lead |  |
| Developers |  |
| Designer |  |
| Ordered by |  |
| Signed off by |  |
| Interest by |  |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| PD (min) |  |
| PD (max) |  |
| Work |  |
| Labor costs |  |

## Description

**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.
