Browse Source

docs(core): Improve docs for Allow decorator

Michael Bromley 4 years ago
parent
commit
2abc4878b7
1 changed files with 5 additions and 2 deletions
  1. 5 2
      packages/core/src/api/decorators/allow.decorator.ts

+ 5 - 2
packages/core/src/api/decorators/allow.decorator.ts

@@ -6,8 +6,11 @@ export const PERMISSIONS_METADATA_KEY = '__permissions__';
 /**
  * @description
  * Attaches metadata to the resolver defining which permissions are required to execute the
- * operation, using one or more {@link Permission} values. Can be applied to top-level queries
- * and mutations as well as field resolvers.
+ * operation, using one or more {@link Permission} values.
+ *
+ * In a GraphQL context, it can be applied to top-level queries and mutations as well as field resolvers.
+ *
+ * For REST controllers, it can be applied to route handlers.
  *
  * @example
  * ```TypeScript