@api‐path

This allows you to describe the path(s) that a resource action services.

Syntax

@api-path:visibility path

Requirements

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

Breakdown

Tag	Optional	Description
path	×	This is the path that the resource action services. It's recommended that these conform to RFC 3986 and RFC 6570.

Examples

/**
 * Update a movies data.
 *
 * @api-label Update a movie.
 * @api-operationid updateMovie
 * @api-group Movies
 *
 * @api-path:public /movies/+id
 * @api-pathparam id `1234` (integer) - Movie ID

 * @api-path:private:deprecated /movie/+id
 *
 * ...
 */
public function PATCH()
{
    ...
}