API extension template

This is the template to fill for each API extension.

Use a proper descriptive name for the API request.

Type of change

  • API Clarification: Explicit the result of some API endpoints (like search3 with empty queries)
  • API tweak: Add new parameter or new result fields to actual API endpoints
  • API extension: Add new API endpoints

Proposal description

Explain the proposal in details. What it adds, why it’s needed, who will benefit.

Backward compatibility impact

Explain if the proposal can have backward compatibility impacts. Currently it’s better to propose new endpoints than breaking this.

API details

Describe the actual API (endpoint, parameters, return value)

Security impacts

Potential issues

Alternative solutions

Proposal status

Proposed / In review / Accepted / Implemented

Server implementation status