This repository has been archived by the owner on May 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Resource Actions
Jon Ursenbach edited this page Jan 4, 2020
·
3 revisions
@annotation | Description |
---|---|
@api-contenttype | Denotes the Content-Type returned. |
@api-error | An exception or error that may be returned on the action. |
@api-group | Name of the group that the action should be grouped under when generating documentation. |
@api-label | Short description of what the resource action handles. |
@api-maxversion | Maximum version required for this action. |
@api-minversion | Minimum version required for this action. |
@api-param | A request parameter for this action that can be supplied in a body payload. |
@api-operationid | A unique identifier for a resource action. |
@api-path | Denotes a path that this action services. |
@api-pathparam | Describes parameters for the path. |
@api-queryparam | A request parameter for this action that can be supplied in a query string. |
@api-return | A representation that is returned in a request. |
@api-scope | Required authentication token scope necessary for the action. |
@api-vendortag | Vendor tag for specifying additional metadata on the action. |