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

@api‐group

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

The @api-group annotation represents the name of the group that the action it's attached to should be grouped under when generating documentation.

Syntax

@api-group groupName

Requirements

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

Breakdown

Tag Optional Description
groupName × Group name

Examples

On a resource action:

/**
 * @api-label Update data on a group of users.
 * @api-operationid updateUsers
 * @api-group Users
 *
 * @api-path:public /users
 *
 * ...
 */
public function PATCH()
{
    ...
}