You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/components/schemas.yaml
+14-6Lines changed: 14 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -384,7 +384,7 @@ Role:
384
384
items:
385
385
type: string
386
386
readOnly: true
387
-
$ref: "#/CollectionAccessConfig"
387
+
$ref: '#/CollectionAccessConfig'
388
388
title: Role
389
389
User-session-information:
390
390
type: object
@@ -407,6 +407,7 @@ User-session-information:
407
407
description: A map of the channels in the default collection that the user is in along with the sequence number the user was granted access. This does not include inherited channels through roles.
408
408
type: object
409
409
additionalProperties:
410
+
x-additionalPropertiesName: channelName
410
411
type: number
411
412
minimum: 1
412
413
description: The sequence number the user was granted access.
@@ -2116,13 +2117,13 @@ Startup-config:
2116
2117
2117
2118
By default, this will only be accessible to the localhost.
2118
2119
type: string
2119
-
default: "127.0.0.1:4985"
2120
+
default: '127.0.0.1:4985'
2120
2121
admin_interface_authentication:
2121
2122
description: Whether the admin API requires authentication
2122
2123
type: boolean
2123
2124
default: true
2124
2125
compress_responses:
2125
-
description: "If false, disables compression of HTTP responses"
2126
+
description: 'If false, disables compression of HTTP responses'
2126
2127
type: boolean
2127
2128
default: true
2128
2129
cors:
@@ -3162,7 +3163,7 @@ IndexInitStatus:
3162
3163
"error": The index creation operation has failed.
3163
3164
settings:
3164
3165
allOf:
3165
-
- $ref: "#/IndexSettings"
3166
+
- $ref: '#/IndexSettings'
3166
3167
required:
3167
3168
- status
3168
3169
- start_time
@@ -3180,11 +3181,18 @@ CORS:
3180
3181
type: array
3181
3182
items:
3182
3183
type: string
3184
+
example:
3185
+
- Accept-Encoding
3186
+
- Authorization
3187
+
- Content-Type
3188
+
- If-Match
3183
3189
login_origin:
3184
3190
description: |-
3185
-
List of allowed origins to apply to public /{db}/_session API.
3191
+
List of allowed origins to apply to public `/{db}/_session` API.
3186
3192
3187
3193
To use cors on `/{db}/_sesssion`, the domain must be present in both `login_origin` and `origin`.
3194
+
3195
+
If configured, `Authorization` must be included in headers.
3188
3196
type: array
3189
3197
items:
3190
3198
type: string
@@ -3195,7 +3203,7 @@ CORS:
3195
3203
default: 0
3196
3204
origin:
3197
3205
description: |-
3198
-
List of allowed origins, use `['*']` to allow access from everywhere.
Copy file name to clipboardExpand all lines: docs/api/paths/public/db-_session.yaml
+10-12Lines changed: 10 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -28,21 +28,19 @@ post:
28
28
If `Origin` header is passed to this endpoint, the `Origin` header must match both the `cors.login_origin` and `cors.origin` configuration options.
29
29
requestBody:
30
30
description: The body can be used to override the credentials of the authenticating user, or blank if getting a user session for the authenticating user.
31
+
required: false
31
32
content:
32
33
application/json:
33
34
schema:
34
-
oneOf:
35
-
- type: "null"
36
-
title: "Empty Body"
37
-
- type: object
38
-
title: "User Credentials"
39
-
properties:
40
-
name:
41
-
description: User name to generate the session for.
42
-
type: string
43
-
password:
44
-
description: Password of the user to generate the session for.
45
-
type: string
35
+
type: object
36
+
title: "User Credentials"
37
+
properties:
38
+
name:
39
+
description: User name to generate the session for. Omit this value to use the authenticating user's credentials.
40
+
type: string
41
+
password:
42
+
description: Password of the user to generate the session for. Omit this value to use the authenticating user's credentials.
0 commit comments