From 4e94c8fbced3631368cef0f9500043d4765c5aaf Mon Sep 17 00:00:00 2001 From: Kipras Melnikovas Date: Fri, 5 Feb 2021 22:44:25 +0200 Subject: [PATCH] docs: nth attempt with json in markdown html table Signed-off-by: Kipras Melnikovas --- README.md | 53 +++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e985ffdb3..947cf698e 100644 --- a/README.md +++ b/README.md @@ -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) | + + + + + + +
+ +```json +{ + "id": 10, + "username": "alanpartridge", + "email": "alan@alan.com", + "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" +} +``` + +
+ +| 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
 }
| "Native" Auth object. Required (one of the four tokens are required) | <> | +| `nativeAuth` | No\* | 

{
 "gitlabSessionCookieKey": "\_gitlab_session",
 "gitlabSessionCookieValue": undefined,
 "gitlabCSRFTokenKey": "authenticity_token",
 "gitlabCSRFTokenValue": undefined
 }
| "Native" Auth object. Required (one of the four tokens are required) | <> | +| `nativeAuth` | No\* | {
"gitlabSessionCookieKey": "\_gitlab_session",
"gitlabSessionCookieValue": undefined,
"gitlabCSRFTokenKey": "authenticity_token",
"gitlabCSRFTokenValue": undefined
} | "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