Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

@api‐minversion

Jon Ursenbach edited this page Jan 4, 2020 · 1 revision

This allows you to denote the minimum API version required for a resource action.

Syntax

@api-minversion version

Requirements

Required? Needs a visibility Supports versioning Supports deprecation
× × × ×

Breakdown

Tag Optional Description
version × A specific, minimum API version required for a resource action.

Examples

/**
 * @api-label Update a movie.
 * @api-operationid updateMovie
 * @api-group Movies
 *
 * @api-path:public /movies/+id
 * @api-pathparam id (integer) - Movie ID
 *
 * @api-minversion 3.2
 *
 * @api-error:private 403 (\Some\ErrorErrorRepresentation) - If the user isn't
 *    allowed to do something.
 */
public function PATCH()
{
    ...
}