Add credentials field to docs

igorkamyshev · Apr 10, 2024 · 39b2a54 · 39b2a54
1 parent 3ef1ad1
commit 39b2a54
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/apps/website/docs/api/factories/create_json_mutation.md b/apps/website/docs/api/factories/create_json_mutation.md
@@ -18,6 +18,10 @@ Config fields:
   - `body`: _[Sourced](/api/primitives/sourced) Json_, any value which can be serialized to JSON and parsed back without loses by JavaScript native module JSON. For example, `{ a: 1, b: 2 }`. Note that body cannot be used in `GET` and `HEAD` requests.
   - `query?`: _[Sourced](/api/primitives/sourced) object_, keys of the object must be `String` and values must be `String` or `Array<String>` or (since v0.8) _[Sourced](/api/primitives/sourced) String_ containing ready-to-use query string
   - `headers?`: _[Sourced](/api/primitives/sourced) object_, keys of the object must be `String` and values must be `String` or `Array<String>`
+  - `credentials?`: _String_, [available values](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials):
+    - `omit` — do not include credentials
+    - `same-origin` — include credentials only if the request URL is the same origin
+    - `include` — include credentials on all requests
 
 - `response`: declarative rules to handle response from the API.
 

diff --git a/apps/website/docs/api/factories/create_json_query.md b/apps/website/docs/api/factories/create_json_query.md
@@ -20,6 +20,10 @@ Config fields:
   - `body`: _[Sourced](/api/primitives/sourced) Json_, any value which can be serialized to JSON and parsed back without loses by JavaScript native module JSON. For example, `{ a: 1, b: 2 }`. Note that body cannot be used in `GET` and `HEAD` requests.
   - `query?`: _[Sourced](/api/primitives/sourced) object_, keys of the object must be `String` and values must be `String` or `Array<String>` or (since v0.8) _[Sourced](/api/primitives/sourced) String_ containing ready-to-use query string
   - `headers?`: _[Sourced](/api/primitives/sourced) object_, keys of the object must be `String` and values must be `String` or `Array<String>`
+  - `credentials?`: _String_, [available values](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials):
+    - `omit` — do not include credentials
+    - `same-origin` — include credentials only if the request URL is the same origin
+    - `include` — include credentials on all requests
 
 - `response`: declarative rules to handle response from the API.