feat: add permission documentation by using a custom decorator

api/dev/Unraid.net/myservers.cfg

@@ -1,5 +1,5 @@
 [api]
-version="4.6.6"
+version="4.4.1"
 extraOrigins="https://google.com,https://test.com"
 [local]
 sandbox="yes"

api/generated-schema.graphql

@@ -2,6 +2,18 @@
 # THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
 # ------------------------------------------------------
 
+"""Directive to document required permissions for fields"""
+directive @usePermissions(
+  """The action verb required for access"""
+  action: AuthActionVerb
+
+  """The resource required for access"""
+  resource: String
+
+  """The possession type required for access"""
+  possession: AuthPossession
+) on FIELD_DEFINITION
+
 type ApiKeyResponse {
   valid: Boolean!
   error: String
@@ -1412,6 +1424,8 @@ type Query {
   services: [Service!]!
   shares: [Share!]!
   vars: Vars!
+
+  """Get information about all VMs on the system"""
   vms: Vms!
   parityHistory: [ParityCheck!]!
   array: UnraidArray!
@@ -1421,6 +1435,7 @@ type Query {
   docker: Docker!
   disks: [Disk!]!
   disk(id: String!): Disk!
+  health: String!
 }
 
 type Mutation {
@@ -1590,4 +1605,19 @@ type Subscription {
   serversSubscription: Server!
   parityHistorySubscription: ParityCheck!
   arraySubscription: UnraidArray!
+}
+
+"""Available authentication action verbs"""
+enum AuthActionVerb {
+  CREATE
+  UPDATE
+  DELETE
+  READ
+}
+
+"""Available authentication possession types"""
+enum AuthPossession {
+  ANY
+  OWN
+  OWN_ANY
 }