From f44df2ada475452501192da1048fc388f1606b79 Mon Sep 17 00:00:00 2001 From: Kipras Melnikovas Date: Fri, 5 Feb 2021 22:44:25 +0200 Subject: [PATCH] docs: add `nativeAuth` instantiating option Signed-off-by: Kipras Melnikovas --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e985ffdb3..f7a32773d 100644 --- a/README.md +++ b/README.md @@ -132,20 +132,21 @@ const api = new Gitlab({ Available instantiating options: -| Name | Optional | Default | Description | -| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -| `host` | Yes | `https://gitlab.com` | Gitlab Instance Host URL | -| `token` | No\* | N/A | Personal Token. Required (one of the three tokens are required) | -| `oauthToken` | No\* | N/A | OAuth Token. Required (one of the three tokens are required) | -| `jobToken` | No\* | N/A | CI Job Token. Required (one of the three tokens are required) | -| `rejectUnauthorized` | Yes | `true` | Http Certificate setting, Only applies to HTTPS hosts urls | -| `sudo` | Yes | `false` | [Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter | -| `version` | Yes | `4` | API Version ID | -| `camelize` | Yes | `false` | Camelizes all response body keys | -| `requester` | Yes\* | @gitbeaker/node & @gitbeaker/cli : Got-based, @gitbeaker/browser: Ky-based. The @gitbeaker/core package **does not** have a default and thus must be set explicitly | Request Library Wrapper | | -| `requestTimeout` | Yes | `300000` | Request Library Timeout in ms | -| `profileToken` | Yes | N/A | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) | -| `profileMode` | Yes | `execution` | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) | +| Name | Optional | Default | Description | +| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | +| `host` | Yes | `https://gitlab.com` | Gitlab Instance Host URL | +| `token` | No\* | N/A | Personal Token. Required (one of the four tokens are required) | +| `oauthToken` | No\* | N/A | OAuth Token. Required (one of the four tokens are required) | +| `jobToken` | No\* | N/A | CI Job Token. Required (one of the four tokens are required) | +| `nativeAuth` | No\* | 
{
 "gitlabSessionCookieKey": "\_gitlab_session",
 "gitlabSessionCookieValue": undefined,
 "gitlabCSRFTokenKey": "authenticity_token",
 "gitlabCSRFTokenValue": undefined
 }
| Browser-native auth object. `undefined` values required (one of the four tokens are required) | +| `rejectUnauthorized` | Yes | `true` | Http Certificate setting, Only applies to HTTPS hosts urls | +| `sudo` | Yes | `false` | [Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter | +| `version` | Yes | `4` | API Version ID | +| `camelize` | Yes | `false` | Camelizes all response body keys | +| `requester` | Yes\* | @gitbeaker/node & @gitbeaker/cli : Got-based, @gitbeaker/browser: Ky-based. The @gitbeaker/core package **does not** have a default and thus must be set explicitly | Request Library Wrapper | | +| `requestTimeout` | Yes | `300000` | Request Library Timeout in ms | +| `profileToken` | Yes | N/A | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) | +| `profileMode` | Yes | `execution` | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) | ### CLI Support