apidocs: add missing authentication-related parameters (#3607)

bluenviron · Aug 4, 2024 · c80bb53 · c80bb53
1 parent 547e56e
commit c80bb53
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1124,7 +1124,7 @@ Authentication can be delegated to an external HTTP server:
 
 ```yml
 authMethod: http
-externalAuthenticationURL: http://myauthserver/auth
+authHTTPAddress: http://myauthserver/auth
 ```
 
 Each time a user needs to be authenticated, the specified URL will be requested with the POST method and this payload:

diff --git a/apidocs/openapi.yaml b/apidocs/openapi.yaml
@@ -21,6 +21,30 @@ components:
         error:
           type: string
 
+    AuthInternalUser:
+      type: object
+      properties:
+        user:
+          type: string
+        pass:
+          type: string
+        ips:
+          type: array
+          items:
+            type: string
+        permissions:
+          type: array
+          items:
+            $ref: '#/components/schemas/AuthInternalUserPermission'
+
+    AuthInternalUserPermission:
+      type: object
+      properties:
+        action:
+          type: string
+        path:
+          type: string
+
     GlobalConf:
       type: object
       properties:
@@ -41,15 +65,29 @@ components:
           type: integer
         udpMaxPayloadSize:
           type: integer
-        externalAuthenticationURL:
-          type: string
         runOnConnect:
           type: string
         runOnConnectRestart:
           type: boolean
         runOnDisconnect:
           type: string
 
+        # Authentication
+        authMethod:
+          type: string
+        authInternalUsers:
+          type: array
+          items:
+            $ref: '#/components/schemas/AuthInternalUser'
+        authHTTPAddress:
+          type: string
+        authHTTPExclude:
+          type: array
+          items:
+            $ref: '#/components/schemas/AuthInternalUserPermission'
+        authJWTJWKS:
+          type: string
+
         # Control API
         api:
           type: boolean
@@ -295,24 +333,6 @@ components:
         recordDeleteAfter:
           type: string
 
-        # Authentication
-        publishUser:
-          type: string
-        publishPass:
-          type: string
-        publishIPs:
-          type: array
-          items:
-            type: string
-        readUser:
-          type: string
-        readPass:
-          type: string
-        readIPs:
-          type: array
-          items:
-            type: string
-
         # Publisher source
         overridePublisher:
           type: boolean