Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apidocs: add missing authentication-related parameters #3607

Merged
merged 1 commit into from
Aug 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
60 changes: 40 additions & 20 deletions apidocs/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading