-
-
Notifications
You must be signed in to change notification settings - Fork 299
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: nth attempt with json in markdown html table
Signed-off-by: Kipras Melnikovas <[email protected]>
- Loading branch information
Showing
1 changed file
with
39 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -132,20 +132,45 @@ 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) | | ||
| <table> | ||
|
|
||
| <tr> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "id": 10, | ||
| "username": "alanpartridge", | ||
| "email": "[email protected]", | ||
| "password_hash": "$2a$10$uhUIUmVWVnrBWx9rrDWhS.CPCWCZsyqqa8./whhfzBZydX7yvahHS", | ||
| "password_salt": "$2a$10$uhUIUmVWVnrBWx9rrDWhS.", | ||
| "created_at": "2015-02-14T20:45:26.433Z", | ||
| "updated_at": "2015-02-14T20:45:26.540Z" | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| </tr> | ||
|
|
||
| </table> | ||
|
|
||
| | 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\* | <pre lang="json">{<br> "gitlabSessionCookieKey": "\_gitlab_session",<br> "gitlabSessionCookieValue": undefined,<br> "gitlabCSRFTokenKey": "authenticity_token",<br> "gitlabCSRFTokenValue": undefined<br> }</pre> | "Native" Auth object. Required (one of the four tokens are required) | <> | | ||
| | `nativeAuth` | No\* | <pre lang="json"><br>{<br> "gitlabSessionCookieKey": "\_gitlab_session",<br> "gitlabSessionCookieValue": undefined,<br> "gitlabCSRFTokenKey": "authenticity_token",<br> "gitlabCSRFTokenValue": undefined<br> }</pre> | "Native" Auth object. Required (one of the four tokens are required) | <> | | ||
| | `nativeAuth` | No\* | <code lang="json">{<br> "gitlabSessionCookieKey": "\_gitlab_session",<br> "gitlabSessionCookieValue": undefined,<br> "gitlabCSRFTokenKey": "authenticity_token",<br> "gitlabCSRFTokenValue": undefined<br> }</pre> | "Native" Auth object. 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 | ||
|
|
||
|
|
||